serial.h 8.6 KB

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