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 enum serial_par {
  71         SERIAL_PAR_NONE,
  72         SERIAL_PAR_ODD,
  73         SERIAL_PAR_EVEN
  74 };
  75
  76 #define SERIAL_PAR_SHIFT        0
  77 #define SERIAL_PAR_MASK         (0x03 << SERIAL_PAR_SHIFT)
  78 #define SERIAL_GET_PARITY(config) \
  79         ((config & SERIAL_PAR_MASK) >> SERIAL_PAR_SHIFT)
  80
  81 enum serial_bits {
  82         SERIAL_5_BITS,
  83         SERIAL_6_BITS,
  84         SERIAL_7_BITS,
  85         SERIAL_8_BITS
  86 };
  87
  88 #define SERIAL_BITS_SHIFT       2
  89 #define SERIAL_BITS_MASK        (0x3 << SERIAL_BITS_SHIFT)
  90 #define SERIAL_GET_BITS(config) \
  91         ((config & SERIAL_BITS_MASK) >> SERIAL_BITS_SHIFT)
  92
  93 enum serial_stop {
  94         SERIAL_HALF_STOP,       /* 0.5 stop bit */
  95         SERIAL_ONE_STOP,        /*   1 stop bit */
  96         SERIAL_ONE_HALF_STOP,   /* 1.5 stop bit */
  97         SERIAL_TWO_STOP         /*   2 stop bit */
  98 };
  99
 100 #define SERIAL_STOP_SHIFT       4
 101 #define SERIAL_STOP_MASK        (0x3 << SERIAL_STOP_SHIFT)
 102 #define SERIAL_GET_STOP(config) \
 103         ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT)
 104
 105 #define SERIAL_DEFAULT_CONFIG   SERIAL_PAR_NONE << SERIAL_PAR_SHIFT | \
 106                                 SERIAL_8_BITS << SERIAL_BITS_SHIFT | \
 107                                 SERIAL_ONE_STOP << SERIAL_STOP_SHIFT
 108
 109 /**
 110  * struct struct dm_serial_ops - Driver model serial operations
 111  *
 112  * The uclass interface is implemented by all serial devices which use
 113  * driver model.
 114  */
 115 struct dm_serial_ops {
 116         /**
 117          * setbrg() - Set up the baud rate generator
 118          *
 119          * Adjust baud rate divisors to set up a new baud rate for this
 120          * device. Not all devices will support all rates. If the rate
 121          * cannot be supported, the driver is free to select the nearest
 122          * available rate. or return -EINVAL if this is not possible.
 123          *
 124          * @dev: Device pointer
 125          * @baudrate: New baud rate to use
 126          * @return 0 if OK, -ve on error
 127          */
 128         int (*setbrg)(struct udevice *dev, int baudrate);
 129         /**
 130          * getc() - Read a character and return it
 131          *
 132          * If no character is available, this should return -EAGAIN without
 133          * waiting.
 134          *
 135          * @dev: Device pointer
 136          * @return character (0..255), -ve on error
 137          */
 138         int (*getc)(struct udevice *dev);
 139         /**
 140          * putc() - Write a character
 141          *
 142          * @dev: Device pointer
 143          * @ch: character to write
 144          * @return 0 if OK, -ve on error
 145          */
 146         int (*putc)(struct udevice *dev, const char ch);
 147         /**
 148          * pending() - Check if input/output characters are waiting
 149          *
 150          * This can be used to return an indication of the number of waiting
 151          * characters if the driver knows this (e.g. by looking at the FIFO
 152          * level). It is acceptable to return 1 if an indeterminant number
 153          * of characters is waiting.
 154          *
 155          * This method is optional.
 156          *
 157          * @dev: Device pointer
 158          * @input: true to check input characters, false for output
 159          * @return number of waiting characters, 0 for none, -ve on error
 160          */
 161         int (*pending)(struct udevice *dev, bool input);
 162         /**
 163          * clear() - Clear the serial FIFOs/holding registers
 164          *
 165          * This method is optional.
 166          *
 167          * This quickly clears any input/output characters from the UART.
 168          * If this is not possible, but characters still exist, then it
 169          * is acceptable to return -EAGAIN (try again) or -EINVAL (not
 170          * supported).
 171          *
 172          * @dev: Device pointer
 173          * @return 0 if OK, -ve on error
 174          */
 175         int (*clear)(struct udevice *dev);
 176 #if CONFIG_POST & CONFIG_SYS_POST_UART
 177         /**
 178          * loop() - Control serial device loopback mode
 179          *
 180          * @dev: Device pointer
 181          * @on: 1 to turn loopback on, 0 to turn if off
 182          */
 183         int (*loop)(struct udevice *dev, int on);
 184 #endif
 185
 186         /**
 187          * setconfig() - Set up the uart configuration
 188          * (parity, 5/6/7/8 bits word length, stop bits)
 189          *
 190          * Set up a new config for this device.
 191          *
 192          * @dev: Device pointer
 193          * @parity: parity to use
 194          * @bits: bits number to use
 195          * @stop: stop bits number to use
 196          * @return 0 if OK, -ve on error
 197          */
 198         int (*setconfig)(struct udevice *dev, uint serial_config);
 199 };
 200
 201 /**
 202  * struct serial_dev_priv - information about a device used by the uclass
 203  *
 204  * @sdev:       stdio device attached to this uart
 205  *
 206  * @buf:        Pointer to the RX buffer
 207  * @rd_ptr:     Read pointer in the RX buffer
 208  * @wr_ptr:     Write pointer in the RX buffer
 209  */
 210 struct serial_dev_priv {
 211         struct stdio_dev *sdev;
 212
 213         char *buf;
 214         int rd_ptr;
 215         int wr_ptr;
 216 };
 217
 218 /* Access the serial operations for a device */
 219 #define serial_get_ops(dev)     ((struct dm_serial_ops *)(dev)->driver->ops)
 220
 221 void atmel_serial_initialize(void);
 222 void mcf_serial_initialize(void);
 223 void mpc85xx_serial_initialize(void);
 224 void mpc8xx_serial_initialize(void);
 225 void mxc_serial_initialize(void);
 226 void ns16550_serial_initialize(void);
 227 void pl01x_serial_initialize(void);
 228 void pxa_serial_initialize(void);
 229 void sh_serial_initialize(void);
 230
 231 #endif