serial.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  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_405GP) || \
  24. defined(CONFIG_405EP) || defined(CONFIG_405EZ) || \
  25. defined(CONFIG_405EX) || defined(CONFIG_440) || \
  26. defined(CONFIG_MB86R0x) || defined(CONFIG_MPC5xxx) || \
  27. defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
  28. defined(CONFIG_MPC86xx) || defined(CONFIG_SYS_SC520) || \
  29. defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
  30. defined(CONFIG_MICROBLAZE)
  31. extern struct serial_device serial0_device;
  32. extern struct serial_device serial1_device;
  33. #endif
  34. extern struct serial_device eserial1_device;
  35. extern struct serial_device eserial2_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. #if defined(CONFIG_MPC512X)
  55. extern struct stdio_dev *open_port(int num, int baudrate);
  56. extern int close_port(int num);
  57. extern int write_port(struct stdio_dev *port, char *buf);
  58. extern int read_port(struct stdio_dev *port, char *buf, int size);
  59. #endif
  60. struct udevice;
  61. /**
  62. * struct struct dm_serial_ops - Driver model serial operations
  63. *
  64. * The uclass interface is implemented by all serial devices which use
  65. * driver model.
  66. */
  67. struct dm_serial_ops {
  68. /**
  69. * setbrg() - Set up the baud rate generator
  70. *
  71. * Adjust baud rate divisors to set up a new baud rate for this
  72. * device. Not all devices will support all rates. If the rate
  73. * cannot be supported, the driver is free to select the nearest
  74. * available rate. or return -EINVAL if this is not possible.
  75. *
  76. * @dev: Device pointer
  77. * @baudrate: New baud rate to use
  78. * @return 0 if OK, -ve on error
  79. */
  80. int (*setbrg)(struct udevice *dev, int baudrate);
  81. /**
  82. * getc() - Read a character and return it
  83. *
  84. * If no character is available, this should return -EAGAIN without
  85. * waiting.
  86. *
  87. * @dev: Device pointer
  88. * @return character (0..255), -ve on error
  89. */
  90. int (*getc)(struct udevice *dev);
  91. /**
  92. * putc() - Write a character
  93. *
  94. * @dev: Device pointer
  95. * @ch: character to write
  96. * @return 0 if OK, -ve on error
  97. */
  98. int (*putc)(struct udevice *dev, const char ch);
  99. /**
  100. * pending() - Check if input/output characters are waiting
  101. *
  102. * This can be used to return an indication of the number of waiting
  103. * characters if the driver knows this (e.g. by looking at the FIFO
  104. * level). It is acceptable to return 1 if an indeterminant number
  105. * of characters is waiting.
  106. *
  107. * This method is optional.
  108. *
  109. * @dev: Device pointer
  110. * @input: true to check input characters, false for output
  111. * @return number of waiting characters, 0 for none, -ve on error
  112. */
  113. int (*pending)(struct udevice *dev, bool input);
  114. /**
  115. * clear() - Clear the serial FIFOs/holding registers
  116. *
  117. * This method is optional.
  118. *
  119. * This quickly clears any input/output characters from the UART.
  120. * If this is not possible, but characters still exist, then it
  121. * is acceptable to return -EAGAIN (try again) or -EINVAL (not
  122. * supported).
  123. *
  124. * @dev: Device pointer
  125. * @return 0 if OK, -ve on error
  126. */
  127. int (*clear)(struct udevice *dev);
  128. #if CONFIG_POST & CONFIG_SYS_POST_UART
  129. /**
  130. * loop() - Control serial device loopback mode
  131. *
  132. * @dev: Device pointer
  133. * @on: 1 to turn loopback on, 0 to turn if off
  134. */
  135. int (*loop)(struct udevice *dev, int on);
  136. #endif
  137. };
  138. /**
  139. * struct serial_dev_priv - information about a device used by the uclass
  140. *
  141. * @sdev: stdio device attached to this uart
  142. */
  143. struct serial_dev_priv {
  144. struct stdio_dev *sdev;
  145. };
  146. /* Access the serial operations for a device */
  147. #define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
  148. #endif