serial.h 9.2 KB

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