[linux-2.6-block.git] / include / linux / serial_8250.h

/*
 *  linux/include/linux/serial_8250.h
 *
 *  Copyright (C) 2004 Russell King
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */
#ifndef _LINUX_SERIAL_8250_H
#define _LINUX_SERIAL_8250_H

#include <linux/serial_core.h>
#include <linux/platform_device.h>

/*
 * This is the platform device platform_data structure
 */
struct plat_serial8250_port {
	unsigned long	iobase;		/* io base address */
	void __iomem	*membase;	/* ioremap cookie or NULL */
	resource_size_t	mapbase;	/* resource base */
	unsigned int	irq;		/* interrupt number */
	unsigned long	irqflags;	/* request_irq flags */
	unsigned int	uartclk;	/* UART clock rate */
	void            *private_data;
	unsigned char	regshift;	/* register shift */
	unsigned char	iotype;		/* UPIO_* */
	unsigned char	hub6;
	upf_t		flags;		/* UPF_* flags */
	unsigned int	type;		/* If UPF_FIXED_TYPE */
	unsigned int	(*serial_in)(struct uart_port *, int);
	void		(*serial_out)(struct uart_port *, int, int);
	void		(*set_termios)(struct uart_port *,
			               struct ktermios *new,
			               struct ktermios *old);
	int		(*handle_irq)(struct uart_port *);
	void		(*pm)(struct uart_port *, unsigned int state,
			      unsigned old);
	void		(*handle_break)(struct uart_port *);
};

/*
 * Allocate 8250 platform device IDs.  Nothing is implied by
 * the numbering here, except for the legacy entry being -1.
 */
enum {
	PLAT8250_DEV_LEGACY = -1,
	PLAT8250_DEV_PLATFORM,
	PLAT8250_DEV_PLATFORM1,
	PLAT8250_DEV_PLATFORM2,
	PLAT8250_DEV_FOURPORT,
	PLAT8250_DEV_ACCENT,
	PLAT8250_DEV_BOCA,
	PLAT8250_DEV_EXAR_ST16C554,
	PLAT8250_DEV_HUB6,
	PLAT8250_DEV_AU1X00,
	PLAT8250_DEV_SM501,
};

struct uart_8250_dma;

/*
 * This should be used by drivers which want to register
 * their own 8250 ports without registering their own
 * platform device.  Using these will make your driver
 * dependent on the 8250 driver.
 */

struct uart_8250_port {
	struct uart_port	port;
	struct timer_list	timer;		/* "no irq" timer */
	struct list_head	list;		/* ports on this IRQ */
	unsigned short		capabilities;	/* port capabilities */
	unsigned short		bugs;		/* port bugs */
	bool			fifo_bug;	/* min RX trigger if enabled */
	unsigned int		tx_loadsz;	/* transmit fifo load size */
	unsigned char		acr;
	unsigned char		fcr;
	unsigned char		ier;
	unsigned char		lcr;
	unsigned char		mcr;
	unsigned char		mcr_mask;	/* mask of user bits */
	unsigned char		mcr_force;	/* mask of forced bits */
	unsigned char		cur_iotype;	/* Running I/O type */
	unsigned int		rpm_tx_active;
	unsigned char		canary;		/* non-zero during system sleep
						 *   if no_console_suspend
						 */

	/*
	 * Some bits in registers are cleared on a read, so they must
	 * be saved whenever the register is read but the bits will not
	 * be immediately processed.
	 */
#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
	unsigned char		lsr_saved_flags;
#define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
	unsigned char		msr_saved_flags;

	struct uart_8250_dma	*dma;

	/* 8250 specific callbacks */
	int			(*dl_read)(struct uart_8250_port *);
	void			(*dl_write)(struct uart_8250_port *, int);
};

static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
{
	return container_of(up, struct uart_8250_port, port);
}

int serial8250_register_8250_port(struct uart_8250_port *);
void serial8250_unregister_port(int line);
void serial8250_suspend_port(int line);
void serial8250_resume_port(int line);

