blob: 47332c53406eb16b2226d1792c463ab6066fd396 [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
Matthias Fuchse54a67f2013-08-07 12:10:38 +020029#if defined(CONFIG_405GP) || \
Gerlando Falauto34148d62011-11-18 06:49:11 +000030 defined(CONFIG_405EP) || defined(CONFIG_405EZ) || \
31 defined(CONFIG_405EX) || defined(CONFIG_440) || \
Masahiro Yamada26ea9f42015-02-24 11:45:05 +090032 defined(CONFIG_MPC5xxx) || \
Gerlando Falauto34148d62011-11-18 06:49:11 +000033 defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
34 defined(CONFIG_MPC86xx) || defined(CONFIG_SYS_SC520) || \
Tom Warrend32b2a42012-12-11 13:34:17 +000035 defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
Michal Simekf5c5b3f2012-07-02 12:38:14 +020036 defined(CONFIG_MICROBLAZE)
wdenk96c7a8c2005-01-09 22:28:56 +000037extern struct serial_device serial0_device;
38extern struct serial_device serial1_device;
Marek Vasut3f085062012-09-12 20:02:05 +020039#endif
40
Wolfgang Denk44df5612006-08-30 23:02:10 +020041extern struct serial_device eserial1_device;
42extern struct serial_device eserial2_device;
Lokesh Vutlaabb44e62016-05-16 11:47:29 +053043extern struct serial_device eserial3_device;
44extern struct serial_device eserial4_device;
45extern struct serial_device eserial5_device;
46extern struct serial_device eserial6_device;
wdenk96c7a8c2005-01-09 22:28:56 +000047
Mike Frysinger53ba3222011-04-29 23:23:28 -040048extern void serial_register(struct serial_device *);
wdenk7ac16102004-08-01 22:48:16 +000049extern void serial_initialize(void);
Jean-Christophe PLAGNIOL-VILLARD2a7a0312009-05-16 12:14:54 +020050extern void serial_stdio_init(void);
Gerlando Falauto92999582011-11-18 06:49:12 +000051extern int serial_assign(const char *name);
wdenk7ac16102004-08-01 22:48:16 +000052extern void serial_reinit_all(void);
53
Tom Rixa36796b2009-10-31 12:37:44 -050054/* For usbtty */
Tom Rix7bea8682009-10-31 12:37:45 -050055#ifdef CONFIG_USB_TTY
56
Tom Rixa36796b2009-10-31 12:37:44 -050057extern int usbtty_getc(void);
58extern void usbtty_putc(const char c);
59extern void usbtty_puts(const char *str);
60extern int usbtty_tstc(void);
61
Tom Rix7bea8682009-10-31 12:37:45 -050062#else
63
64/* stubs */
65#define usbtty_getc() 0
66#define usbtty_putc(a)
67#define usbtty_puts(a)
68#define usbtty_tstc() 0
69
70#endif /* CONFIG_USB_TTY */
71
Marek Vasut52039da2012-09-14 23:45:51 +020072#if defined(CONFIG_MPC512X)
Anatolij Gustschin65c3dfc2010-04-24 19:27:06 +020073extern struct stdio_dev *open_port(int num, int baudrate);
74extern int close_port(int num);
75extern int write_port(struct stdio_dev *port, char *buf);
76extern int read_port(struct stdio_dev *port, char *buf, int size);
77#endif
78
Simon Glass247f5962014-09-04 16:27:26 -060079struct udevice;
80
81/**
82 * struct struct dm_serial_ops - Driver model serial operations
83 *
84 * The uclass interface is implemented by all serial devices which use
85 * driver model.
86 */
87struct dm_serial_ops {
88 /**
89 * setbrg() - Set up the baud rate generator
90 *
91 * Adjust baud rate divisors to set up a new baud rate for this
92 * device. Not all devices will support all rates. If the rate
93 * cannot be supported, the driver is free to select the nearest
94 * available rate. or return -EINVAL if this is not possible.
95 *
96 * @dev: Device pointer
97 * @baudrate: New baud rate to use
98 * @return 0 if OK, -ve on error
99 */
100 int (*setbrg)(struct udevice *dev, int baudrate);
101 /**
102 * getc() - Read a character and return it
103 *
104 * If no character is available, this should return -EAGAIN without
105 * waiting.
106 *
107 * @dev: Device pointer
108 * @return character (0..255), -ve on error
109 */
110 int (*getc)(struct udevice *dev);
111 /**
112 * putc() - Write a character
113 *
114 * @dev: Device pointer
115 * @ch: character to write
116 * @return 0 if OK, -ve on error
117 */
118 int (*putc)(struct udevice *dev, const char ch);
119 /**
120 * pending() - Check if input/output characters are waiting
121 *
122 * This can be used to return an indication of the number of waiting
123 * characters if the driver knows this (e.g. by looking at the FIFO
124 * level). It is acceptable to return 1 if an indeterminant number
125 * of characters is waiting.
126 *
127 * This method is optional.
128 *
129 * @dev: Device pointer
130 * @input: true to check input characters, false for output
131 * @return number of waiting characters, 0 for none, -ve on error
132 */
133 int (*pending)(struct udevice *dev, bool input);
134 /**
135 * clear() - Clear the serial FIFOs/holding registers
136 *
137 * This method is optional.
138 *
139 * This quickly clears any input/output characters from the UART.
140 * If this is not possible, but characters still exist, then it
141 * is acceptable to return -EAGAIN (try again) or -EINVAL (not
142 * supported).
143 *
144 * @dev: Device pointer
145 * @return 0 if OK, -ve on error
146 */
147 int (*clear)(struct udevice *dev);
148#if CONFIG_POST & CONFIG_SYS_POST_UART
149 /**
150 * loop() - Control serial device loopback mode
151 *
152 * @dev: Device pointer
153 * @on: 1 to turn loopback on, 0 to turn if off
154 */
155 int (*loop)(struct udevice *dev, int on);
156#endif
157};
158
159/**
160 * struct serial_dev_priv - information about a device used by the uclass
161 *
162 * @sdev: stdio device attached to this uart
163 */
164struct serial_dev_priv {
165 struct stdio_dev *sdev;
166};
167
168/* Access the serial operations for a device */
169#define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
170
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100171void amirix_serial_initialize(void);
172void arc_serial_initialize(void);
173void arm_dcc_initialize(void);
174void asc_serial_initialize(void);
175void atmel_serial_initialize(void);
176void au1x00_serial_initialize(void);
177void bfin_jtag_initialize(void);
178void bfin_serial_initialize(void);
179void bmw_serial_initialize(void);
180void clps7111_serial_initialize(void);
181void cogent_serial_initialize(void);
182void cpci750_serial_initialize(void);
183void evb64260_serial_initialize(void);
184void imx_serial_initialize(void);
185void iop480_serial_initialize(void);
186void jz_serial_initialize(void);
Jeroen Hofstee6512cc12014-10-27 20:10:07 +0100187void leon2_serial_initialize(void);
188void leon3_serial_initialize(void);
189void lh7a40x_serial_initialize(void);
190void lpc32xx_serial_initialize(void);
191void marvell_serial_initialize(void);
192void max3100_serial_initialize(void);
193void mcf_serial_initialize(void);
194void ml2_serial_initialize(void);
195void mpc512x_serial_initialize(void);
196void mpc5xx_serial_initialize(void);
197void mpc8260_scc_serial_initialize(void);
198void mpc8260_smc_serial_initialize(void);
199void mpc85xx_serial_initialize(void);
200void mpc8xx_serial_initialize(void);
201void mxc_serial_initialize(void);
202void mxs_auart_initialize(void);
203void ns16550_serial_initialize(void);
204void oc_serial_initialize(void);
205void p3mx_serial_initialize(void);
206void pl01x_serial_initialize(void);
207void pxa_serial_initialize(void);
208void s3c24xx_serial_initialize(void);
209void s5p_serial_initialize(void);
210void sa1100_serial_initialize(void);
211void sandbox_serial_initialize(void);
212void sconsole_serial_initialize(void);
213void sh_serial_initialize(void);
214void uartlite_serial_initialize(void);
215void zynq_serial_initialize(void);
216
wdenk7ac16102004-08-01 22:48:16 +0000217#endif