]>
Commit | Line | Data |
---|---|---|
281e00a3 WD |
1 | #ifndef __SERIAL_H__ |
2 | #define __SERIAL_H__ | |
3 | ||
7b826c2f MF |
4 | #include <post.h> |
5 | ||
281e00a3 | 6 | struct serial_device { |
f6add132 | 7 | /* enough bytes to match alignment of following func pointer */ |
78322d63 | 8 | char name[16]; |
281e00a3 | 9 | |
89143fb3 MV |
10 | int (*start)(void); |
11 | int (*stop)(void); | |
78322d63 MV |
12 | void (*setbrg)(void); |
13 | int (*getc)(void); | |
14 | int (*tstc)(void); | |
15 | void (*putc)(const char c); | |
16 | void (*puts)(const char *s); | |
7b826c2f | 17 | #if CONFIG_POST & CONFIG_SYS_POST_UART |
78322d63 | 18 | void (*loop)(int); |
7b826c2f | 19 | #endif |
78322d63 | 20 | struct serial_device *next; |
281e00a3 WD |
21 | }; |
22 | ||
bfb7d7a3 MV |
23 | void default_serial_puts(const char *s); |
24 | ||
281e00a3 WD |
25 | extern struct serial_device serial_smc_device; |
26 | extern struct serial_device serial_scc_device; | |
a6e6f7f4 GF |
27 | extern struct serial_device *default_serial_console(void); |
28 | ||
98f705c9 | 29 | #if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \ |
064b55cf | 30 | defined(CONFIG_MPC86xx) || \ |
18138ab2 | 31 | defined(CONFIG_ARCH_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \ |
7636ebe1 | 32 | defined(CONFIG_MICROBLAZE) |
ff36fd85 WD |
33 | extern struct serial_device serial0_device; |
34 | extern struct serial_device serial1_device; | |
abc0ed8d MV |
35 | #endif |
36 | ||
0fd30252 WD |
37 | extern struct serial_device eserial1_device; |
38 | extern struct serial_device eserial2_device; | |
3d16389c LV |
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; | |
ff36fd85 | 43 | |
635f330f | 44 | extern void serial_register(struct serial_device *); |
52cb4d4f | 45 | extern void serial_stdio_init(void); |
7813ca9b | 46 | extern int serial_assign(const char *name); |
281e00a3 | 47 | extern void serial_reinit_all(void); |
39a19223 | 48 | int serial_initialize(void); |
281e00a3 | 49 | |
6299487e | 50 | /* For usbtty */ |
2ec1abea TR |
51 | #ifdef CONFIG_USB_TTY |
52 | ||
2310c8ed SG |
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); | |
6299487e | 59 | |
2ec1abea TR |
60 | #else |
61 | ||
62 | /* stubs */ | |
2310c8ed SG |
63 | #define usbtty_getc(dev) 0 |
64 | #define usbtty_putc(dev, a) | |
65 | #define usbtty_puts(dev, a) | |
66 | #define usbtty_tstc(dev) 0 | |
2ec1abea TR |
67 | |
68 | #endif /* CONFIG_USB_TTY */ | |
69 | ||
57d92753 SG |
70 | struct udevice; |
71 | ||
eae4764f PD |
72 | enum serial_par { |
73 | SERIAL_PAR_NONE, | |
74 | SERIAL_PAR_ODD, | |
75 | SERIAL_PAR_EVEN | |
76 | }; | |
77 | ||
cbf53883 PC |
78 | #define SERIAL_PAR_SHIFT 0 |
79 | #define SERIAL_PAR_MASK (0x03 << SERIAL_PAR_SHIFT) | |
ac7f5db9 AS |
80 | #define SERIAL_SET_PARITY(parity) \ |
81 | ((parity << SERIAL_PAR_SHIFT) & SERIAL_PAR_MASK) | |
cbf53883 PC |
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) | |
ac7f5db9 AS |
94 | #define SERIAL_SET_BITS(bits) \ |
95 | ((bits << SERIAL_BITS_SHIFT) & SERIAL_BITS_MASK) | |
cbf53883 PC |
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) | |
ac7f5db9 AS |
108 | #define SERIAL_SET_STOP(stop) \ |
109 | ((stop << SERIAL_STOP_SHIFT) & SERIAL_STOP_MASK) | |
cbf53883 PC |
110 | #define SERIAL_GET_STOP(config) \ |
111 | ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT) | |
112 | ||
d7c09684 PC |
113 | #define SERIAL_CONFIG(par, bits, stop) \ |
114 | (par << SERIAL_PAR_SHIFT | \ | |
115 | bits << SERIAL_BITS_SHIFT | \ | |
116 | stop << SERIAL_STOP_SHIFT) | |
117 | ||
ac7f5db9 AS |
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) | |
cbf53883 | 122 | |
d5bb4f86 AS |
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 | |
bf4661bc | 142 | * @clock: UART base clock speed in Hz |
d5bb4f86 AS |
143 | * @baudrate: baud rate |
144 | */ | |
145 | struct serial_device_info { | |
146 | enum serial_chip_type type; | |
147 | enum adr_space_type addr_space; | |
148 | ulong addr; | |
149 | u8 reg_width; | |
150 | u8 reg_offset; | |
151 | u8 reg_shift; | |
bf4661bc | 152 | unsigned int clock; |
d5bb4f86 AS |
153 | unsigned int baudrate; |
154 | }; | |
155 | ||
156 | #define SERIAL_DEFAULT_ADDRESS 0xBADACCE5 | |
bf4661bc | 157 | #define SERIAL_DEFAULT_CLOCK (16 * 115200) |
d5bb4f86 | 158 | |
57d92753 SG |
159 | /** |
160 | * struct struct dm_serial_ops - Driver model serial operations | |
161 | * | |
162 | * The uclass interface is implemented by all serial devices which use | |
163 | * driver model. | |
164 | */ | |
165 | struct dm_serial_ops { | |
166 | /** | |
167 | * setbrg() - Set up the baud rate generator | |
168 | * | |
169 | * Adjust baud rate divisors to set up a new baud rate for this | |
170 | * device. Not all devices will support all rates. If the rate | |
171 | * cannot be supported, the driver is free to select the nearest | |
172 | * available rate. or return -EINVAL if this is not possible. | |
173 | * | |
174 | * @dev: Device pointer | |
175 | * @baudrate: New baud rate to use | |
176 | * @return 0 if OK, -ve on error | |
177 | */ | |
178 | int (*setbrg)(struct udevice *dev, int baudrate); | |
179 | /** | |
180 | * getc() - Read a character and return it | |
181 | * | |
182 | * If no character is available, this should return -EAGAIN without | |
183 | * waiting. | |
184 | * | |
185 | * @dev: Device pointer | |
186 | * @return character (0..255), -ve on error | |
187 | */ | |
188 | int (*getc)(struct udevice *dev); | |
189 | /** | |
190 | * putc() - Write a character | |
191 | * | |
192 | * @dev: Device pointer | |
193 | * @ch: character to write | |
194 | * @return 0 if OK, -ve on error | |
195 | */ | |
196 | int (*putc)(struct udevice *dev, const char ch); | |
197 | /** | |
198 | * pending() - Check if input/output characters are waiting | |
199 | * | |
200 | * This can be used to return an indication of the number of waiting | |
201 | * characters if the driver knows this (e.g. by looking at the FIFO | |
202 | * level). It is acceptable to return 1 if an indeterminant number | |
203 | * of characters is waiting. | |
204 | * | |
205 | * This method is optional. | |
206 | * | |
207 | * @dev: Device pointer | |
208 | * @input: true to check input characters, false for output | |
209 | * @return number of waiting characters, 0 for none, -ve on error | |
210 | */ | |
211 | int (*pending)(struct udevice *dev, bool input); | |
212 | /** | |
213 | * clear() - Clear the serial FIFOs/holding registers | |
214 | * | |
215 | * This method is optional. | |
216 | * | |
217 | * This quickly clears any input/output characters from the UART. | |
218 | * If this is not possible, but characters still exist, then it | |
219 | * is acceptable to return -EAGAIN (try again) or -EINVAL (not | |
220 | * supported). | |
221 | * | |
222 | * @dev: Device pointer | |
223 | * @return 0 if OK, -ve on error | |
224 | */ | |
225 | int (*clear)(struct udevice *dev); | |
226 | #if CONFIG_POST & CONFIG_SYS_POST_UART | |
227 | /** | |
228 | * loop() - Control serial device loopback mode | |
229 | * | |
230 | * @dev: Device pointer | |
231 | * @on: 1 to turn loopback on, 0 to turn if off | |
232 | */ | |
233 | int (*loop)(struct udevice *dev, int on); | |
234 | #endif | |
cbf53883 | 235 | |
ac7f5db9 AS |
236 | /** |
237 | * getconfig() - Get the uart configuration | |
238 | * (parity, 5/6/7/8 bits word length, stop bits) | |
239 | * | |
240 | * Get a current config for this device. | |
241 | * | |
242 | * @dev: Device pointer | |
eab647d5 | 243 | * @serial_config: Returns config information (see SERIAL_... above) |
ac7f5db9 AS |
244 | * @return 0 if OK, -ve on error |
245 | */ | |
246 | int (*getconfig)(struct udevice *dev, uint *serial_config); | |
cbf53883 PC |
247 | /** |
248 | * setconfig() - Set up the uart configuration | |
249 | * (parity, 5/6/7/8 bits word length, stop bits) | |
250 | * | |
251 | * Set up a new config for this device. | |
252 | * | |
253 | * @dev: Device pointer | |
0a168687 | 254 | * @serial_config: number of bits, parity and number of stopbits to use |
cbf53883 PC |
255 | * @return 0 if OK, -ve on error |
256 | */ | |
257 | int (*setconfig)(struct udevice *dev, uint serial_config); | |
d5bb4f86 AS |
258 | /** |
259 | * getinfo() - Get serial device information | |
260 | * | |
261 | * @dev: Device pointer | |
262 | * @info: struct serial_device_info to fill | |
eab647d5 | 263 | * @return 0 if OK, -ve on error |
d5bb4f86 AS |
264 | */ |
265 | int (*getinfo)(struct udevice *dev, struct serial_device_info *info); | |
57d92753 SG |
266 | }; |
267 | ||
268 | /** | |
269 | * struct serial_dev_priv - information about a device used by the uclass | |
270 | * | |
3ca7a06a SR |
271 | * @sdev: stdio device attached to this uart |
272 | * | |
273 | * @buf: Pointer to the RX buffer | |
274 | * @rd_ptr: Read pointer in the RX buffer | |
275 | * @wr_ptr: Write pointer in the RX buffer | |
57d92753 SG |
276 | */ |
277 | struct serial_dev_priv { | |
278 | struct stdio_dev *sdev; | |
3ca7a06a SR |
279 | |
280 | char *buf; | |
281 | int rd_ptr; | |
282 | int wr_ptr; | |
57d92753 SG |
283 | }; |
284 | ||
285 | /* Access the serial operations for a device */ | |
286 | #define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops) | |
287 | ||
eab647d5 SG |
288 | /** |
289 | * serial_getconfig() - Get the uart configuration | |
290 | * (parity, 5/6/7/8 bits word length, stop bits) | |
291 | * | |
292 | * Get a current config for this device. | |
293 | * | |
294 | * @dev: Device pointer | |
295 | * @serial_config: Returns config information (see SERIAL_... above) | |
296 | * @return 0 if OK, -ve on error | |
297 | */ | |
67d1b051 | 298 | int serial_getconfig(struct udevice *dev, uint *config); |
eab647d5 SG |
299 | |
300 | /** | |
301 | * serial_setconfig() - Set up the uart configuration | |
302 | * (parity, 5/6/7/8 bits word length, stop bits) | |
303 | * | |
304 | * Set up a new config for this device. | |
305 | * | |
306 | * @dev: Device pointer | |
307 | * @serial_config: number of bits, parity and number of stopbits to use | |
308 | * @return 0 if OK, -ve on error | |
309 | */ | |
3de04e77 | 310 | int serial_setconfig(struct udevice *dev, uint config); |
eab647d5 SG |
311 | |
312 | /** | |
313 | * serial_getinfo() - Get serial device information | |
314 | * | |
315 | * @dev: Device pointer | |
316 | * @info: struct serial_device_info to fill | |
317 | * @return 0 if OK, -ve on error | |
318 | */ | |
a61cbad7 | 319 | int serial_getinfo(struct udevice *dev, struct serial_device_info *info); |
0171f432 | 320 | |
94a255df | 321 | void atmel_serial_initialize(void); |
94a255df | 322 | void mcf_serial_initialize(void); |
94a255df | 323 | void mpc85xx_serial_initialize(void); |
94a255df | 324 | void mxc_serial_initialize(void); |
94a255df | 325 | void ns16550_serial_initialize(void); |
94a255df JH |
326 | void pl01x_serial_initialize(void); |
327 | void pxa_serial_initialize(void); | |
94a255df | 328 | void sh_serial_initialize(void); |
94a255df | 329 | |
f516fd99 SG |
330 | /** |
331 | * serial_printf() - Write a formatted string to the serial console | |
332 | * | |
333 | * The total size of the output must be less than CONFIG_SYS_PBSIZE. | |
334 | * | |
335 | * @fmt: Printf format string, followed by format arguments | |
336 | * @return number of characters written | |
337 | */ | |
338 | int serial_printf(const char *fmt, ...) | |
339 | __attribute__ ((format (__printf__, 1, 2))); | |
340 | ||
b03e0510 SG |
341 | int serial_init(void); |
342 | void serial_setbrg(void); | |
343 | void serial_putc(const char ch); | |
344 | void serial_putc_raw(const char ch); | |
345 | void serial_puts(const char *str); | |
346 | int serial_getc(void); | |
347 | int serial_tstc(void); | |
348 | ||
281e00a3 | 349 | #endif |