extern int early_serial_setup(struct uart_port *port);

extern int serial8250_find_port(struct uart_port *p);
extern int serial8250_find_port_for_earlycon(void);
extern unsigned int serial8250_early_in(struct uart_port *port, int offset);
extern void serial8250_early_out(struct uart_port *port, int offset, int value);
extern int setup_early_serial8250_console(char *cmdline);
extern void serial8250_do_set_termios(struct uart_port *port,
		struct ktermios *termios, struct ktermios *old);
extern int serial8250_do_startup(struct uart_port *port);
extern void serial8250_do_shutdown(struct uart_port *port);
extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
			     unsigned int oldstate);
extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
extern int fsl8250_handle_irq(struct uart_port *port);
int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
void serial8250_tx_chars(struct uart_8250_port *up);
unsigned int serial8250_modem_status(struct uart_8250_port *up);

extern void serial8250_set_isa_configurator(void (*v)
					(int port, struct uart_port *up,
						unsigned short *capabilities));

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/serial_8250.h
	3	*
	4	* Copyright (C) 2004 Russell King
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*/
	11	#ifndef _LINUX_SERIAL_8250_H
	12	#define _LINUX_SERIAL_8250_H
	13
	14	#include <linux/serial_core.h>
d052d1be	15	#include <linux/platform_device.h>
1da177e4	16
bc49a661 RK	17	/*
	18	* This is the platform device platform_data structure
	19	*/
1da177e4 LT	20	struct plat_serial8250_port {
	21	unsigned long iobase; /* io base address */
	22	void __iomem membase; / ioremap cookie or NULL */
4f640efb	23	resource_size_t mapbase; /* resource base */
1da177e4	24	unsigned int irq; /* interrupt number */
1c2f0493	25	unsigned long irqflags; /* request_irq flags */
1da177e4	26	unsigned int uartclk; /* UART clock rate */
74a19741	27	void *private_data;
1da177e4 LT	28	unsigned char regshift; /* register shift */
1da177e4 LT	29	unsigned char iotype; /* UPIO_* */
ec9f47cd	30	unsigned char hub6;
0077d45e	31	upf_t flags; /* UPF_* flags */
8e23fcc8	32	unsigned int type; /* If UPF_FIXED_TYPE */
7d6a07d1 DD	33	unsigned int (serial_in)(struct uart_port , int);
7d6a07d1 DD	34	void (serial_out)(struct uart_port , int, int);
235dae5d PL	35	void (set_termios)(struct uart_port ,
	36	struct ktermios *new,
	37	struct ktermios *old);
583d28e9	38	int (handle_irq)(struct uart_port );
c161afe9 ML	39	void (pm)(struct uart_port , unsigned int state,
c161afe9 ML	40	unsigned old);
bf03f65b	41	void (handle_break)(struct uart_port );
1da177e4 LT	42	};
1da177e4 LT	43
6df29deb RK	44	/*
	45	* Allocate 8250 platform device IDs. Nothing is implied by
	46	* the numbering here, except for the legacy entry being -1.
	47	*/
	48	enum {
	49	PLAT8250_DEV_LEGACY = -1,
	50	PLAT8250_DEV_PLATFORM,
	51	PLAT8250_DEV_PLATFORM1,
104c7b03	52	PLAT8250_DEV_PLATFORM2,
6df29deb RK	53	PLAT8250_DEV_FOURPORT,
	54	PLAT8250_DEV_ACCENT,
	55	PLAT8250_DEV_BOCA,
e0980daf	56	PLAT8250_DEV_EXAR_ST16C554,
6df29deb	57	PLAT8250_DEV_HUB6,
21c614a7	58	PLAT8250_DEV_AU1X00,
61711f8f	59	PLAT8250_DEV_SM501,
6df29deb RK	60	};
6df29deb RK	61
9ee4b83e HK	62	struct uart_8250_dma;
9ee4b83e HK	63
bc49a661 RK	64	/*
	65	* This should be used by drivers which want to register
	66	* their own 8250 ports without registering their own
	67	* platform device. Using these will make your driver
	68	* dependent on the 8250 driver.
	69	*/
