blob: 42bdf3759c00b523c3a7a50fd3f3ecf56e6ea3a9 [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);
Tom Rini1e019502022-12-04 10:14:17 -050017#if CFG_POST & CFG_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;
Sean Anderson74d11d32022-03-22 16:59:24 -040026extern struct serial_device serial_smh_device;
wdenk281e00a2004-08-01 22:48:16 +000027extern struct serial_device serial_scc_device;
Gerlando Falautoa6e6f7f2011-11-18 06:49:11 +000028extern struct serial_device *default_serial_console(void);
wdenk281e00a2004-08-01 22:48:16 +000029
Heiko Schocher98f705c2017-06-27 16:49:14 +020030#if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
Heiko Schocher064b55c2017-06-14 05:49:40 +020031 defined(CONFIG_MPC86xx) || \
Trevor Woerner18138ab2020-05-06 08:02:41 -040032 defined(CONFIG_ARCH_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
Michal Simek7636ebe2012-07-02 12:38:14 +020033 defined(CONFIG_MICROBLAZE)
wdenkff36fd82005-01-09 22:28:56 +000034extern struct serial_device serial0_device;
35extern struct serial_device serial1_device;
Marek Vasutabc0ed82012-09-12 20:02:05 +020036#endif
37
Wolfgang Denk0fd30252006-08-30 23:02:10 +020038extern struct serial_device eserial1_device;
39extern struct serial_device eserial2_device;
Lokesh Vutla3d163892016-05-16 11:47:29 +053040extern struct serial_device eserial3_device;
41extern struct serial_device eserial4_device;
42extern struct serial_device eserial5_device;
43extern struct serial_device eserial6_device;
wdenkff36fd82005-01-09 22:28:56 +000044
Mike Frysinger635f3302011-04-29 23:23:28 -040045extern void serial_register(struct serial_device *);
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);
Ovidiu Panait39a19222020-07-24 14:12:22 +030049int serial_initialize(void);
wdenk281e00a2004-08-01 22:48:16 +000050
Tom Rix62994872009-10-31 12:37:44 -050051/* For usbtty */
Tom Rix2ec1abe2009-10-31 12:37:45 -050052#ifdef CONFIG_USB_TTY
53
Simon Glass2310c8e2019-11-14 12:57:22 -070054struct stdio_dev;
55
56int usbtty_getc(struct stdio_dev *dev);
57void usbtty_putc(struct stdio_dev *dev, const char c);
58void usbtty_puts(struct stdio_dev *dev, const char *str);
59int usbtty_tstc(struct stdio_dev *dev);
Tom Rix62994872009-10-31 12:37:44 -050060
Tom Rix2ec1abe2009-10-31 12:37:45 -050061#else
62
63/* stubs */
Simon Glass2310c8e2019-11-14 12:57:22 -070064#define usbtty_getc(dev) 0
65#define usbtty_putc(dev, a)
66#define usbtty_puts(dev, a)
67#define usbtty_tstc(dev) 0
Tom Rix2ec1abe2009-10-31 12:37:45 -050068
69#endif /* CONFIG_USB_TTY */
70
Simon Glass57d92752014-09-04 16:27:26 -060071struct udevice;
72
Patrick Delaunayeae47642018-05-17 14:50:44 +020073enum serial_par {
74 SERIAL_PAR_NONE,
75 SERIAL_PAR_ODD,
76 SERIAL_PAR_EVEN
77};
78
Patrice Chotardcbf53882018-08-03 15:07:38 +020079#define SERIAL_PAR_SHIFT 0
80#define SERIAL_PAR_MASK (0x03 << SERIAL_PAR_SHIFT)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +020081#define SERIAL_SET_PARITY(parity) \
82 ((parity << SERIAL_PAR_SHIFT) & SERIAL_PAR_MASK)
Patrice Chotardcbf53882018-08-03 15:07:38 +020083#define SERIAL_GET_PARITY(config) \
84 ((config & SERIAL_PAR_MASK) >> SERIAL_PAR_SHIFT)
85
86enum serial_bits {
87 SERIAL_5_BITS,
88 SERIAL_6_BITS,
89 SERIAL_7_BITS,
90 SERIAL_8_BITS
91};
92
93#define SERIAL_BITS_SHIFT 2
94#define SERIAL_BITS_MASK (0x3 << SERIAL_BITS_SHIFT)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +020095#define SERIAL_SET_BITS(bits) \
96 ((bits << SERIAL_BITS_SHIFT) & SERIAL_BITS_MASK)
Patrice Chotardcbf53882018-08-03 15:07:38 +020097#define SERIAL_GET_BITS(config) \
98 ((config & SERIAL_BITS_MASK) >> SERIAL_BITS_SHIFT)
99
100enum serial_stop {
101 SERIAL_HALF_STOP, /* 0.5 stop bit */
102 SERIAL_ONE_STOP, /* 1 stop bit */
103 SERIAL_ONE_HALF_STOP, /* 1.5 stop bit */
104 SERIAL_TWO_STOP /* 2 stop bit */
105};
106
107#define SERIAL_STOP_SHIFT 4
108#define SERIAL_STOP_MASK (0x3 << SERIAL_STOP_SHIFT)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200109#define SERIAL_SET_STOP(stop) \
110 ((stop << SERIAL_STOP_SHIFT) & SERIAL_STOP_MASK)
Patrice Chotardcbf53882018-08-03 15:07:38 +0200111#define SERIAL_GET_STOP(config) \
112 ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT)
113
Patrice Chotardd7c09682018-08-03 15:07:41 +0200114#define SERIAL_CONFIG(par, bits, stop) \
115 (par << SERIAL_PAR_SHIFT | \
116 bits << SERIAL_BITS_SHIFT | \
117 stop << SERIAL_STOP_SHIFT)
118
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200119#define SERIAL_DEFAULT_CONFIG \
120 (SERIAL_PAR_NONE << SERIAL_PAR_SHIFT | \
121 SERIAL_8_BITS << SERIAL_BITS_SHIFT | \
122 SERIAL_ONE_STOP << SERIAL_STOP_SHIFT)
Patrice Chotardcbf53882018-08-03 15:07:38 +0200123
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200124enum serial_chip_type {
125 SERIAL_CHIP_UNKNOWN = -1,
126 SERIAL_CHIP_16550_COMPATIBLE,
127};
128
129enum adr_space_type {
130 SERIAL_ADDRESS_SPACE_MEMORY = 0,
131 SERIAL_ADDRESS_SPACE_IO,
132};
133
134/**
135 * struct serial_device_info - structure to hold serial device info
136 *
137 * @type: type of the UART chip
138 * @addr_space: address space to access the registers
139 * @addr: physical address of the registers
140 * @reg_width: size (in bytes) of the IO accesses to the registers
141 * @reg_offset: offset to apply to the @addr from the start of the registers
142 * @reg_shift: quantity to shift the register offsets by
Andy Shevchenkobf4661bc2020-02-27 17:21:54 +0200143 * @clock: UART base clock speed in Hz
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200144 * @baudrate: baud rate
145 */
146struct serial_device_info {
147 enum serial_chip_type type;
148 enum adr_space_type addr_space;
149 ulong addr;
150 u8 reg_width;
151 u8 reg_offset;
152 u8 reg_shift;
Andy Shevchenkobf4661bc2020-02-27 17:21:54 +0200153 unsigned int clock;
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200154 unsigned int baudrate;
155};
156
157#define SERIAL_DEFAULT_ADDRESS 0xBADACCE5
Andy Shevchenkobf4661bc2020-02-27 17:21:54 +0200158#define SERIAL_DEFAULT_CLOCK (16 * 115200)
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200159
Simon Glass57d92752014-09-04 16:27:26 -0600160/**
161 * struct struct dm_serial_ops - Driver model serial operations
162 *
163 * The uclass interface is implemented by all serial devices which use
164 * driver model.
165 */
166struct dm_serial_ops {
167 /**
168 * setbrg() - Set up the baud rate generator
169 *
170 * Adjust baud rate divisors to set up a new baud rate for this
171 * device. Not all devices will support all rates. If the rate
172 * cannot be supported, the driver is free to select the nearest
173 * available rate. or return -EINVAL if this is not possible.
174 *
175 * @dev: Device pointer
176 * @baudrate: New baud rate to use
177 * @return 0 if OK, -ve on error
178 */
179 int (*setbrg)(struct udevice *dev, int baudrate);
180 /**
181 * getc() - Read a character and return it
182 *
183 * If no character is available, this should return -EAGAIN without
184 * waiting.
185 *
186 * @dev: Device pointer
187 * @return character (0..255), -ve on error
188 */
189 int (*getc)(struct udevice *dev);
190 /**
191 * putc() - Write a character
192 *
193 * @dev: Device pointer
194 * @ch: character to write
195 * @return 0 if OK, -ve on error
196 */
197 int (*putc)(struct udevice *dev, const char ch);
198 /**
Sean Anderson7a763472022-03-22 16:59:34 -0400199 * puts() - Write a string
200 *
201 * This writes a string. This function should be implemented only if
202 * writing multiple characters at once is more performant than just
203 * calling putc() in a loop.
204 *
205 * If the whole string cannot be written at once, then this function
206 * should return the number of characters written. Returning a negative
207 * error code implies that no characters were written. If this function
208 * returns 0, then it will be called again with the same arguments.
209 *
210 * @dev: Device pointer
211 * @s: The string to write
212 * @len: The length of the string to write.
213 * @return The number of characters written on success, or -ve on error
214 */
215 ssize_t (*puts)(struct udevice *dev, const char *s, size_t len);
216 /**
Simon Glass57d92752014-09-04 16:27:26 -0600217 * pending() - Check if input/output characters are waiting
218 *
219 * This can be used to return an indication of the number of waiting
220 * characters if the driver knows this (e.g. by looking at the FIFO
221 * level). It is acceptable to return 1 if an indeterminant number
222 * of characters is waiting.
223 *
224 * This method is optional.
225 *
226 * @dev: Device pointer
227 * @input: true to check input characters, false for output
228 * @return number of waiting characters, 0 for none, -ve on error
229 */
230 int (*pending)(struct udevice *dev, bool input);
231 /**
232 * clear() - Clear the serial FIFOs/holding registers
233 *
234 * This method is optional.
235 *
236 * This quickly clears any input/output characters from the UART.
237 * If this is not possible, but characters still exist, then it
238 * is acceptable to return -EAGAIN (try again) or -EINVAL (not
239 * supported).
240 *
241 * @dev: Device pointer
242 * @return 0 if OK, -ve on error
243 */
244 int (*clear)(struct udevice *dev);
Tom Rini1e019502022-12-04 10:14:17 -0500245#if CFG_POST & CFG_SYS_POST_UART
Simon Glass57d92752014-09-04 16:27:26 -0600246 /**
247 * loop() - Control serial device loopback mode
248 *
249 * @dev: Device pointer
250 * @on: 1 to turn loopback on, 0 to turn if off
251 */
252 int (*loop)(struct udevice *dev, int on);
253#endif
Patrice Chotardcbf53882018-08-03 15:07:38 +0200254
255 /**
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200256 * getconfig() - Get the uart configuration
257 * (parity, 5/6/7/8 bits word length, stop bits)
258 *
259 * Get a current config for this device.
260 *
261 * @dev: Device pointer
Simon Glasseab647d2018-12-28 14:23:11 -0700262 * @serial_config: Returns config information (see SERIAL_... above)
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200263 * @return 0 if OK, -ve on error
264 */
265 int (*getconfig)(struct udevice *dev, uint *serial_config);
266 /**
Patrice Chotardcbf53882018-08-03 15:07:38 +0200267 * setconfig() - Set up the uart configuration
268 * (parity, 5/6/7/8 bits word length, stop bits)
269 *
270 * Set up a new config for this device.
271 *
272 * @dev: Device pointer
Simon Goldschmidt0a168682018-11-02 21:08:16 +0100273 * @serial_config: number of bits, parity and number of stopbits to use
Patrice Chotardcbf53882018-08-03 15:07:38 +0200274 * @return 0 if OK, -ve on error
275 */
276 int (*setconfig)(struct udevice *dev, uint serial_config);
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200277 /**
278 * getinfo() - Get serial device information
279 *
280 * @dev: Device pointer
281 * @info: struct serial_device_info to fill
Simon Glasseab647d2018-12-28 14:23:11 -0700282 * @return 0 if OK, -ve on error
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200283 */
284 int (*getinfo)(struct udevice *dev, struct serial_device_info *info);
Simon Glass57d92752014-09-04 16:27:26 -0600285};
286
287/**
288 * struct serial_dev_priv - information about a device used by the uclass
289 *
Stefan Roese3ca7a062017-08-16 17:37:16 +0200290 * @sdev: stdio device attached to this uart
291 *
292 * @buf: Pointer to the RX buffer
293 * @rd_ptr: Read pointer in the RX buffer
294 * @wr_ptr: Write pointer in the RX buffer
Simon Glass57d92752014-09-04 16:27:26 -0600295 */
296struct serial_dev_priv {
297 struct stdio_dev *sdev;
Stefan Roese3ca7a062017-08-16 17:37:16 +0200298
299 char *buf;
300 int rd_ptr;
301 int wr_ptr;
Simon Glass57d92752014-09-04 16:27:26 -0600302};
303
304/* Access the serial operations for a device */
305#define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
306
Simon Glasseab647d2018-12-28 14:23:11 -0700307/**
308 * serial_getconfig() - Get the uart configuration
309 * (parity, 5/6/7/8 bits word length, stop bits)
310 *
311 * Get a current config for this device.
312 *
313 * @dev: Device pointer
314 * @serial_config: Returns config information (see SERIAL_... above)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100315 * Return: 0 if OK, -ve on error
Simon Glasseab647d2018-12-28 14:23:11 -0700316 */
Simon Glass67d1b052018-12-28 14:23:08 -0700317int serial_getconfig(struct udevice *dev, uint *config);
Simon Glasseab647d2018-12-28 14:23:11 -0700318
319/**
320 * serial_setconfig() - Set up the uart configuration
321 * (parity, 5/6/7/8 bits word length, stop bits)
322 *
323 * Set up a new config for this device.
324 *
325 * @dev: Device pointer
326 * @serial_config: number of bits, parity and number of stopbits to use
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100327 * Return: 0 if OK, -ve on error
Simon Glasseab647d2018-12-28 14:23:11 -0700328 */
Simon Glass3de04e72018-12-28 14:23:09 -0700329int serial_setconfig(struct udevice *dev, uint config);
Simon Glasseab647d2018-12-28 14:23:11 -0700330
331/**
332 * serial_getinfo() - Get serial device information
333 *
334 * @dev: Device pointer
335 * @info: struct serial_device_info to fill
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100336 * Return: 0 if OK, -ve on error
Simon Glasseab647d2018-12-28 14:23:11 -0700337 */
Simon Glassa61cbad2018-12-28 14:23:10 -0700338int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
Simon Glass0171f432018-12-28 14:23:07 -0700339
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100340void atmel_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100341void mcf_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100342void mpc85xx_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100343void mxc_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100344void ns16550_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100345void pl01x_serial_initialize(void);
346void pxa_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100347void sh_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100348
Simon Glassf516fd92019-11-14 12:57:23 -0700349/**
350 * serial_printf() - Write a formatted string to the serial console
351 *
352 * The total size of the output must be less than CONFIG_SYS_PBSIZE.
353 *
354 * @fmt: Printf format string, followed by format arguments
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100355 * Return: number of characters written
Simon Glassf516fd92019-11-14 12:57:23 -0700356 */
357int serial_printf(const char *fmt, ...)
358 __attribute__ ((format (__printf__, 1, 2)));
359
Simon Glassb03e0512019-11-14 12:57:24 -0700360int serial_init(void);
361void serial_setbrg(void);
362void serial_putc(const char ch);
363void serial_putc_raw(const char ch);
364void serial_puts(const char *str);
Pali Rohár78b52432022-09-05 11:31:19 +0200365#if defined(CONFIG_CONSOLE_FLUSH_SUPPORT) && CONFIG_IS_ENABLED(DM_SERIAL)
366void serial_flush(void);
367#else
368static inline void serial_flush(void) {}
369#endif
Simon Glassb03e0512019-11-14 12:57:24 -0700370int serial_getc(void);
371int serial_tstc(void);
372
wdenk281e00a2004-08-01 22:48:16 +0000373#endif