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