ce7240e4 AC	70
	71	struct uart_8250_port {
	72	struct uart_port port;
	73	struct timer_list timer; /* "no irq" timer */
	74	struct list_head list; /* ports on this IRQ */
	75	unsigned short capabilities; /* port capabilities */
	76	unsigned short bugs; /* port bugs */
aef9a7bd	77	bool fifo_bug; /* min RX trigger if enabled */
ce7240e4 AC	78	unsigned int tx_loadsz; /* transmit fifo load size */
ce7240e4 AC	79	unsigned char acr;
aef9a7bd	80	unsigned char fcr;
ce7240e4 AC	81	unsigned char ier;
	82	unsigned char lcr;
	83	unsigned char mcr;
	84	unsigned char mcr_mask; /* mask of user bits */
	85	unsigned char mcr_force; /* mask of forced bits */
	86	unsigned char cur_iotype; /* Running I/O type */
baeb7ef3	87	unsigned int rpm_tx_active;
4516d50a PH	88	unsigned char canary; /* non-zero during system sleep
	89	* if no_console_suspend
	90	*/
ce7240e4 AC	91
	92	/*
	93	* Some bits in registers are cleared on a read, so they must
	94	* be saved whenever the register is read but the bits will not
	95	* be immediately processed.
	96	*/
	97	#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
	98	unsigned char lsr_saved_flags;
	99	#define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
	100	unsigned char msr_saved_flags;
	101
9ee4b83e HK	102	struct uart_8250_dma *dma;
9ee4b83e HK	103
ce7240e4 AC	104	/* 8250 specific callbacks */
	105	int (dl_read)(struct uart_8250_port );
	106	void (dl_write)(struct uart_8250_port , int);
	107	};
bc49a661	108
b1261c86 AS	109	static inline struct uart_8250_port up_to_u8250p(struct uart_port up)
	110	{
	111	return container_of(up, struct uart_8250_port, port);
	112	}
	113
f73fa05b	114	int serial8250_register_8250_port(struct uart_8250_port *);
bc49a661 RK	115	void serial8250_unregister_port(int line);
	116	void serial8250_suspend_port(int line);
	117	void serial8250_resume_port(int line);
	118
b187f180 YL	119	extern int early_serial_setup(struct uart_port *port);
b187f180 YL	120
18a8bd94 YL	121	extern int serial8250_find_port(struct uart_port *p);
18a8bd94 YL	122	extern int serial8250_find_port_for_earlycon(void);
ed71871b NC	123	extern unsigned int serial8250_early_in(struct uart_port *port, int offset);
ed71871b NC	124	extern void serial8250_early_out(struct uart_port *port, int offset, int value);
18a8bd94	125	extern int setup_early_serial8250_console(char *cmdline);
235dae5d PL	126	extern void serial8250_do_set_termios(struct uart_port *port,
235dae5d PL	127	struct ktermios termios, struct ktermios old);
b99b121b SAS	128	extern int serial8250_do_startup(struct uart_port *port);
b99b121b SAS	129	extern void serial8250_do_shutdown(struct uart_port *port);
c161afe9 ML	130	extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
c161afe9 ML	131	unsigned int oldstate);
4bf4ea9d	132	extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
9deaa53a	133	extern int fsl8250_handle_irq(struct uart_port *port);
583d28e9	134	int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
3986fb2b PG	135	unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
	136	void serial8250_tx_chars(struct uart_8250_port *up);
	137	unsigned int serial8250_modem_status(struct uart_8250_port *up);
18a8bd94	138
af7f3743 AC	139	extern void serial8250_set_isa_configurator(void (*v)
	140	(int port, struct uart_port *up,
	141	unsigned short *capabilities));
	142
1da177e4	143	#endif