[deliverable/linux.git] / include / linux / serial_sci.h

#ifndef __LINUX_SERIAL_SCI_H
#define __LINUX_SERIAL_SCI_H

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

/*
 * Generic header for SuperH SCI(F) (used by sh/sh64/h8300 and related parts)
 */

#define SCIx_NOT_SUPPORTED	(-1)

enum {
	SCBRR_ALGO_1,		/* ((clk + 16 * bps) / (16 * bps) - 1) */
	SCBRR_ALGO_2,		/* ((clk + 16 * bps) / (32 * bps) - 1) */
	SCBRR_ALGO_3,		/* (((clk * 2) + 16 * bps) / (16 * bps) - 1) */
	SCBRR_ALGO_4,		/* (((clk * 2) + 16 * bps) / (32 * bps) - 1) */
	SCBRR_ALGO_5,		/* (((clk * 1000 / 32) / bps) - 1) */
};

#define SCSCR_TIE	(1 << 7)
#define SCSCR_RIE	(1 << 6)
#define SCSCR_TE	(1 << 5)
#define SCSCR_RE	(1 << 4)
#define SCSCR_REIE	(1 << 3)	/* not supported by all parts */
#define SCSCR_TOIE	(1 << 2)	/* not supported by all parts */
#define SCSCR_CKE1	(1 << 1)
#define SCSCR_CKE0	(1 << 0)

/* SCxSR SCI */
#define SCI_TDRE  0x80
#define SCI_RDRF  0x40
#define SCI_ORER  0x20
#define SCI_FER   0x10
#define SCI_PER   0x08
#define SCI_TEND  0x04

#define SCI_DEFAULT_ERROR_MASK (SCI_PER | SCI_FER)

/* SCxSR SCIF */
#define SCIF_ER    0x0080
#define SCIF_TEND  0x0040
#define SCIF_TDFE  0x0020
#define SCIF_BRK   0x0010
#define SCIF_FER   0x0008
#define SCIF_PER   0x0004
#define SCIF_RDF   0x0002
#define SCIF_DR    0x0001

#define SCIF_DEFAULT_ERROR_MASK (SCIF_PER | SCIF_FER | SCIF_ER | SCIF_BRK)

/* SCSPTR, optional */
#define SCSPTR_RTSIO	(1 << 7)
#define SCSPTR_CTSIO	(1 << 5)

/* Offsets into the sci_port->irqs array */
enum {
	SCIx_ERI_IRQ,
	SCIx_RXI_IRQ,
	SCIx_TXI_IRQ,
	SCIx_BRI_IRQ,
	SCIx_NR_IRQS,

	SCIx_MUX_IRQ = SCIx_NR_IRQS,	/* special case */
};

/* Offsets into the sci_port->gpios array */
enum {
	SCIx_SCK,
	SCIx_RXD,
	SCIx_TXD,
	SCIx_CTS,
	SCIx_RTS,

	SCIx_NR_FNS,
};

enum {
	SCIx_PROBE_REGTYPE,

	SCIx_SCI_REGTYPE,
	SCIx_IRDA_REGTYPE,
	SCIx_SCIFA_REGTYPE,
	SCIx_SCIFB_REGTYPE,
	SCIx_SH2_SCIF_FIFODATA_REGTYPE,
	SCIx_SH3_SCIF_REGTYPE,
	SCIx_SH4_SCIF_REGTYPE,
	SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE,
	SCIx_SH4_SCIF_FIFODATA_REGTYPE,
	SCIx_SH7705_SCIF_REGTYPE,

	SCIx_NR_REGTYPES,
};

#define SCIx_IRQ_MUXED(irq)		\
{					\
	[SCIx_ERI_IRQ]	= (irq),	\
	[SCIx_RXI_IRQ]	= (irq),	\
	[SCIx_TXI_IRQ]	= (irq),	\
	[SCIx_BRI_IRQ]	= (irq),	\
}

#define SCIx_IRQ_IS_MUXED(port)			\
	((port)->cfg->irqs[SCIx_ERI_IRQ] ==	\
	 (port)->cfg->irqs[SCIx_RXI_IRQ]) ||	\
	((port)->cfg->irqs[SCIx_ERI_IRQ] &&	\
	 !(port)->cfg->irqs[SCIx_RXI_IRQ])
/*
 * SCI register subset common for all port types.
 * Not all registers will exist on all parts.
 */
enum {
	SCSMR, SCBRR, SCSCR, SCxSR,
	SCFCR, SCFDR, SCxTDR, SCxRDR,
	SCLSR, SCTFDR, SCRFDR, SCSPTR,

	SCIx_NR_REGS,
};

