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