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_smh_device;
  27 extern struct serial_device serial_scc_device;
  28 extern struct serial_device *default_serial_console(void);
  29
  30 #if     defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
  31         defined(CONFIG_MPC86xx) || \
  32         defined(CONFIG_ARCH_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
  33         defined(CONFIG_MICROBLAZE)
  34 extern struct serial_device serial0_device;
  35 extern struct serial_device serial1_device;
  36 #endif
  37
  38 extern struct serial_device eserial1_device;
  39 extern struct serial_device eserial2_device;
  40 extern struct serial_device eserial3_device;
  41 extern struct serial_device eserial4_device;
  42 extern struct serial_device eserial5_device;
  43 extern struct serial_device eserial6_device;
  44
  45 extern void serial_register(struct serial_device *);
  46 extern void serial_stdio_init(void);
  47 extern int serial_assign(const char *name);
  48 extern void serial_reinit_all(void);
  49 int serial_initialize(void);
  50
  51 /* For usbtty */
  52 #ifdef CONFIG_USB_TTY
  53
  54 struct stdio_dev;
  55
  56 int usbtty_getc(struct stdio_dev *dev);
  57 void usbtty_putc(struct stdio_dev *dev, const char c);
  58 void usbtty_puts(struct stdio_dev *dev, const char *str);
  59 int usbtty_tstc(struct stdio_dev *dev);
  60
  61 #else
  62
  63 /* stubs */
  64 #define usbtty_getc(dev) 0
  65 #define usbtty_putc(dev, a)
  66 #define usbtty_puts(dev, a)
  67 #define usbtty_tstc(dev) 0
  68
  69 #endif /* CONFIG_USB_TTY */
  70
  71 struct udevice;
  72
  73 enum serial_par {
  74         SERIAL_PAR_NONE,
  75         SERIAL_PAR_ODD,
  76         SERIAL_PAR_EVEN
  77 };
  78
  79 #define SERIAL_PAR_SHIFT        0
  80 #define SERIAL_PAR_MASK         (0x03 << SERIAL_PAR_SHIFT)
  81 #define SERIAL_SET_PARITY(parity) \
  82         ((parity << SERIAL_PAR_SHIFT) & SERIAL_PAR_MASK)
  83 #define SERIAL_GET_PARITY(config) \
  84         ((config & SERIAL_PAR_MASK) >> SERIAL_PAR_SHIFT)
  85
  86 enum serial_bits {
  87         SERIAL_5_BITS,
  88         SERIAL_6_BITS,
  89         SERIAL_7_BITS,
  90         SERIAL_8_BITS
  91 };
  92
  93 #define SERIAL_BITS_SHIFT       2
  94 #define SERIAL_BITS_MASK        (0x3 << SERIAL_BITS_SHIFT)
  95 #define SERIAL_SET_BITS(bits) \
  96         ((bits << SERIAL_BITS_SHIFT) & SERIAL_BITS_MASK)
  97 #define SERIAL_GET_BITS(config) \
  98         ((config & SERIAL_BITS_MASK) >> SERIAL_BITS_SHIFT)
  99
 100 enum serial_stop {
 101         SERIAL_HALF_STOP,       /* 0.5 stop bit */
 102         SERIAL_ONE_STOP,        /*   1 stop bit */
 103         SERIAL_ONE_HALF_STOP,   /* 1.5 stop bit */
 104         SERIAL_TWO_STOP         /*   2 stop bit */
 105 };
 106
 107 #define SERIAL_STOP_SHIFT       4
 108 #define SERIAL_STOP_MASK        (0x3 << SERIAL_STOP_SHIFT)
 109 #define SERIAL_SET_STOP(stop) \
 110         ((stop << SERIAL_STOP_SHIFT) & SERIAL_STOP_MASK)
 111 #define SERIAL_GET_STOP(config) \
 112         ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT)
 113
 114 #define SERIAL_CONFIG(par, bits, stop) \
 115                      (par << SERIAL_PAR_SHIFT | \
 116                       bits << SERIAL_BITS_SHIFT | \
 117                       stop << SERIAL_STOP_SHIFT)
 118
 119 #define SERIAL_DEFAULT_CONFIG \
 120                         (SERIAL_PAR_NONE << SERIAL_PAR_SHIFT | \
 121                          SERIAL_8_BITS << SERIAL_BITS_SHIFT | \
 122                          SERIAL_ONE_STOP << SERIAL_STOP_SHIFT)
 123
 124 enum serial_chip_type {
 125         SERIAL_CHIP_UNKNOWN = -1,
 126         SERIAL_CHIP_16550_COMPATIBLE,
 127 };
 128
 129 enum adr_space_type {
 130         SERIAL_ADDRESS_SPACE_MEMORY = 0,
 131         SERIAL_ADDRESS_SPACE_IO,
 132 };
 133
 134 /**
 135  * struct serial_device_info - structure to hold serial device info
 136  *
 137  * @type:       type of the UART chip
 138  * @addr_space: address space to access the registers
 139  * @addr:       physical address of the registers
 140  * @reg_width:  size (in bytes) of the IO accesses to the registers
 141  * @reg_offset: offset to apply to the @addr from the start of the registers
 142  * @reg_shift:  quantity to shift the register offsets by
 143  * @clock:      UART base clock speed in Hz
 144  * @baudrate:   baud rate
 145  */
 146 struct serial_device_info {
 147         enum serial_chip_type type;
 148         enum adr_space_type addr_space;
 149         ulong addr;
 150         u8 reg_width;
 151         u8 reg_offset;
 152         u8 reg_shift;
 153         unsigned int clock;
 154         unsigned int baudrate;
 155 };
 156
 157 #define SERIAL_DEFAULT_ADDRESS  0xBADACCE5
 158 #define SERIAL_DEFAULT_CLOCK    (16 * 115200)
 159
 160 /**
 161  * struct struct dm_serial_ops - Driver model serial operations
 162  *
 163  * The uclass interface is implemented by all serial devices which use
 164  * driver model.
 165  */
 166 struct dm_serial_ops {
 167         /**
 168          * setbrg() - Set up the baud rate generator
 169          *
 170          * Adjust baud rate divisors to set up a new baud rate for this
 171          * device. Not all devices will support all rates. If the rate
 172          * cannot be supported, the driver is free to select the nearest
 173          * available rate. or return -EINVAL if this is not possible.
 174          *
 175          * @dev: Device pointer
 176          * @baudrate: New baud rate to use
 177          * @return 0 if OK, -ve on error
 178          */
 179         int (*setbrg)(struct udevice *dev, int baudrate);
 180         /**
 181          * getc() - Read a character and return it
 182          *
 183          * If no character is available, this should return -EAGAIN without
 184          * waiting.
 185          *
 186          * @dev: Device pointer
 187          * @return character (0..255), -ve on error
 188          */
 189         int (*getc)(struct udevice *dev);
 190         /**
 191          * putc() - Write a character
 192          *
 193          * @dev: Device pointer
 194          * @ch: character to write
 195          * @return 0 if OK, -ve on error
 196          */
 197         int (*putc)(struct udevice *dev, const char ch);
 198         /**
 199          * puts() - Write a string
 200          *
 201          * This writes a string. This function should be implemented only if
 202          * writing multiple characters at once is more performant than just
 203          * calling putc() in a loop.
 204          *
 205          * If the whole string cannot be written at once, then this function
 206          * should return the number of characters written. Returning a negative
 207          * error code implies that no characters were written. If this function
 208          * returns 0, then it will be called again with the same arguments.
 209          *
 210          * @dev: Device pointer
 211          * @s: The string to write
 212          * @len: The length of the string to write.
 213          * @return The number of characters written on success, or -ve on error
 214          */
 215         ssize_t (*puts)(struct udevice *dev, const char *s, size_t len);
 216         /**
 217          * pending() - Check if input/output characters are waiting
 218          *
 219          * This can be used to return an indication of the number of waiting
 220          * characters if the driver knows this (e.g. by looking at the FIFO
 221          * level). It is acceptable to return 1 if an indeterminant number
 222          * of characters is waiting.
 223          *
 224          * This method is optional.
 225          *
 226          * @dev: Device pointer
 227          * @input: true to check input characters, false for output
 228          * @return number of waiting characters, 0 for none, -ve on error
 229          */
 230         int (*pending)(struct udevice *dev, bool input);
 231         /**
 232          * clear() - Clear the serial FIFOs/holding registers
 233          *
 234          * This method is optional.
 235          *
 236          * This quickly clears any input/output characters from the UART.
 237          * If this is not possible, but characters still exist, then it
 238          * is acceptable to return -EAGAIN (try again) or -EINVAL (not
 239          * supported).
 240          *
 241          * @dev: Device pointer
 242          * @return 0 if OK, -ve on error
 243          */
 244         int (*clear)(struct udevice *dev);
 245 #if CONFIG_POST & CONFIG_SYS_POST_UART
 246         /**
 247          * loop() - Control serial device loopback mode
 248          *
 249          * @dev: Device pointer
 250          * @on: 1 to turn loopback on, 0 to turn if off
 251          */
 252         int (*loop)(struct udevice *dev, int on);
 253 #endif
 254
 255         /**
 256          * getconfig() - Get the uart configuration
 257          * (parity, 5/6/7/8 bits word length, stop bits)
 258          *
 259          * Get a current config for this device.
 260          *
 261          * @dev: Device pointer
 262          * @serial_config: Returns config information (see SERIAL_... above)
 263          * @return 0 if OK, -ve on error
 264          */
 265         int (*getconfig)(struct udevice *dev, uint *serial_config);
 266         /**
 267          * setconfig() - Set up the uart configuration
 268          * (parity, 5/6/7/8 bits word length, stop bits)
 269          *
 270          * Set up a new config for this device.
 271          *
 272          * @dev: Device pointer
 273          * @serial_config: number of bits, parity and number of stopbits to use
 274          * @return 0 if OK, -ve on error
 275          */
 276         int (*setconfig)(struct udevice *dev, uint serial_config);
 277         /**
 278          * getinfo() - Get serial device information
 279          *
 280          * @dev: Device pointer
 281          * @info: struct serial_device_info to fill
 282          * @return 0 if OK, -ve on error
 283          */
 284         int (*getinfo)(struct udevice *dev, struct serial_device_info *info);
 285 };
 286
 287 /**
 288  * struct serial_dev_priv - information about a device used by the uclass
 289  *
 290  * @sdev:       stdio device attached to this uart
 291  *
 292  * @buf:        Pointer to the RX buffer
 293  * @rd_ptr:     Read pointer in the RX buffer
 294  * @wr_ptr:     Write pointer in the RX buffer
 295  */
 296 struct serial_dev_priv {
 297         struct stdio_dev *sdev;
 298
 299         char *buf;
 300         int rd_ptr;
 301         int wr_ptr;
 302 };
 303
 304 /* Access the serial operations for a device */
 305 #define serial_get_ops(dev)     ((struct dm_serial_ops *)(dev)->driver->ops)
 306
 307 /**
 308  * serial_getconfig() - Get the uart configuration
 309  * (parity, 5/6/7/8 bits word length, stop bits)
 310  *
 311  * Get a current config for this device.
 312  *
 313  * @dev: Device pointer
 314  * @serial_config: Returns config information (see SERIAL_... above)
 315  * Return: 0 if OK, -ve on error
 316  */
 317 int serial_getconfig(struct udevice *dev, uint *config);
 318
 319 /**
 320  * serial_setconfig() - Set up the uart configuration
 321  * (parity, 5/6/7/8 bits word length, stop bits)
 322  *
 323  * Set up a new config for this device.
 324  *
 325  * @dev: Device pointer
 326  * @serial_config: number of bits, parity and number of stopbits to use
 327  * Return: 0 if OK, -ve on error
 328  */
 329 int serial_setconfig(struct udevice *dev, uint config);
 330
 331 /**
 332  * serial_getinfo() - Get serial device information
 333  *
 334  * @dev: Device pointer
 335  * @info: struct serial_device_info to fill
 336  * Return: 0 if OK, -ve on error
 337  */
 338 int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
 339
 340 void atmel_serial_initialize(void);
 341 void mcf_serial_initialize(void);
 342 void mpc85xx_serial_initialize(void);
 343 void mxc_serial_initialize(void);
 344 void ns16550_serial_initialize(void);
 345 void pl01x_serial_initialize(void);
 346 void pxa_serial_initialize(void);
 347 void sh_serial_initialize(void);
 348
 349 /**
 350  * serial_printf() - Write a formatted string to the serial console
 351  *
 352  * The total size of the output must be less than CONFIG_SYS_PBSIZE.
 353  *
 354  * @fmt: Printf format string, followed by format arguments
 355  * Return: number of characters written
 356  */
 357 int serial_printf(const char *fmt, ...)
 358                 __attribute__ ((format (__printf__, 1, 2)));
 359
 360 int serial_init(void);
 361 void serial_setbrg(void);
 362 void serial_putc(const char ch);
 363 void serial_putc_raw(const char ch);
 364 void serial_puts(const char *str);
 365 int serial_getc(void);
 366 int serial_tstc(void);
 367
 368 #endif