blob: 8f574e4ef896617caa997f0f99823287f476e40a [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) || \
32 defined(CONFIG_MB86R0x) || defined(CONFIG_MPC5xxx) || \
33 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;
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
Marek Vasut52039da2012-09-14 23:45:51 +020068#if defined(CONFIG_MPC512X)
Anatolij Gustschin65c3dfc2010-04-24 19:27:06 +020069extern struct stdio_dev *open_port(int num, int baudrate);
70extern int close_port(int num);
71extern int write_port(struct stdio_dev *port, char *buf);
72extern int read_port(struct stdio_dev *port, char *buf, int size);
73#endif
74
Simon Glass247f5962014-09-04 16:27:26 -060075struct udevice;
76
77/**
78 * struct struct dm_serial_ops - Driver model serial operations
79 *
80 * The uclass interface is implemented by all serial devices which use
81 * driver model.
82 */
83struct dm_serial_ops {
84 /**
85 * setbrg() - Set up the baud rate generator
86 *
87 * Adjust baud rate divisors to set up a new baud rate for this
88 * device. Not all devices will support all rates. If the rate
89 * cannot be supported, the driver is free to select the nearest
90 * available rate. or return -EINVAL if this is not possible.
91 *
92 * @dev: Device pointer
93 * @baudrate: New baud rate to use
94 * @return 0 if OK, -ve on error
95 */
96 int (*setbrg)(struct udevice *dev, int baudrate);
97 /**
98 * getc() - Read a character and return it
99 *
100 * If no character is available, this should return -EAGAIN without
101 * waiting.
102 *
103 * @dev: Device pointer
104 * @return character (0..255), -ve on error
105 */
106 int (*getc)(struct udevice *dev);
107 /**
108 * putc() - Write a character
109 *
110 * @dev: Device pointer
111 * @ch: character to write
112 * @return 0 if OK, -ve on error
113 */
114 int (*putc)(struct udevice *dev, const char ch);
115 /**
116 * pending() - Check if input/output characters are waiting
117 *
118 * This can be used to return an indication of the number of waiting
119 * characters if the driver knows this (e.g. by looking at the FIFO
120 * level). It is acceptable to return 1 if an indeterminant number
121 * of characters is waiting.
122 *
123 * This method is optional.
124 *
125 * @dev: Device pointer
126 * @input: true to check input characters, false for output
127 * @return number of waiting characters, 0 for none, -ve on error
128 */
129 int (*pending)(struct udevice *dev, bool input);
130 /**
131 * clear() - Clear the serial FIFOs/holding registers
132 *
133 * This method is optional.
134 *
135 * This quickly clears any input/output characters from the UART.
136 * If this is not possible, but characters still exist, then it
137 * is acceptable to return -EAGAIN (try again) or -EINVAL (not
138 * supported).
139 *
140 * @dev: Device pointer
141 * @return 0 if OK, -ve on error
142 */
143 int (*clear)(struct udevice *dev);
144#if CONFIG_POST & CONFIG_SYS_POST_UART
145 /**
146 * loop() - Control serial device loopback mode
147 *
148 * @dev: Device pointer
149 * @on: 1 to turn loopback on, 0 to turn if off
150 */
151 int (*loop)(struct udevice *dev, int on);
152#endif
153};
154
155/**
156 * struct serial_dev_priv - information about a device used by the uclass
157 *
158 * @sdev: stdio device attached to this uart
159 */
160struct serial_dev_priv {
161 struct stdio_dev *sdev;
162};
163
164/* Access the serial operations for a device */
165#define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
166
wdenk7ac16102004-08-01 22:48:16 +0000167#endif