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 | |
Matthias Fuchs | e54a67f | 2013-08-07 12:10:38 +0200 | [diff] [blame] | 29 | #if defined(CONFIG_405GP) || \ |
Gerlando Falauto | 34148d6 | 2011-11-18 06:49:11 +0000 | [diff] [blame] | 30 | defined(CONFIG_405EP) || defined(CONFIG_405EZ) || \ |
| 31 | defined(CONFIG_405EX) || defined(CONFIG_440) || \ |
Gerlando Falauto | 34148d6 | 2011-11-18 06:49:11 +0000 | [diff] [blame] | 32 | defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \ |
Heiko Schocher | 6f90e58 | 2017-06-14 05:49:40 +0200 | [diff] [blame] | 33 | defined(CONFIG_MPC86xx) || \ |
Tom Warren | d32b2a4 | 2012-12-11 13:34:17 +0000 | [diff] [blame] | 34 | defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \ |
Michal Simek | f5c5b3f | 2012-07-02 12:38:14 +0200 | [diff] [blame] | 35 | defined(CONFIG_MICROBLAZE) |
wdenk | 96c7a8c | 2005-01-09 22:28:56 +0000 | [diff] [blame] | 36 | extern struct serial_device serial0_device; |
| 37 | extern struct serial_device serial1_device; |
Marek Vasut | 3f08506 | 2012-09-12 20:02:05 +0200 | [diff] [blame] | 38 | #endif |
| 39 | |
Wolfgang Denk | 44df561 | 2006-08-30 23:02:10 +0200 | [diff] [blame] | 40 | extern struct serial_device eserial1_device; |
| 41 | extern struct serial_device eserial2_device; |
Lokesh Vutla | abb44e6 | 2016-05-16 11:47:29 +0530 | [diff] [blame] | 42 | extern struct serial_device eserial3_device; |
| 43 | extern struct serial_device eserial4_device; |
| 44 | extern struct serial_device eserial5_device; |
| 45 | extern struct serial_device eserial6_device; |
wdenk | 96c7a8c | 2005-01-09 22:28:56 +0000 | [diff] [blame] | 46 | |
Mike Frysinger | 53ba322 | 2011-04-29 23:23:28 -0400 | [diff] [blame] | 47 | extern void serial_register(struct serial_device *); |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 48 | extern void serial_initialize(void); |
Jean-Christophe PLAGNIOL-VILLARD | 2a7a031 | 2009-05-16 12:14:54 +0200 | [diff] [blame] | 49 | extern void serial_stdio_init(void); |
Gerlando Falauto | 9299958 | 2011-11-18 06:49:12 +0000 | [diff] [blame] | 50 | extern int serial_assign(const char *name); |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 51 | extern void serial_reinit_all(void); |
| 52 | |
Tom Rix | a36796b | 2009-10-31 12:37:44 -0500 | [diff] [blame] | 53 | /* For usbtty */ |
Tom Rix | 7bea868 | 2009-10-31 12:37:45 -0500 | [diff] [blame] | 54 | #ifdef CONFIG_USB_TTY |
| 55 | |
Tom Rix | a36796b | 2009-10-31 12:37:44 -0500 | [diff] [blame] | 56 | extern int usbtty_getc(void); |
| 57 | extern void usbtty_putc(const char c); |
| 58 | extern void usbtty_puts(const char *str); |
| 59 | extern int usbtty_tstc(void); |
| 60 | |
Tom Rix | 7bea868 | 2009-10-31 12:37:45 -0500 | [diff] [blame] | 61 | #else |
| 62 | |
| 63 | /* stubs */ |
| 64 | #define usbtty_getc() 0 |
| 65 | #define usbtty_putc(a) |
| 66 | #define usbtty_puts(a) |
| 67 | #define usbtty_tstc() 0 |
| 68 | |
| 69 | #endif /* CONFIG_USB_TTY */ |
| 70 | |
Simon Glass | 247f596 | 2014-09-04 16:27:26 -0600 | [diff] [blame] | 71 | struct udevice; |
| 72 | |
| 73 | /** |
| 74 | * struct struct dm_serial_ops - Driver model serial operations |
| 75 | * |
| 76 | * The uclass interface is implemented by all serial devices which use |
| 77 | * driver model. |
| 78 | */ |
| 79 | struct dm_serial_ops { |
| 80 | /** |
| 81 | * setbrg() - Set up the baud rate generator |
| 82 | * |
| 83 | * Adjust baud rate divisors to set up a new baud rate for this |
| 84 | * device. Not all devices will support all rates. If the rate |
| 85 | * cannot be supported, the driver is free to select the nearest |
| 86 | * available rate. or return -EINVAL if this is not possible. |
| 87 | * |
| 88 | * @dev: Device pointer |
| 89 | * @baudrate: New baud rate to use |
| 90 | * @return 0 if OK, -ve on error |
| 91 | */ |
| 92 | int (*setbrg)(struct udevice *dev, int baudrate); |
| 93 | /** |
| 94 | * getc() - Read a character and return it |
| 95 | * |
| 96 | * If no character is available, this should return -EAGAIN without |
| 97 | * waiting. |
| 98 | * |
| 99 | * @dev: Device pointer |
| 100 | * @return character (0..255), -ve on error |
| 101 | */ |
| 102 | int (*getc)(struct udevice *dev); |
| 103 | /** |
| 104 | * putc() - Write a character |
| 105 | * |
| 106 | * @dev: Device pointer |
| 107 | * @ch: character to write |
| 108 | * @return 0 if OK, -ve on error |
| 109 | */ |
| 110 | int (*putc)(struct udevice *dev, const char ch); |
| 111 | /** |
| 112 | * pending() - Check if input/output characters are waiting |
| 113 | * |
| 114 | * This can be used to return an indication of the number of waiting |
| 115 | * characters if the driver knows this (e.g. by looking at the FIFO |
| 116 | * level). It is acceptable to return 1 if an indeterminant number |
| 117 | * of characters is waiting. |
| 118 | * |
| 119 | * This method is optional. |
| 120 | * |
| 121 | * @dev: Device pointer |
| 122 | * @input: true to check input characters, false for output |
| 123 | * @return number of waiting characters, 0 for none, -ve on error |
| 124 | */ |
| 125 | int (*pending)(struct udevice *dev, bool input); |
| 126 | /** |
| 127 | * clear() - Clear the serial FIFOs/holding registers |
| 128 | * |
| 129 | * This method is optional. |
| 130 | * |
| 131 | * This quickly clears any input/output characters from the UART. |
| 132 | * If this is not possible, but characters still exist, then it |
| 133 | * is acceptable to return -EAGAIN (try again) or -EINVAL (not |
| 134 | * supported). |
| 135 | * |
| 136 | * @dev: Device pointer |
| 137 | * @return 0 if OK, -ve on error |
| 138 | */ |
| 139 | int (*clear)(struct udevice *dev); |
| 140 | #if CONFIG_POST & CONFIG_SYS_POST_UART |
| 141 | /** |
| 142 | * loop() - Control serial device loopback mode |
| 143 | * |
| 144 | * @dev: Device pointer |
| 145 | * @on: 1 to turn loopback on, 0 to turn if off |
| 146 | */ |
| 147 | int (*loop)(struct udevice *dev, int on); |
| 148 | #endif |
| 149 | }; |
| 150 | |
| 151 | /** |
| 152 | * struct serial_dev_priv - information about a device used by the uclass |
| 153 | * |
| 154 | * @sdev: stdio device attached to this uart |
| 155 | */ |
| 156 | struct serial_dev_priv { |
| 157 | struct stdio_dev *sdev; |
| 158 | }; |
| 159 | |
| 160 | /* Access the serial operations for a device */ |
| 161 | #define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops) |
| 162 | |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 163 | void amirix_serial_initialize(void); |
| 164 | void arc_serial_initialize(void); |
| 165 | void arm_dcc_initialize(void); |
| 166 | void asc_serial_initialize(void); |
| 167 | void atmel_serial_initialize(void); |
| 168 | void au1x00_serial_initialize(void); |
| 169 | void bfin_jtag_initialize(void); |
| 170 | void bfin_serial_initialize(void); |
| 171 | void bmw_serial_initialize(void); |
| 172 | void clps7111_serial_initialize(void); |
| 173 | void cogent_serial_initialize(void); |
| 174 | void cpci750_serial_initialize(void); |
| 175 | void evb64260_serial_initialize(void); |
| 176 | void imx_serial_initialize(void); |
| 177 | void iop480_serial_initialize(void); |
| 178 | void jz_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 179 | void leon2_serial_initialize(void); |
| 180 | void leon3_serial_initialize(void); |
| 181 | void lh7a40x_serial_initialize(void); |
| 182 | void lpc32xx_serial_initialize(void); |
| 183 | void marvell_serial_initialize(void); |
| 184 | void max3100_serial_initialize(void); |
| 185 | void mcf_serial_initialize(void); |
| 186 | void ml2_serial_initialize(void); |
Jeroen Hofstee | 6512cc1 | 2014-10-27 20:10:07 +0100 | [diff] [blame] | 187 | void mpc85xx_serial_initialize(void); |
| 188 | void mpc8xx_serial_initialize(void); |
| 189 | void mxc_serial_initialize(void); |
| 190 | void mxs_auart_initialize(void); |
| 191 | void ns16550_serial_initialize(void); |
| 192 | void oc_serial_initialize(void); |
| 193 | void p3mx_serial_initialize(void); |
| 194 | void pl01x_serial_initialize(void); |
| 195 | void pxa_serial_initialize(void); |
| 196 | void s3c24xx_serial_initialize(void); |
| 197 | void s5p_serial_initialize(void); |
| 198 | void sa1100_serial_initialize(void); |
| 199 | void sandbox_serial_initialize(void); |
| 200 | void sconsole_serial_initialize(void); |
| 201 | void sh_serial_initialize(void); |
| 202 | void uartlite_serial_initialize(void); |
| 203 | void zynq_serial_initialize(void); |
| 204 | |
wdenk | 7ac1610 | 2004-08-01 22:48:16 +0000 | [diff] [blame] | 205 | #endif |