xref: /openbmc/u-boot/include/serial.h (revision c978b524)
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_405GP) || \
30 	defined(CONFIG_405EP) || defined(CONFIG_405EZ) || \
31 	defined(CONFIG_405EX) || defined(CONFIG_440) || \
32 	defined(CONFIG_MPC5xxx) || \
33 	defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
34 	defined(CONFIG_MPC86xx) || defined(CONFIG_SYS_SC520) || \
35 	defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
36 	defined(CONFIG_MICROBLAZE)
37 extern struct serial_device serial0_device;
38 extern struct serial_device serial1_device;
39 #endif
40 
41 extern struct serial_device eserial1_device;
42 extern struct serial_device eserial2_device;
43 extern struct serial_device eserial3_device;
44 extern struct serial_device eserial4_device;
45 extern struct serial_device eserial5_device;
46 extern struct serial_device eserial6_device;
47 
48 extern void serial_register(struct serial_device *);
49 extern void serial_initialize(void);
50 extern void serial_stdio_init(void);
51 extern int serial_assign(const char *name);
52 extern void serial_reinit_all(void);
53 
54 /* For usbtty */
55 #ifdef CONFIG_USB_TTY
56 
57 extern int usbtty_getc(void);
58 extern void usbtty_putc(const char c);
59 extern void usbtty_puts(const char *str);
60 extern int usbtty_tstc(void);
61 
62 #else
63 
64 /* stubs */
65 #define usbtty_getc() 0
66 #define usbtty_putc(a)
67 #define usbtty_puts(a)
68 #define usbtty_tstc() 0
69 
70 #endif /* CONFIG_USB_TTY */
71 
72 #if defined(CONFIG_MPC512X)
73 extern struct stdio_dev *open_port(int num, int baudrate);
74 extern int close_port(int num);
75 extern int write_port(struct stdio_dev *port, char *buf);
76 extern int read_port(struct stdio_dev *port, char *buf, int size);
77 #endif
78 
79 struct udevice;
80 
81 /**
82  * struct struct dm_serial_ops - Driver model serial operations
83  *
84  * The uclass interface is implemented by all serial devices which use
85  * driver model.
86  */
87 struct dm_serial_ops {
88 	/**
89 	 * setbrg() - Set up the baud rate generator
90 	 *
91 	 * Adjust baud rate divisors to set up a new baud rate for this
92 	 * device. Not all devices will support all rates. If the rate
93 	 * cannot be supported, the driver is free to select the nearest
94 	 * available rate. or return -EINVAL if this is not possible.
95 	 *
96 	 * @dev: Device pointer
97 	 * @baudrate: New baud rate to use
98 	 * @return 0 if OK, -ve on error
99 	 */
100 	int (*setbrg)(struct udevice *dev, int baudrate);
101 	/**
102 	 * getc() - Read a character and return it
103 	 *
104 	 * If no character is available, this should return -EAGAIN without
105 	 * waiting.
106 	 *
107 	 * @dev: Device pointer
108 	 * @return character (0..255), -ve on error
109 	 */
110 	int (*getc)(struct udevice *dev);
111 	/**
112 	 * putc() - Write a character
113 	 *
114 	 * @dev: Device pointer
115 	 * @ch: character to write
116 	 * @return 0 if OK, -ve on error
117 	 */
118 	int (*putc)(struct udevice *dev, const char ch);
119 	/**
120 	 * pending() - Check if input/output characters are waiting
121 	 *
122 	 * This can be used to return an indication of the number of waiting
123 	 * characters if the driver knows this (e.g. by looking at the FIFO
124 	 * level). It is acceptable to return 1 if an indeterminant number
125 	 * of characters is waiting.
126 	 *
127 	 * This method is optional.
128 	 *
129 	 * @dev: Device pointer
130 	 * @input: true to check input characters, false for output
131 	 * @return number of waiting characters, 0 for none, -ve on error
132 	 */
133 	int (*pending)(struct udevice *dev, bool input);
134 	/**
135 	 * clear() - Clear the serial FIFOs/holding registers
136 	 *
137 	 * This method is optional.
138 	 *
139 	 * This quickly clears any input/output characters from the UART.
140 	 * If this is not possible, but characters still exist, then it
141 	 * is acceptable to return -EAGAIN (try again) or -EINVAL (not
142 	 * supported).
143 	 *
144 	 * @dev: Device pointer
145 	 * @return 0 if OK, -ve on error
146 	 */
147 	int (*clear)(struct udevice *dev);
148 #if CONFIG_POST & CONFIG_SYS_POST_UART
149 	/**
150 	 * loop() - Control serial device loopback mode
151 	 *
152 	 * @dev: Device pointer
153 	 * @on: 1 to turn loopback on, 0 to turn if off
154 	 */
155 	int (*loop)(struct udevice *dev, int on);
156 #endif
157 };
158 
159 /**
160  * struct serial_dev_priv - information about a device used by the uclass
161  *
162  * @sdev: stdio device attached to this uart
163  */
164 struct serial_dev_priv {
165 	struct stdio_dev *sdev;
166 };
167 
168 /* Access the serial operations for a device */
169 #define serial_get_ops(dev)	((struct dm_serial_ops *)(dev)->driver->ops)
170 
171 void amirix_serial_initialize(void);
172 void arc_serial_initialize(void);
173 void arm_dcc_initialize(void);
174 void asc_serial_initialize(void);
175 void atmel_serial_initialize(void);
176 void au1x00_serial_initialize(void);
177 void bfin_jtag_initialize(void);
178 void bfin_serial_initialize(void);
179 void bmw_serial_initialize(void);
180 void clps7111_serial_initialize(void);
181 void cogent_serial_initialize(void);
182 void cpci750_serial_initialize(void);
183 void evb64260_serial_initialize(void);
184 void imx_serial_initialize(void);
185 void iop480_serial_initialize(void);
186 void jz_serial_initialize(void);
187 void leon2_serial_initialize(void);
188 void leon3_serial_initialize(void);
189 void lh7a40x_serial_initialize(void);
190 void lpc32xx_serial_initialize(void);
191 void marvell_serial_initialize(void);
192 void max3100_serial_initialize(void);
193 void mcf_serial_initialize(void);
194 void ml2_serial_initialize(void);
195 void mpc512x_serial_initialize(void);
196 void mpc5xx_serial_initialize(void);
197 void mpc8260_scc_serial_initialize(void);
198 void mpc8260_smc_serial_initialize(void);
199 void mpc85xx_serial_initialize(void);
200 void mpc8xx_serial_initialize(void);
201 void mxc_serial_initialize(void);
202 void mxs_auart_initialize(void);
203 void ns16550_serial_initialize(void);
204 void oc_serial_initialize(void);
205 void p3mx_serial_initialize(void);
206 void pl01x_serial_initialize(void);
207 void pxa_serial_initialize(void);
208 void s3c24xx_serial_initialize(void);
209 void s5p_serial_initialize(void);
210 void sa1100_serial_initialize(void);
211 void sandbox_serial_initialize(void);
212 void sconsole_serial_initialize(void);
213 void sh_serial_initialize(void);
214 void uartlite_serial_initialize(void);
215 void zynq_serial_initialize(void);
216 
217 #endif
218