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