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 /** 77 * struct struct dm_serial_ops - Driver model serial operations 78 * 79 * The uclass interface is implemented by all serial devices which use 80 * driver model. 81 */ 82 struct dm_serial_ops { 83 /** 84 * setbrg() - Set up the baud rate generator 85 * 86 * Adjust baud rate divisors to set up a new baud rate for this 87 * device. Not all devices will support all rates. If the rate 88 * cannot be supported, the driver is free to select the nearest 89 * available rate. or return -EINVAL if this is not possible. 90 * 91 * @dev: Device pointer 92 * @baudrate: New baud rate to use 93 * @return 0 if OK, -ve on error 94 */ 95 int (*setbrg)(struct udevice *dev, int baudrate); 96 /** 97 * getc() - Read a character and return it 98 * 99 * If no character is available, this should return -EAGAIN without 100 * waiting. 101 * 102 * @dev: Device pointer 103 * @return character (0..255), -ve on error 104 */ 105 int (*getc)(struct udevice *dev); 106 /** 107 * putc() - Write a character 108 * 109 * @dev: Device pointer 110 * @ch: character to write 111 * @return 0 if OK, -ve on error 112 */ 113 int (*putc)(struct udevice *dev, const char ch); 114 /** 115 * pending() - Check if input/output characters are waiting 116 * 117 * This can be used to return an indication of the number of waiting 118 * characters if the driver knows this (e.g. by looking at the FIFO 119 * level). It is acceptable to return 1 if an indeterminant number 120 * of characters is waiting. 121 * 122 * This method is optional. 123 * 124 * @dev: Device pointer 125 * @input: true to check input characters, false for output 126 * @return number of waiting characters, 0 for none, -ve on error 127 */ 128 int (*pending)(struct udevice *dev, bool input); 129 /** 130 * clear() - Clear the serial FIFOs/holding registers 131 * 132 * This method is optional. 133 * 134 * This quickly clears any input/output characters from the UART. 135 * If this is not possible, but characters still exist, then it 136 * is acceptable to return -EAGAIN (try again) or -EINVAL (not 137 * supported). 138 * 139 * @dev: Device pointer 140 * @return 0 if OK, -ve on error 141 */ 142 int (*clear)(struct udevice *dev); 143 #if CONFIG_POST & CONFIG_SYS_POST_UART 144 /** 145 * loop() - Control serial device loopback mode 146 * 147 * @dev: Device pointer 148 * @on: 1 to turn loopback on, 0 to turn if off 149 */ 150 int (*loop)(struct udevice *dev, int on); 151 #endif 152 /** 153 * setparity() - Set up the parity 154 * 155 * Set up a new parity for this device. 156 * 157 * @dev: Device pointer 158 * @parity: parity to use 159 * @return 0 if OK, -ve on error 160 */ 161 int (*setparity)(struct udevice *dev, enum serial_par parity); 162 }; 163 164 /** 165 * struct serial_dev_priv - information about a device used by the uclass 166 * 167 * @sdev: stdio device attached to this uart 168 * 169 * @buf: Pointer to the RX buffer 170 * @rd_ptr: Read pointer in the RX buffer 171 * @wr_ptr: Write pointer in the RX buffer 172 */ 173 struct serial_dev_priv { 174 struct stdio_dev *sdev; 175 176 char *buf; 177 int rd_ptr; 178 int wr_ptr; 179 }; 180 181 /* Access the serial operations for a device */ 182 #define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops) 183 184 void atmel_serial_initialize(void); 185 void mcf_serial_initialize(void); 186 void mpc85xx_serial_initialize(void); 187 void mpc8xx_serial_initialize(void); 188 void mxc_serial_initialize(void); 189 void ns16550_serial_initialize(void); 190 void pl01x_serial_initialize(void); 191 void pxa_serial_initialize(void); 192 void sh_serial_initialize(void); 193 194 #endif 195