include/serial.h

   1 #ifndef __SERIAL_H__
   2 #define __SERIAL_H__
   3
   4 #include <post.h>
   5
   6 struct serial_device {
   7         /* enough bytes to match alignment of following func pointer */
   8         char    name[16];
   9
  10         int     (*start)(void);
  11         int     (*stop)(void);
  12         void    (*setbrg)(void);
  13         int     (*getc)(void);
  14         int     (*tstc)(void);
  15         void    (*putc)(const char c);
  16         void    (*puts)(const char *s);
  17 #if CONFIG_POST & CONFIG_SYS_POST_UART
  18         void    (*loop)(int);
  19 #endif
  20         struct serial_device    *next;
  21 };
  22
  23 void default_serial_puts(const char *s);
  24
  25 extern struct serial_device serial_smc_device;
  26 extern struct serial_device serial_scc_device;
  27 extern struct serial_device *default_serial_console(void);
  28
  29 #if     defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
  30         defined(CONFIG_MPC86xx) || \
  31         defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
  32         defined(CONFIG_MICROBLAZE)
  33 extern struct serial_device serial0_device;
  34 extern struct serial_device serial1_device;
  35 #endif
  36
  37 extern struct serial_device eserial1_device;
  38 extern struct serial_device eserial2_device;
  39 extern struct serial_device eserial3_device;
  40 extern struct serial_device eserial4_device;
  41 extern struct serial_device eserial5_device;
  42 extern struct serial_device eserial6_device;
  43
  44 extern void serial_register(struct serial_device *);
  45 extern void serial_initialize(void);
  46 extern void serial_stdio_init(void);
  47 extern int serial_assign(const char *name);
  48 extern void serial_reinit_all(void);
  49
  50 /* For usbtty */
  51 #ifdef CONFIG_USB_TTY
  52
  53 extern int usbtty_getc(void);
  54 extern void usbtty_putc(const char c);
  55 extern void usbtty_puts(const char *str);
  56 extern int usbtty_tstc(void);
  57
  58 #else
  59
  60 /* stubs */
  61 #define usbtty_getc() 0
  62 #define usbtty_putc(a)
  63 #define usbtty_puts(a)
  64 #define usbtty_tstc() 0
  65
  66 #endif /* CONFIG_USB_TTY */
  67
  68 struct udevice;
  69
  70 /**
  71  * struct struct dm_serial_ops - Driver model serial operations
  72  *
  73  * The uclass interface is implemented by all serial devices which use
  74  * driver model.
  75  */
  76 struct dm_serial_ops {
  77         /**
  78          * setbrg() - Set up the baud rate generator
  79          *
  80          * Adjust baud rate divisors to set up a new baud rate for this
  81          * device. Not all devices will support all rates. If the rate
  82          * cannot be supported, the driver is free to select the nearest
  83          * available rate. or return -EINVAL if this is not possible.
  84          *
  85          * @dev: Device pointer
  86          * @baudrate: New baud rate to use
  87          * @return 0 if OK, -ve on error
  88          */
  89         int (*setbrg)(struct udevice *dev, int baudrate);
  90         /**
  91          * getc() - Read a character and return it
  92          *
  93          * If no character is available, this should return -EAGAIN without
  94          * waiting.
  95          *
  96          * @dev: Device pointer
  97          * @return character (0..255), -ve on error
  98          */
  99         int (*getc)(struct udevice *dev);
 100         /**
 101          * putc() - Write a character
 102          *
 103          * @dev: Device pointer
 104          * @ch: character to write
 105          * @return 0 if OK, -ve on error
 106          */
 107         int (*putc)(struct udevice *dev, const char ch);
 108         /**
 109          * pending() - Check if input/output characters are waiting
 110          *
 111          * This can be used to return an indication of the number of waiting
 112          * characters if the driver knows this (e.g. by looking at the FIFO
 113          * level). It is acceptable to return 1 if an indeterminant number
 114          * of characters is waiting.
 115          *
 116          * This method is optional.
 117          *
 118          * @dev: Device pointer
 119          * @input: true to check input characters, false for output
 120          * @return number of waiting characters, 0 for none, -ve on error
 121          */
 122         int (*pending)(struct udevice *dev, bool input);
 123         /**
 124          * clear() - Clear the serial FIFOs/holding registers
 125          *
 126          * This method is optional.
 127          *
 128          * This quickly clears any input/output characters from the UART.
 129          * If this is not possible, but characters still exist, then it
 130          * is acceptable to return -EAGAIN (try again) or -EINVAL (not
 131          * supported).
 132          *
 133          * @dev: Device pointer
 134          * @return 0 if OK, -ve on error
 135          */
 136         int (*clear)(struct udevice *dev);
 137 #if CONFIG_POST & CONFIG_SYS_POST_UART
 138         /**
 139          * loop() - Control serial device loopback mode
 140          *
 141          * @dev: Device pointer
 142          * @on: 1 to turn loopback on, 0 to turn if off
 143          */
 144         int (*loop)(struct udevice *dev, int on);
 145 #endif
 146 };
 147
 148 /**
 149  * struct serial_dev_priv - information about a device used by the uclass
 150  *
 151  * @sdev:       stdio device attached to this uart
 152  *
 153  * @buf:        Pointer to the RX buffer
 154  * @rd_ptr:     Read pointer in the RX buffer
 155  * @wr_ptr:     Write pointer in the RX buffer
 156  */
 157 struct serial_dev_priv {
 158         struct stdio_dev *sdev;
 159
 160         char *buf;
 161         int rd_ptr;
 162         int wr_ptr;
 163 };
 164
 165 /* Access the serial operations for a device */
 166 #define serial_get_ops(dev)     ((struct dm_serial_ops *)(dev)->driver->ops)
 167
 168 void atmel_serial_initialize(void);
 169 void au1x00_serial_initialize(void);
 170 void mcf_serial_initialize(void);
 171 void mpc85xx_serial_initialize(void);
 172 void mpc8xx_serial_initialize(void);
 173 void mxc_serial_initialize(void);
 174 void ns16550_serial_initialize(void);
 175 void pl01x_serial_initialize(void);
 176 void pxa_serial_initialize(void);
 177 void sh_serial_initialize(void);
 178
 179 #endif