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