blob: c1a9fee250e93456b25138d6a6966e81c94a2b8d [file] [log] [blame]
wdenk7ac16102004-08-01 22:48:16 +00001#ifndef __SERIAL_H__
2#define __SERIAL_H__
3
Mike Frysinger078f2f12011-05-14 06:56:15 +00004#include <post.h>
5
wdenk7ac16102004-08-01 22:48:16 +00006struct serial_device {
Mike Frysinger6b300dc2011-11-10 14:11:04 +00007 /* enough bytes to match alignment of following func pointer */
Marek Vasut80919de2012-09-07 14:32:10 +02008 char name[16];
wdenk7ac16102004-08-01 22:48:16 +00009
Marek Vasutb46931d2012-09-07 14:35:31 +020010 int (*start)(void);
11 int (*stop)(void);
Marek Vasut80919de2012-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 Frysinger078f2f12011-05-14 06:56:15 +000017#if CONFIG_POST & CONFIG_SYS_POST_UART
Marek Vasut80919de2012-09-07 14:32:10 +020018 void (*loop)(int);
Mike Frysinger078f2f12011-05-14 06:56:15 +000019#endif
Marek Vasut80919de2012-09-07 14:32:10 +020020 struct serial_device *next;
wdenk7ac16102004-08-01 22:48:16 +000021};
22
Marek Vasut6b9124e2012-10-06 14:07:01 +000023void default_serial_puts(const char *s);
24
wdenk7ac16102004-08-01 22:48:16 +000025extern struct serial_device serial_smc_device;
26extern struct serial_device serial_scc_device;
Gerlando Falauto34148d62011-11-18 06:49:11 +000027extern struct serial_device *default_serial_console(void);
wdenk7ac16102004-08-01 22:48:16 +000028
Heiko Schocher20280122017-06-27 16:49:14 +020029#if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
Heiko Schocher6f90e582017-06-14 05:49:40 +020030 defined(CONFIG_MPC86xx) || \
Tom Warrend32b2a42012-12-11 13:34:17 +000031 defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
Michal Simekf5c5b3f2012-07-02 12:38:14 +020032 defined(CONFIG_MICROBLAZE)
wdenk96c7a8c2005-01-09 22:28:56 +000033extern struct serial_device serial0_device;
34extern struct serial_device serial1_device;
Marek Vasut3f085062012-09-12 20:02:05 +020035#endif
36
Wolfgang Denk44df5612006-08-30 23:02:10 +020037extern struct serial_device eserial1_device;
38extern struct serial_device eserial2_device;
Lokesh Vutlaabb44e62016-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;
wdenk96c7a8c2005-01-09 22:28:56 +000043
Mike Frysinger53ba3222011-04-29 23:23:28 -040044extern void serial_register(struct serial_device *);
wdenk7ac16102004-08-01 22:48:16 +000045extern void serial_initialize(void);
Jean-Christophe PLAGNIOL-VILLARD2a7a0312009-05-16 12:14:54 +020046extern void serial_stdio_init(void);
Gerlando Falauto92999582011-11-18 06:49:12 +000047extern int serial_assign(const char *name);
wdenk7ac16102004-08-01 22:48:16 +000048extern void serial_reinit_all(void);
49
Tom Rixa36796b2009-10-31 12:37:44 -050050/* For usbtty */
Tom Rix7bea8682009-10-31 12:37:45 -050051#ifdef CONFIG_USB_TTY
52
Tom Rixa36796b2009-10-31 12:37:44 -050053extern int usbtty_getc(void);
54extern void usbtty_putc(const char c);
55extern void usbtty_puts(const char *str);
56extern int usbtty_tstc(void);
57
Tom Rix7bea8682009-10-31 12:37:45 -050058#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
Simon Glass247f5962014-09-04 16:27:26 -060068struct udevice;
69
Patrick Delaunay830e35e2018-05-17 14:50:44 +020070enum serial_par {
71 SERIAL_PAR_NONE,
72 SERIAL_PAR_ODD,
73 SERIAL_PAR_EVEN
74};
75
Patrice Chotard46c1d9f2018-08-03 15:07:38 +020076#define SERIAL_PAR_SHIFT 0
77#define SERIAL_PAR_MASK (0x03 << SERIAL_PAR_SHIFT)
Andy Shevchenko08e98792018-11-20 23:52:32 +020078#define SERIAL_SET_PARITY(parity) \
79 ((parity << SERIAL_PAR_SHIFT) & SERIAL_PAR_MASK)
Patrice Chotard46c1d9f2018-08-03 15:07:38 +020080#define SERIAL_GET_PARITY(config) \
81 ((config & SERIAL_PAR_MASK) >> SERIAL_PAR_SHIFT)
82
83enum 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)
Andy Shevchenko08e98792018-11-20 23:52:32 +020092#define SERIAL_SET_BITS(bits) \
93 ((bits << SERIAL_BITS_SHIFT) & SERIAL_BITS_MASK)
Patrice Chotard46c1d9f2018-08-03 15:07:38 +020094#define SERIAL_GET_BITS(config) \
95 ((config & SERIAL_BITS_MASK) >> SERIAL_BITS_SHIFT)
96
97enum 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)
Andy Shevchenko08e98792018-11-20 23:52:32 +0200106#define SERIAL_SET_STOP(stop) \
107 ((stop << SERIAL_STOP_SHIFT) & SERIAL_STOP_MASK)
Patrice Chotard46c1d9f2018-08-03 15:07:38 +0200108#define SERIAL_GET_STOP(config) \
109 ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT)
110
Patrice Chotard70ed0ea2018-08-03 15:07:41 +0200111#define SERIAL_CONFIG(par, bits, stop) \
112 (par << SERIAL_PAR_SHIFT | \
113 bits << SERIAL_BITS_SHIFT | \
114 stop << SERIAL_STOP_SHIFT)
115
Andy Shevchenko08e98792018-11-20 23:52:32 +0200116#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)
Patrice Chotard46c1d9f2018-08-03 15:07:38 +0200120
Andy Shevchenko44f21da2018-11-20 23:52:33 +0200121enum serial_chip_type {
122 SERIAL_CHIP_UNKNOWN = -1,
123 SERIAL_CHIP_16550_COMPATIBLE,
124};
125
126enum 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 */
142struct 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
Simon Glass247f5962014-09-04 16:27:26 -0600154/**
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 */
160struct 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
Patrice Chotard46c1d9f2018-08-03 15:07:38 +0200230
231 /**
Andy Shevchenko08e98792018-11-20 23:52:32 +0200232 * 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 * @parity: parity to use
239 * @bits: bits number to use
240 * @stop: stop bits number to use
241 * @return 0 if OK, -ve on error
242 */
243 int (*getconfig)(struct udevice *dev, uint *serial_config);
244 /**
Patrice Chotard46c1d9f2018-08-03 15:07:38 +0200245 * setconfig() - Set up the uart configuration
246 * (parity, 5/6/7/8 bits word length, stop bits)
247 *
248 * Set up a new config for this device.
249 *
250 * @dev: Device pointer
Simon Goldschmidt6b981d02018-11-02 21:08:16 +0100251 * @serial_config: number of bits, parity and number of stopbits to use
Patrice Chotard46c1d9f2018-08-03 15:07:38 +0200252 * @return 0 if OK, -ve on error
253 */
254 int (*setconfig)(struct udevice *dev, uint serial_config);
Andy Shevchenko44f21da2018-11-20 23:52:33 +0200255 /**
256 * getinfo() - Get serial device information
257 *
258 * @dev: Device pointer
259 * @info: struct serial_device_info to fill
260 */
261 int (*getinfo)(struct udevice *dev, struct serial_device_info *info);
Simon Glass247f5962014-09-04 16:27:26 -0600262};
263
264/**
265 * struct serial_dev_priv - information about a device used by the uclass
266 *
Stefan Roese02072832017-08-16 17:37:16 +0200267 * @sdev: stdio device attached to this uart
268 *
269 * @buf: Pointer to the RX buffer
270 * @rd_ptr: Read pointer in the RX buffer
271 * @wr_ptr: Write pointer in the RX buffer
Simon Glass247f5962014-09-04 16:27:26 -0600272 */
273struct serial_dev_priv {
274 struct stdio_dev *sdev;
Stefan Roese02072832017-08-16 17:37:16 +0200275
276 char *buf;
277 int rd_ptr;
278 int wr_ptr;
Simon Glass247f5962014-09-04 16:27:26 -0600279};
280
281/* Access the serial operations for a device */
282#define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
283
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100284void atmel_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100285void mcf_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100286void mpc85xx_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100287void mxc_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100288void ns16550_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100289void pl01x_serial_initialize(void);
290void pxa_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100291void sh_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100292
wdenk7ac16102004-08-01 22:48:16 +0000293#endif