serial.h 4.7 KB

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