struct device;

struct plat_sci_port_ops {
	void (*init_pins)(struct uart_port *, unsigned int cflag);
};

/*
 * Port-specific capabilities
 */
#define SCIx_HAVE_RTSCTS	(1 << 0)

/*
 * Platform device specific platform_data struct
 */
struct plat_sci_port {
	unsigned long	mapbase;		/* resource base */
	unsigned int	irqs[SCIx_NR_IRQS];	/* ERI, RXI, TXI, BRI */
	unsigned int	gpios[SCIx_NR_FNS];	/* SCK, RXD, TXD, CTS, RTS */
	unsigned int	type;			/* SCI / SCIF / IRDA */
	upf_t		flags;			/* UPF_* flags */
	unsigned long	capabilities;		/* Port features/capabilities */

	unsigned int	scbrr_algo_id;		/* SCBRR calculation algo */
	unsigned int	scscr;			/* SCSCR initialization */

	/*
	 * Platform overrides if necessary, defaults otherwise.
	 */
	int		overrun_bit;
	unsigned int	error_mask;

	int		port_reg;
	unsigned char	regshift;
	unsigned char	regtype;

	struct plat_sci_port_ops	*ops;

	unsigned int	dma_slave_tx;
	unsigned int	dma_slave_rx;
};

#endif /* __LINUX_SERIAL_SCI_H */
Commit	Line	Data
96de1a8f PM	1	#ifndef __LINUX_SERIAL_SCI_H
96de1a8f PM	2	#define __LINUX_SERIAL_SCI_H
ecd95616 PM	3
ecd95616 PM	4	#include <linux/serial_core.h>
14baf9d7	5	#include <linux/sh_dma.h>
ecd95616 PM	6
ecd95616 PM	7	/*
96de1a8f	8	* Generic header for SuperH SCI(F) (used by sh/sh64/h8300 and related parts)
ecd95616 PM	9	*/
ecd95616 PM	10
debf9507 PM	11	#define SCIx_NOT_SUPPORTED (-1)
debf9507 PM	12
26c92f37 PM	13	enum {
	14	SCBRR_ALGO_1, /* ((clk + 16 * bps) / (16 * bps) - 1) */
	15	SCBRR_ALGO_2, /* ((clk + 16 * bps) / (32 * bps) - 1) */
	16	SCBRR_ALGO_3, /* (((clk * 2) + 16 * bps) / (16 * bps) - 1) */
	17	SCBRR_ALGO_4, /* (((clk * 2) + 16 * bps) / (32 * bps) - 1) */
	18	SCBRR_ALGO_5, /* (((clk * 1000 / 32) / bps) - 1) */
	19	};
	20
00b9de9c PM	21	#define SCSCR_TIE (1 << 7)
	22	#define SCSCR_RIE (1 << 6)
	23	#define SCSCR_TE (1 << 5)
	24	#define SCSCR_RE (1 << 4)
f43dc23d	25	#define SCSCR_REIE (1 << 3) /* not supported by all parts */
00b9de9c PM	26	#define SCSCR_TOIE (1 << 2) /* not supported by all parts */
	27	#define SCSCR_CKE1 (1 << 1)
	28	#define SCSCR_CKE0 (1 << 0)
	29
debf9507 PM	30	/* SCxSR SCI */
	31	#define SCI_TDRE 0x80
	32	#define SCI_RDRF 0x40
	33	#define SCI_ORER 0x20
	34	#define SCI_FER 0x10
	35	#define SCI_PER 0x08
	36	#define SCI_TEND 0x04
	37
	38	#define SCI_DEFAULT_ERROR_MASK (SCI_PER \| SCI_FER)
	39
	40	/* SCxSR SCIF */
	41	#define SCIF_ER 0x0080
	42	#define SCIF_TEND 0x0040
	43	#define SCIF_TDFE 0x0020
	44	#define SCIF_BRK 0x0010
	45	#define SCIF_FER 0x0008
	46	#define SCIF_PER 0x0004
	47	#define SCIF_RDF 0x0002
	48	#define SCIF_DR 0x0001
	49
	50	#define SCIF_DEFAULT_ERROR_MASK (SCIF_PER \| SCIF_FER \| SCIF_ER \| SCIF_BRK)
	51
faf02f8f PM	52	/* SCSPTR, optional */
	53	#define SCSPTR_RTSIO (1 << 7)
	54	#define SCSPTR_CTSIO (1 << 5)
	55
