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