blob: c590637b1f3bade45cea412b1076a848f78f0ad9 [file] [log] [blame]
wdenk281e00a2004-08-01 22:48:16 +00001#ifndef __SERIAL_H__
2#define __SERIAL_H__
3
Mike Frysinger7b826c22011-05-14 06:56:15 +00004#include <post.h>
5
wdenk281e00a2004-08-01 22:48:16 +00006struct serial_device {
Mike Frysingerf6add132011-11-10 14:11:04 +00007 /* enough bytes to match alignment of following func pointer */
Marek Vasut78322d62012-09-07 14:32:10 +02008 char name[16];
wdenk281e00a2004-08-01 22:48:16 +00009
Marek Vasut89143fb2012-09-07 14:35:31 +020010 int (*start)(void);
11 int (*stop)(void);
Marek Vasut78322d62012-09-07 14:32:10 +020012 void (*setbrg)(void);
13 int (*getc)(void);
14 int (*tstc)(void);
15 void (*putc)(const char c);
16 void (*puts)(const char *s);
Mike Frysinger7b826c22011-05-14 06:56:15 +000017#if CONFIG_POST & CONFIG_SYS_POST_UART
Marek Vasut78322d62012-09-07 14:32:10 +020018 void (*loop)(int);
Mike Frysinger7b826c22011-05-14 06:56:15 +000019#endif
Marek Vasut78322d62012-09-07 14:32:10 +020020 struct serial_device *next;
wdenk281e00a2004-08-01 22:48:16 +000021};
22
Marek Vasutbfb7d7a2012-10-06 14:07:01 +000023void default_serial_puts(const char *s);
24
wdenk281e00a2004-08-01 22:48:16 +000025extern struct serial_device serial_smc_device;
26extern struct serial_device serial_scc_device;
Gerlando Falautoa6e6f7f2011-11-18 06:49:11 +000027extern struct serial_device *default_serial_console(void);
wdenk281e00a2004-08-01 22:48:16 +000028
Heiko Schocher98f705c2017-06-27 16:49:14 +020029#if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
Heiko Schocher064b55c2017-06-14 05:49:40 +020030 defined(CONFIG_MPC86xx) || \
Trevor Woerner18138ab2020-05-06 08:02:41 -040031 defined(CONFIG_ARCH_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
Michal Simek7636ebe2012-07-02 12:38:14 +020032 defined(CONFIG_MICROBLAZE)
wdenkff36fd82005-01-09 22:28:56 +000033extern struct serial_device serial0_device;
34extern struct serial_device serial1_device;
Marek Vasutabc0ed82012-09-12 20:02:05 +020035#endif
36
Wolfgang Denk0fd30252006-08-30 23:02:10 +020037extern struct serial_device eserial1_device;
38extern struct serial_device eserial2_device;
Lokesh Vutla3d163892016-05-16 11:47:29 +053039extern struct serial_device eserial3_device;
40extern struct serial_device eserial4_device;
41extern struct serial_device eserial5_device;
42extern struct serial_device eserial6_device;
wdenkff36fd82005-01-09 22:28:56 +000043
Mike Frysinger635f3302011-04-29 23:23:28 -040044extern void serial_register(struct serial_device *);
wdenk281e00a2004-08-01 22:48:16 +000045extern void serial_initialize(void);
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +020046extern void serial_stdio_init(void);
Gerlando Falauto7813ca92011-11-18 06:49:12 +000047extern int serial_assign(const char *name);
wdenk281e00a2004-08-01 22:48:16 +000048extern void serial_reinit_all(void);
49
Tom Rix62994872009-10-31 12:37:44 -050050/* For usbtty */
Tom Rix2ec1abe2009-10-31 12:37:45 -050051#ifdef CONFIG_USB_TTY
52
Simon Glass2310c8e2019-11-14 12:57:22 -070053struct stdio_dev;
54
55int usbtty_getc(struct stdio_dev *dev);
56void usbtty_putc(struct stdio_dev *dev, const char c);
57void usbtty_puts(struct stdio_dev *dev, const char *str);
58int usbtty_tstc(struct stdio_dev *dev);
Tom Rix62994872009-10-31 12:37:44 -050059
Tom Rix2ec1abe2009-10-31 12:37:45 -050060#else
61
62/* stubs */
Simon Glass2310c8e2019-11-14 12:57:22 -070063#define usbtty_getc(dev) 0
64#define usbtty_putc(dev, a)
65#define usbtty_puts(dev, a)
66#define usbtty_tstc(dev) 0
Tom Rix2ec1abe2009-10-31 12:37:45 -050067
68#endif /* CONFIG_USB_TTY */
69
Simon Glass57d92752014-09-04 16:27:26 -060070struct udevice;
71
Patrick Delaunayeae47642018-05-17 14:50:44 +020072enum serial_par {
73 SERIAL_PAR_NONE,
74 SERIAL_PAR_ODD,
75 SERIAL_PAR_EVEN
76};
77
Patrice Chotardcbf53882018-08-03 15:07:38 +020078#define SERIAL_PAR_SHIFT 0
79#define SERIAL_PAR_MASK (0x03 << SERIAL_PAR_SHIFT)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +020080#define SERIAL_SET_PARITY(parity) \
81 ((parity << SERIAL_PAR_SHIFT) & SERIAL_PAR_MASK)
Patrice Chotardcbf53882018-08-03 15:07:38 +020082#define SERIAL_GET_PARITY(config) \
83 ((config & SERIAL_PAR_MASK) >> SERIAL_PAR_SHIFT)
84
85enum serial_bits {
86 SERIAL_5_BITS,
87 SERIAL_6_BITS,
88 SERIAL_7_BITS,
89 SERIAL_8_BITS
90};
91
92#define SERIAL_BITS_SHIFT 2
93#define SERIAL_BITS_MASK (0x3 << SERIAL_BITS_SHIFT)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +020094#define SERIAL_SET_BITS(bits) \
95 ((bits << SERIAL_BITS_SHIFT) & SERIAL_BITS_MASK)
Patrice Chotardcbf53882018-08-03 15:07:38 +020096#define SERIAL_GET_BITS(config) \
97 ((config & SERIAL_BITS_MASK) >> SERIAL_BITS_SHIFT)
98
99enum serial_stop {
100 SERIAL_HALF_STOP, /* 0.5 stop bit */
101 SERIAL_ONE_STOP, /* 1 stop bit */
102 SERIAL_ONE_HALF_STOP, /* 1.5 stop bit */
103 SERIAL_TWO_STOP /* 2 stop bit */
104};
105
106#define SERIAL_STOP_SHIFT 4
107#define SERIAL_STOP_MASK (0x3 << SERIAL_STOP_SHIFT)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200108#define SERIAL_SET_STOP(stop) \
109 ((stop << SERIAL_STOP_SHIFT) & SERIAL_STOP_MASK)
Patrice Chotardcbf53882018-08-03 15:07:38 +0200110#define SERIAL_GET_STOP(config) \
111 ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT)
112
Patrice Chotardd7c09682018-08-03 15:07:41 +0200113#define SERIAL_CONFIG(par, bits, stop) \
114 (par << SERIAL_PAR_SHIFT | \
115 bits << SERIAL_BITS_SHIFT | \
116 stop << SERIAL_STOP_SHIFT)
117
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200118#define SERIAL_DEFAULT_CONFIG \
119 (SERIAL_PAR_NONE << SERIAL_PAR_SHIFT | \
120 SERIAL_8_BITS << SERIAL_BITS_SHIFT | \
121 SERIAL_ONE_STOP << SERIAL_STOP_SHIFT)
Patrice Chotardcbf53882018-08-03 15:07:38 +0200122
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200123enum serial_chip_type {
124 SERIAL_CHIP_UNKNOWN = -1,
125 SERIAL_CHIP_16550_COMPATIBLE,
126};
127
128enum adr_space_type {
129 SERIAL_ADDRESS_SPACE_MEMORY = 0,
130 SERIAL_ADDRESS_SPACE_IO,
131};
132
133/**
134 * struct serial_device_info - structure to hold serial device info
135 *
136 * @type: type of the UART chip
137 * @addr_space: address space to access the registers
138 * @addr: physical address of the registers
139 * @reg_width: size (in bytes) of the IO accesses to the registers
140 * @reg_offset: offset to apply to the @addr from the start of the registers
141 * @reg_shift: quantity to shift the register offsets by
Andy Shevchenkobf4661bc2020-02-27 17:21:54 +0200142 * @clock: UART base clock speed in Hz
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200143 * @baudrate: baud rate
144 */
145struct serial_device_info {
146 enum serial_chip_type type;
147 enum adr_space_type addr_space;
148 ulong addr;
149 u8 reg_width;
150 u8 reg_offset;
151 u8 reg_shift;
Andy Shevchenkobf4661bc2020-02-27 17:21:54 +0200152 unsigned int clock;
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200153 unsigned int baudrate;
154};
155
156#define SERIAL_DEFAULT_ADDRESS 0xBADACCE5
Andy Shevchenkobf4661bc2020-02-27 17:21:54 +0200157#define SERIAL_DEFAULT_CLOCK (16 * 115200)
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200158
Simon Glass57d92752014-09-04 16:27:26 -0600159/**
160 * struct struct dm_serial_ops - Driver model serial operations
161 *
162 * The uclass interface is implemented by all serial devices which use
163 * driver model.
164 */
165struct dm_serial_ops {
166 /**
167 * setbrg() - Set up the baud rate generator
168 *
169 * Adjust baud rate divisors to set up a new baud rate for this
170 * device. Not all devices will support all rates. If the rate
171 * cannot be supported, the driver is free to select the nearest
172 * available rate. or return -EINVAL if this is not possible.
173 *
174 * @dev: Device pointer
175 * @baudrate: New baud rate to use
176 * @return 0 if OK, -ve on error
177 */
178 int (*setbrg)(struct udevice *dev, int baudrate);
179 /**
180 * getc() - Read a character and return it
181 *
182 * If no character is available, this should return -EAGAIN without
183 * waiting.
184 *
185 * @dev: Device pointer
186 * @return character (0..255), -ve on error
187 */
188 int (*getc)(struct udevice *dev);
189 /**
190 * putc() - Write a character
191 *
192 * @dev: Device pointer
193 * @ch: character to write
194 * @return 0 if OK, -ve on error
195 */
196 int (*putc)(struct udevice *dev, const char ch);
197 /**
198 * pending() - Check if input/output characters are waiting
199 *
200 * This can be used to return an indication of the number of waiting
201 * characters if the driver knows this (e.g. by looking at the FIFO
202 * level). It is acceptable to return 1 if an indeterminant number
203 * of characters is waiting.
204 *
205 * This method is optional.
206 *
207 * @dev: Device pointer
208 * @input: true to check input characters, false for output
209 * @return number of waiting characters, 0 for none, -ve on error
210 */
211 int (*pending)(struct udevice *dev, bool input);
212 /**
213 * clear() - Clear the serial FIFOs/holding registers
214 *
215 * This method is optional.
216 *
217 * This quickly clears any input/output characters from the UART.
218 * If this is not possible, but characters still exist, then it
219 * is acceptable to return -EAGAIN (try again) or -EINVAL (not
220 * supported).
221 *
222 * @dev: Device pointer
223 * @return 0 if OK, -ve on error
224 */
225 int (*clear)(struct udevice *dev);
226#if CONFIG_POST & CONFIG_SYS_POST_UART
227 /**
228 * loop() - Control serial device loopback mode
229 *
230 * @dev: Device pointer
231 * @on: 1 to turn loopback on, 0 to turn if off
232 */
233 int (*loop)(struct udevice *dev, int on);
234#endif
Patrice Chotardcbf53882018-08-03 15:07:38 +0200235
236 /**
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200237 * getconfig() - Get the uart configuration
238 * (parity, 5/6/7/8 bits word length, stop bits)
239 *
240 * Get a current config for this device.
241 *
242 * @dev: Device pointer
Simon Glasseab647d2018-12-28 14:23:11 -0700243 * @serial_config: Returns config information (see SERIAL_... above)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200244 * @return 0 if OK, -ve on error
245 */
246 int (*getconfig)(struct udevice *dev, uint *serial_config);
247 /**
Patrice Chotardcbf53882018-08-03 15:07:38 +0200248 * setconfig() - Set up the uart configuration
249 * (parity, 5/6/7/8 bits word length, stop bits)
250 *
251 * Set up a new config for this device.
252 *
253 * @dev: Device pointer
Simon Goldschmidt0a168682018-11-02 21:08:16 +0100254 * @serial_config: number of bits, parity and number of stopbits to use
Patrice Chotardcbf53882018-08-03 15:07:38 +0200255 * @return 0 if OK, -ve on error
256 */
257 int (*setconfig)(struct udevice *dev, uint serial_config);
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200258 /**
259 * getinfo() - Get serial device information
260 *
261 * @dev: Device pointer
262 * @info: struct serial_device_info to fill
Simon Glasseab647d2018-12-28 14:23:11 -0700263 * @return 0 if OK, -ve on error
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200264 */
265 int (*getinfo)(struct udevice *dev, struct serial_device_info *info);
Simon Glass57d92752014-09-04 16:27:26 -0600266};
267
268/**
269 * struct serial_dev_priv - information about a device used by the uclass
270 *
Stefan Roese3ca7a062017-08-16 17:37:16 +0200271 * @sdev: stdio device attached to this uart
272 *
273 * @buf: Pointer to the RX buffer
274 * @rd_ptr: Read pointer in the RX buffer
275 * @wr_ptr: Write pointer in the RX buffer
Simon Glass57d92752014-09-04 16:27:26 -0600276 */
277struct serial_dev_priv {
278 struct stdio_dev *sdev;
Stefan Roese3ca7a062017-08-16 17:37:16 +0200279
280 char *buf;
281 int rd_ptr;
282 int wr_ptr;
Simon Glass57d92752014-09-04 16:27:26 -0600283};
284
285/* Access the serial operations for a device */
286#define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
287
Simon Glasseab647d2018-12-28 14:23:11 -0700288/**
289 * serial_getconfig() - Get the uart configuration
290 * (parity, 5/6/7/8 bits word length, stop bits)
291 *
292 * Get a current config for this device.
293 *
294 * @dev: Device pointer
295 * @serial_config: Returns config information (see SERIAL_... above)
296 * @return 0 if OK, -ve on error
297 */
Simon Glass67d1b052018-12-28 14:23:08 -0700298int serial_getconfig(struct udevice *dev, uint *config);
Simon Glasseab647d2018-12-28 14:23:11 -0700299
300/**
301 * serial_setconfig() - Set up the uart configuration
302 * (parity, 5/6/7/8 bits word length, stop bits)
303 *
304 * Set up a new config for this device.
305 *
306 * @dev: Device pointer
307 * @serial_config: number of bits, parity and number of stopbits to use
308 * @return 0 if OK, -ve on error
309 */
Simon Glass3de04e72018-12-28 14:23:09 -0700310int serial_setconfig(struct udevice *dev, uint config);
Simon Glasseab647d2018-12-28 14:23:11 -0700311
312/**
313 * serial_getinfo() - Get serial device information
314 *
315 * @dev: Device pointer
316 * @info: struct serial_device_info to fill
317 * @return 0 if OK, -ve on error
318 */
Simon Glassa61cbad2018-12-28 14:23:10 -0700319int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
Simon Glass0171f432018-12-28 14:23:07 -0700320
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100321void atmel_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100322void mcf_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100323void mpc85xx_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100324void mxc_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100325void ns16550_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100326void pl01x_serial_initialize(void);
327void pxa_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100328void sh_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100329
Simon Glassf516fd92019-11-14 12:57:23 -0700330/**
331 * serial_printf() - Write a formatted string to the serial console
332 *
333 * The total size of the output must be less than CONFIG_SYS_PBSIZE.
334 *
335 * @fmt: Printf format string, followed by format arguments
336 * @return number of characters written
337 */
338int serial_printf(const char *fmt, ...)
339 __attribute__ ((format (__printf__, 1, 2)));
340
Simon Glassb03e0512019-11-14 12:57:24 -0700341int serial_init(void);
342void serial_setbrg(void);
343void serial_putc(const char ch);
344void serial_putc_raw(const char ch);
345void serial_puts(const char *str);
346int serial_getc(void);
347int serial_tstc(void);
348
wdenk281e00a2004-08-01 22:48:16 +0000349#endif