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