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