wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 1 | #ifndef __SERIAL_H__ |
| 2 | #define __SERIAL_H__ |
| 3 | |
Mike Frysinger | 078f2f1 | 2011-05-14 06:56:15 +0000 | [diff] [blame] | 4 | #include <post.h> |
| 5 | |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 6 | struct serial_device { |
Mike Frysinger | 6b300dc | 2011-11-10 14:11:04 +0000 | [diff] [blame] | 7 | /* enough bytes to match alignment of following func pointer */ |
Marek Vasut | 80919de | 2012-09-07 14:32:10 +0200 | [diff] [blame] | 8 | char name[16]; |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 9 | |
Marek Vasut | b46931d | 2012-09-07 14:35:31 +0200 | [diff] [blame] | 10 | int (*start)(void); |
| 11 | int (*stop)(void); |
Marek Vasut | 80919de | 2012-09-07 14:32:10 +0200 | [diff] [blame] | 12 | void (*setbrg)(void); |
| 13 | int (*getc)(void); |
| 14 | int (*tstc)(void); |
| 15 | void (*putc)(const char c); |
| 16 | void (*puts)(const char *s); |
Mike Frysinger | 078f2f1 | 2011-05-14 06:56:15 +0000 | [diff] [blame] | 17 | #if CONFIG_POST & CONFIG_SYS_POST_UART |
Marek Vasut | 80919de | 2012-09-07 14:32:10 +0200 | [diff] [blame] | 18 | void (*loop)(int); |
Mike Frysinger | 078f2f1 | 2011-05-14 06:56:15 +0000 | [diff] [blame] | 19 | #endif |
Marek Vasut | 80919de | 2012-09-07 14:32:10 +0200 | [diff] [blame] | 20 | struct serial_device *next; |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 21 | }; |
| 22 | |
Marek Vasut | 6b9124e | 2012-10-06 14:07:01 +0000 | [diff] [blame] | 23 | void default_serial_puts(const char *s); |
| 24 | |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 25 | extern struct serial_device serial_smc_device; |
| 26 | extern struct serial_device serial_scc_device; |
Gerlando Falauto | 34148d6 | 2011-11-18 06:49:11 +0000 | [diff] [blame] | 27 | extern struct serial_device *default_serial_console(void); |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 28 | |
Heiko Schocher | 2028012 | 2017-06-27 16:49:14 +0200 | [diff] [blame] | 29 | #if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \ |
Heiko Schocher | 6f90e58 | 2017-06-14 05:49:40 +0200 | [diff] [blame] | 30 | defined(CONFIG_MPC86xx) || \ |
Tom Warren | d32b2a4 | 2012-12-11 13:34:17 +0000 | [diff] [blame] | 31 | defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \ |
Michal Simek | f5c5b3f | 2012-07-02 12:38:14 +0200 | [diff] [blame] | 32 | defined(CONFIG_MICROBLAZE) |
wdenk | 96c7a8c | 2005-01-09 22:28:56 +0000 | [diff] [blame] | 33 | extern struct serial_device serial0_device; |
| 34 | extern struct serial_device serial1_device; |
Marek Vasut | 3f08506 | 2012-09-12 20:02:05 +0200 | [diff] [blame] | 35 | #endif |
| 36 | |
Wolfgang Denk | 44df561 | 2006-08-30 23:02:10 +0200 | [diff] [blame] | 37 | extern struct serial_device eserial1_device; |
| 38 | extern struct serial_device eserial2_device; |
Lokesh Vutla | abb44e6 | 2016-05-16 11:47:29 +0530 | [diff] [blame] | 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; |
wdenk | 96c7a8c | 2005-01-09 22:28:56 +0000 | [diff] [blame] | 43 | |
Mike Frysinger | 53ba322 | 2011-04-29 23:23:28 -0400 | [diff] [blame] | 44 | extern void serial_register(struct serial_device *); |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 45 | extern void serial_initialize(void); |
Jean-Christophe PLAGNIOL-VILLARD | 2a7a031 | 2009-05-16 12:14:54 +0200 | [diff] [blame] | 46 | extern void serial_stdio_init(void); |
Gerlando Falauto | 9299958 | 2011-11-18 06:49:12 +0000 | [diff] [blame] | 47 | extern int serial_assign(const char *name); |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 48 | extern void serial_reinit_all(void); |
| 49 | |
Tom Rix | a36796b | 2009-10-31 12:37:44 -0500 | [diff] [blame] | 50 | /* For usbtty */ |
Tom Rix | 7bea868 | 2009-10-31 12:37:45 -0500 | [diff] [blame] | 51 | #ifdef CONFIG_USB_TTY |
| 52 | |
Tom Rix | a36796b | 2009-10-31 12:37:44 -0500 | [diff] [blame] | 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 | |
Tom Rix | 7bea868 | 2009-10-31 12:37:45 -0500 | [diff] [blame] | 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 | |
Simon Glass | 247f596 | 2014-09-04 16:27:26 -0600 | [diff] [blame] | 68 | struct udevice; |
| 69 | |
Patrick Delaunay | 830e35e | 2018-05-17 14:50:44 +0200 | [diff] [blame] | 70 | enum serial_par { |
| 71 | SERIAL_PAR_NONE, |
| 72 | SERIAL_PAR_ODD, |
| 73 | SERIAL_PAR_EVEN |
| 74 | }; |
| 75 | |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 76 | #define SERIAL_PAR_SHIFT 0 |
| 77 | #define SERIAL_PAR_MASK (0x03 << SERIAL_PAR_SHIFT) |
Andy Shevchenko | 08e9879 | 2018-11-20 23:52:32 +0200 | [diff] [blame] | 78 | #define SERIAL_SET_PARITY(parity) \ |
| 79 | ((parity << SERIAL_PAR_SHIFT) & SERIAL_PAR_MASK) |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 80 | #define SERIAL_GET_PARITY(config) \ |
| 81 | ((config & SERIAL_PAR_MASK) >> SERIAL_PAR_SHIFT) |
| 82 | |
| 83 | enum serial_bits { |
| 84 | SERIAL_5_BITS, |
| 85 | SERIAL_6_BITS, |
| 86 | SERIAL_7_BITS, |
| 87 | SERIAL_8_BITS |
| 88 | }; |
| 89 | |
| 90 | #define SERIAL_BITS_SHIFT 2 |
| 91 | #define SERIAL_BITS_MASK (0x3 << SERIAL_BITS_SHIFT) |
Andy Shevchenko | 08e9879 | 2018-11-20 23:52:32 +0200 | [diff] [blame] | 92 | #define SERIAL_SET_BITS(bits) \ |
| 93 | ((bits << SERIAL_BITS_SHIFT) & SERIAL_BITS_MASK) |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 94 | #define SERIAL_GET_BITS(config) \ |
| 95 | ((config & SERIAL_BITS_MASK) >> SERIAL_BITS_SHIFT) |
| 96 | |
| 97 | enum serial_stop { |
| 98 | SERIAL_HALF_STOP, /* 0.5 stop bit */ |
| 99 | SERIAL_ONE_STOP, /* 1 stop bit */ |
| 100 | SERIAL_ONE_HALF_STOP, /* 1.5 stop bit */ |
| 101 | SERIAL_TWO_STOP /* 2 stop bit */ |
| 102 | }; |
| 103 | |
| 104 | #define SERIAL_STOP_SHIFT 4 |
| 105 | #define SERIAL_STOP_MASK (0x3 << SERIAL_STOP_SHIFT) |
Andy Shevchenko | 08e9879 | 2018-11-20 23:52:32 +0200 | [diff] [blame] | 106 | #define SERIAL_SET_STOP(stop) \ |
| 107 | ((stop << SERIAL_STOP_SHIFT) & SERIAL_STOP_MASK) |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 108 | #define SERIAL_GET_STOP(config) \ |
| 109 | ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT) |
| 110 | |
Patrice Chotard | 70ed0ea | 2018-08-03 15:07:41 +0200 | [diff] [blame] | 111 | #define SERIAL_CONFIG(par, bits, stop) \ |
| 112 | (par << SERIAL_PAR_SHIFT | \ |
| 113 | bits << SERIAL_BITS_SHIFT | \ |
| 114 | stop << SERIAL_STOP_SHIFT) |
| 115 | |
Andy Shevchenko | 08e9879 | 2018-11-20 23:52:32 +0200 | [diff] [blame] | 116 | #define SERIAL_DEFAULT_CONFIG \ |
| 117 | (SERIAL_PAR_NONE << SERIAL_PAR_SHIFT | \ |
| 118 | SERIAL_8_BITS << SERIAL_BITS_SHIFT | \ |
| 119 | SERIAL_ONE_STOP << SERIAL_STOP_SHIFT) |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 120 | |
Andy Shevchenko | 44f21da | 2018-11-20 23:52:33 +0200 | [diff] [blame] | 121 | enum serial_chip_type { |
| 122 | SERIAL_CHIP_UNKNOWN = -1, |
| 123 | SERIAL_CHIP_16550_COMPATIBLE, |
| 124 | }; |
| 125 | |
| 126 | enum adr_space_type { |
| 127 | SERIAL_ADDRESS_SPACE_MEMORY = 0, |
| 128 | SERIAL_ADDRESS_SPACE_IO, |
| 129 | }; |
| 130 | |
| 131 | /** |
| 132 | * struct serial_device_info - structure to hold serial device info |
| 133 | * |
| 134 | * @type: type of the UART chip |
| 135 | * @addr_space: address space to access the registers |
| 136 | * @addr: physical address of the registers |
| 137 | * @reg_width: size (in bytes) of the IO accesses to the registers |
| 138 | * @reg_offset: offset to apply to the @addr from the start of the registers |
| 139 | * @reg_shift: quantity to shift the register offsets by |
| 140 | * @baudrate: baud rate |
| 141 | */ |
| 142 | struct serial_device_info { |
| 143 | enum serial_chip_type type; |
| 144 | enum adr_space_type addr_space; |
| 145 | ulong addr; |
| 146 | u8 reg_width; |
| 147 | u8 reg_offset; |
| 148 | u8 reg_shift; |
| 149 | unsigned int baudrate; |
| 150 | }; |
| 151 | |
| 152 | #define SERIAL_DEFAULT_ADDRESS 0xBADACCE5 |
| 153 | |
Simon Glass | 247f596 | 2014-09-04 16:27:26 -0600 | [diff] [blame] | 154 | /** |
| 155 | * struct struct dm_serial_ops - Driver model serial operations |
| 156 | * |
| 157 | * The uclass interface is implemented by all serial devices which use |
| 158 | * driver model. |
| 159 | */ |
| 160 | struct dm_serial_ops { |
| 161 | /** |
| 162 | * setbrg() - Set up the baud rate generator |
| 163 | * |
| 164 | * Adjust baud rate divisors to set up a new baud rate for this |
| 165 | * device. Not all devices will support all rates. If the rate |
| 166 | * cannot be supported, the driver is free to select the nearest |
| 167 | * available rate. or return -EINVAL if this is not possible. |
| 168 | * |
| 169 | * @dev: Device pointer |
| 170 | * @baudrate: New baud rate to use |
| 171 | * @return 0 if OK, -ve on error |
| 172 | */ |
| 173 | int (*setbrg)(struct udevice *dev, int baudrate); |
| 174 | /** |
| 175 | * getc() - Read a character and return it |
| 176 | * |
| 177 | * If no character is available, this should return -EAGAIN without |
| 178 | * waiting. |
| 179 | * |
| 180 | * @dev: Device pointer |
| 181 | * @return character (0..255), -ve on error |
| 182 | */ |
| 183 | int (*getc)(struct udevice *dev); |
| 184 | /** |
| 185 | * putc() - Write a character |
| 186 | * |
| 187 | * @dev: Device pointer |
| 188 | * @ch: character to write |
| 189 | * @return 0 if OK, -ve on error |
| 190 | */ |
| 191 | int (*putc)(struct udevice *dev, const char ch); |
| 192 | /** |
| 193 | * pending() - Check if input/output characters are waiting |
| 194 | * |
| 195 | * This can be used to return an indication of the number of waiting |
| 196 | * characters if the driver knows this (e.g. by looking at the FIFO |
| 197 | * level). It is acceptable to return 1 if an indeterminant number |
| 198 | * of characters is waiting. |
| 199 | * |
| 200 | * This method is optional. |
| 201 | * |
| 202 | * @dev: Device pointer |
| 203 | * @input: true to check input characters, false for output |
| 204 | * @return number of waiting characters, 0 for none, -ve on error |
| 205 | */ |
| 206 | int (*pending)(struct udevice *dev, bool input); |
| 207 | /** |
| 208 | * clear() - Clear the serial FIFOs/holding registers |
| 209 | * |
| 210 | * This method is optional. |
| 211 | * |
| 212 | * This quickly clears any input/output characters from the UART. |
| 213 | * If this is not possible, but characters still exist, then it |
| 214 | * is acceptable to return -EAGAIN (try again) or -EINVAL (not |
| 215 | * supported). |
| 216 | * |
| 217 | * @dev: Device pointer |
| 218 | * @return 0 if OK, -ve on error |
| 219 | */ |
| 220 | int (*clear)(struct udevice *dev); |
| 221 | #if CONFIG_POST & CONFIG_SYS_POST_UART |
| 222 | /** |
| 223 | * loop() - Control serial device loopback mode |
| 224 | * |
| 225 | * @dev: Device pointer |
| 226 | * @on: 1 to turn loopback on, 0 to turn if off |
| 227 | */ |
| 228 | int (*loop)(struct udevice *dev, int on); |
| 229 | #endif |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 230 | |
| 231 | /** |
Andy Shevchenko | 08e9879 | 2018-11-20 23:52:32 +0200 | [diff] [blame] | 232 | * getconfig() - Get the uart configuration |
| 233 | * (parity, 5/6/7/8 bits word length, stop bits) |
| 234 | * |
| 235 | * Get a current config for this device. |
| 236 | * |
| 237 | * @dev: Device pointer |
| 238 | * @parity: parity to use |
| 239 | * @bits: bits number to use |
| 240 | * @stop: stop bits number to use |
| 241 | * @return 0 if OK, -ve on error |
| 242 | */ |
| 243 | int (*getconfig)(struct udevice *dev, uint *serial_config); |
| 244 | /** |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 245 | * setconfig() - Set up the uart configuration |
| 246 | * (parity, 5/6/7/8 bits word length, stop bits) |
| 247 | * |
| 248 | * Set up a new config for this device. |
| 249 | * |
| 250 | * @dev: Device pointer |
Simon Goldschmidt | 6b981d0 | 2018-11-02 21:08:16 +0100 | [diff] [blame] | 251 | * @serial_config: number of bits, parity and number of stopbits to use |
Patrice Chotard | 46c1d9f | 2018-08-03 15:07:38 +0200 | [diff] [blame] | 252 | * @return 0 if OK, -ve on error |
| 253 | */ |
| 254 | int (*setconfig)(struct udevice *dev, uint serial_config); |
Andy Shevchenko | 44f21da | 2018-11-20 23:52:33 +0200 | [diff] [blame] | 255 | /** |
| 256 | * getinfo() - Get serial device information |
| 257 | * |
| 258 | * @dev: Device pointer |
| 259 | * @info: struct serial_device_info to fill |
| 260 | */ |
| 261 | int (*getinfo)(struct udevice *dev, struct serial_device_info *info); |
Simon Glass | 247f596 | 2014-09-04 16:27:26 -0600 | [diff] [blame] | 262 | }; |
| 263 | |
| 264 | /** |
| 265 | * struct serial_dev_priv - information about a device used by the uclass |
| 266 | * |
Stefan Roese | 0207283 | 2017-08-16 17:37:16 +0200 | [diff] [blame] | 267 | * @sdev: stdio device attached to this uart |
| 268 | * |
| 269 | * @buf: Pointer to the RX buffer |
| 270 | * @rd_ptr: Read pointer in the RX buffer |
| 271 | * @wr_ptr: Write pointer in the RX buffer |
Simon Glass | 247f596 | 2014-09-04 16:27:26 -0600 | [diff] [blame] | 272 | */ |
| 273 | struct serial_dev_priv { |
| 274 | struct stdio_dev *sdev; |
Stefan Roese | 0207283 | 2017-08-16 17:37:16 +0200 | [diff] [blame] | 275 | |
| 276 | char *buf; |
| 277 | int rd_ptr; |
| 278 | int wr_ptr; |
Simon Glass | 247f596 | 2014-09-04 16:27:26 -0600 | [diff] [blame] | 279 | }; |
| 280 | |
| 281 | /* Access the serial operations for a device */ |
| 282 | #define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops) |
| 283 | |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 284 | void atmel_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 285 | void mcf_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 286 | void mpc85xx_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 287 | void mxc_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 288 | void ns16550_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 289 | void pl01x_serial_initialize(void); |
| 290 | void pxa_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 291 | void sh_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 292 | |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 293 | #endif |