blob: 384df94ed0b3ef1496ed0e8a6c04a7685424fdf8 [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) || \
Tom Warren6d6c0ba2012-12-11 13:34:17 +000031 defined(CONFIG_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
Tom Rix62994872009-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 Rix2ec1abe2009-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 Glass57d92752014-09-04 16:27:26 -060068struct udevice;
69
70/**
71 * struct struct dm_serial_ops - Driver model serial operations
72 *
73 * The uclass interface is implemented by all serial devices which use
74 * driver model.
75 */
76struct dm_serial_ops {
77 /**
78 * setbrg() - Set up the baud rate generator
79 *
80 * Adjust baud rate divisors to set up a new baud rate for this
81 * device. Not all devices will support all rates. If the rate
82 * cannot be supported, the driver is free to select the nearest
83 * available rate. or return -EINVAL if this is not possible.
84 *
85 * @dev: Device pointer
86 * @baudrate: New baud rate to use
87 * @return 0 if OK, -ve on error
88 */
89 int (*setbrg)(struct udevice *dev, int baudrate);
90 /**
91 * getc() - Read a character and return it
92 *
93 * If no character is available, this should return -EAGAIN without
94 * waiting.
95 *
96 * @dev: Device pointer
97 * @return character (0..255), -ve on error
98 */
99 int (*getc)(struct udevice *dev);
100 /**
101 * putc() - Write a character
102 *
103 * @dev: Device pointer
104 * @ch: character to write
105 * @return 0 if OK, -ve on error
106 */
107 int (*putc)(struct udevice *dev, const char ch);
108 /**
109 * pending() - Check if input/output characters are waiting
110 *
111 * This can be used to return an indication of the number of waiting
112 * characters if the driver knows this (e.g. by looking at the FIFO
113 * level). It is acceptable to return 1 if an indeterminant number
114 * of characters is waiting.
115 *
116 * This method is optional.
117 *
118 * @dev: Device pointer
119 * @input: true to check input characters, false for output
120 * @return number of waiting characters, 0 for none, -ve on error
121 */
122 int (*pending)(struct udevice *dev, bool input);
123 /**
124 * clear() - Clear the serial FIFOs/holding registers
125 *
126 * This method is optional.
127 *
128 * This quickly clears any input/output characters from the UART.
129 * If this is not possible, but characters still exist, then it
130 * is acceptable to return -EAGAIN (try again) or -EINVAL (not
131 * supported).
132 *
133 * @dev: Device pointer
134 * @return 0 if OK, -ve on error
135 */
136 int (*clear)(struct udevice *dev);
137#if CONFIG_POST & CONFIG_SYS_POST_UART
138 /**
139 * loop() - Control serial device loopback mode
140 *
141 * @dev: Device pointer
142 * @on: 1 to turn loopback on, 0 to turn if off
143 */
144 int (*loop)(struct udevice *dev, int on);
145#endif
146};
147
148/**
149 * struct serial_dev_priv - information about a device used by the uclass
150 *
Stefan Roese3ca7a062017-08-16 17:37:16 +0200151 * @sdev: stdio device attached to this uart
152 *
153 * @buf: Pointer to the RX buffer
154 * @rd_ptr: Read pointer in the RX buffer
155 * @wr_ptr: Write pointer in the RX buffer
Simon Glass57d92752014-09-04 16:27:26 -0600156 */
157struct serial_dev_priv {
158 struct stdio_dev *sdev;
Stefan Roese3ca7a062017-08-16 17:37:16 +0200159
160 char *buf;
161 int rd_ptr;
162 int wr_ptr;
Simon Glass57d92752014-09-04 16:27:26 -0600163};
164
165/* Access the serial operations for a device */
166#define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
167
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100168void atmel_serial_initialize(void);
169void au1x00_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100170void mcf_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100171void mpc85xx_serial_initialize(void);
172void mpc8xx_serial_initialize(void);
173void mxc_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100174void ns16550_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100175void pl01x_serial_initialize(void);
176void pxa_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100177void sh_serial_initialize(void);
Jeroen Hofstee94a255d2014-10-27 20:10:07 +0100178
wdenk281e00a2004-08-01 22:48:16 +0000179#endif