ecd95616 PM	56	/* Offsets into the sci_port->irqs array */
	57	enum {
	58	SCIx_ERI_IRQ,
	59	SCIx_RXI_IRQ,
	60	SCIx_TXI_IRQ,
	61	SCIx_BRI_IRQ,
	62	SCIx_NR_IRQS,
9174fc8f PM	63
9174fc8f PM	64	SCIx_MUX_IRQ = SCIx_NR_IRQS, /* special case */
ecd95616 PM	65	};
ecd95616 PM	66
50f0959a PM	67	/* Offsets into the sci_port->gpios array */
	68	enum {
	69	SCIx_SCK,
	70	SCIx_RXD,
	71	SCIx_TXD,
	72	SCIx_CTS,
	73	SCIx_RTS,
	74
	75	SCIx_NR_FNS,
	76	};
	77
61a6976b PM	78	enum {
	79	SCIx_PROBE_REGTYPE,
	80
	81	SCIx_SCI_REGTYPE,
	82	SCIx_IRDA_REGTYPE,
	83	SCIx_SCIFA_REGTYPE,
	84	SCIx_SCIFB_REGTYPE,
3af1f8a4	85	SCIx_SH2_SCIF_FIFODATA_REGTYPE,
61a6976b PM	86	SCIx_SH3_SCIF_REGTYPE,
	87	SCIx_SH4_SCIF_REGTYPE,
	88	SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE,
	89	SCIx_SH4_SCIF_FIFODATA_REGTYPE,
	90	SCIx_SH7705_SCIF_REGTYPE,
	91
	92	SCIx_NR_REGTYPES,
	93	};
	94
22cc8378 PM	95	#define SCIx_IRQ_MUXED(irq) \
	96	{ \
	97	[SCIx_ERI_IRQ] = (irq), \
	98	[SCIx_RXI_IRQ] = (irq), \
	99	[SCIx_TXI_IRQ] = (irq), \
	100	[SCIx_BRI_IRQ] = (irq), \
	101	}
	102
9174fc8f PM	103	#define SCIx_IRQ_IS_MUXED(port) \
	104	((port)->cfg->irqs[SCIx_ERI_IRQ] == \
	105	(port)->cfg->irqs[SCIx_RXI_IRQ]) \|\| \
	106	((port)->cfg->irqs[SCIx_ERI_IRQ] && \
	107	!(port)->cfg->irqs[SCIx_RXI_IRQ])
61a6976b PM	108	/*
	109	* SCI register subset common for all port types.
	110	* Not all registers will exist on all parts.
	111	*/
	112	enum {
	113	SCSMR, SCBRR, SCSCR, SCxSR,
	114	SCFCR, SCFDR, SCxTDR, SCxRDR,
	115	SCLSR, SCTFDR, SCRFDR, SCSPTR,
	116
	117	SCIx_NR_REGS,
	118	};
	119
73a19e4c GL	120	struct device;
73a19e4c GL	121
61a6976b PM	122	struct plat_sci_port_ops {
	123	void (init_pins)(struct uart_port , unsigned int cflag);
	124	};
	125
faf02f8f PM	126	/*
	127	* Port-specific capabilities
	128	*/
	129	#define SCIx_HAVE_RTSCTS (1 << 0)
	130
ecd95616 PM	131	/*
	132	* Platform device specific platform_data struct
	133	*/
	134	struct plat_sci_port {
ecd95616 PM	135	unsigned long mapbase; /* resource base */
ecd95616 PM	136	unsigned int irqs[SCIx_NR_IRQS]; /* ERI, RXI, TXI, BRI */
50f0959a	137	unsigned int gpios[SCIx_NR_FNS]; /* SCK, RXD, TXD, CTS, RTS */
ecd95616 PM	138	unsigned int type; /* SCI / SCIF / IRDA */
ecd95616 PM	139	upf_t flags; /* UPF_* flags */
faf02f8f	140	unsigned long capabilities; /* Port features/capabilities */
00b9de9c	141
26c92f37	142	unsigned int scbrr_algo_id; /* SCBRR calculation algo */
00b9de9c	143	unsigned int scscr; /* SCSCR initialization */
f43dc23d	144
debf9507 PM	145	/*
	146	* Platform overrides if necessary, defaults otherwise.
	147	*/
	148	int overrun_bit;
	149	unsigned int error_mask;
	150
514820eb	151	int port_reg;
61a6976b PM	152	unsigned char regshift;
	153	unsigned char regtype;
	154
	155	struct plat_sci_port_ops *ops;
514820eb	156
27bd1075 PM	157	unsigned int dma_slave_tx;
27bd1075 PM	158	unsigned int dma_slave_rx;
ecd95616 PM	159	};
ecd95616 PM	160
96de1a8f	161	#endif /* __LINUX_SERIAL_SCI_H */