xref: /linux-6.15/include/linux/serial_sci.h (revision 6db201da)
1 #ifndef __LINUX_SERIAL_SCI_H
2 #define __LINUX_SERIAL_SCI_H
3 
4 #include <linux/serial_core.h>
5 #include <linux/sh_dma.h>
6 
7 /*
8  * Generic header for SuperH (H)SCI(F) (used by sh/sh64 and related parts)
9  */
10 
11 #define SCIx_NOT_SUPPORTED	(-1)
12 
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_6,		/* HSCIF variable sample rate algorithm */
19 };
20 
21 #define SCSCR_TIE	(1 << 7)
22 #define SCSCR_RIE	(1 << 6)
23 #define SCSCR_TE	(1 << 5)
24 #define SCSCR_RE	(1 << 4)
25 #define SCSCR_REIE	(1 << 3)	/* not supported by all parts */
26 #define SCSCR_TOIE	(1 << 2)	/* not supported by all parts */
27 #define SCSCR_CKE1	(1 << 1)
28 #define SCSCR_CKE0	(1 << 0)
29 
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, HSCIF */
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 
52 /* SCSPTR, optional */
53 #define SCSPTR_RTSIO	(1 << 7)
54 #define SCSPTR_CTSIO	(1 << 5)
55 #define SCSPTR_SPB2IO	(1 << 1)
56 #define SCSPTR_SPB2DT	(1 << 0)
57 
58 /* HSSRR HSCIF */
59 #define HSCIF_SRE	0x8000
60 
61 /* Offsets into the sci_port->irqs array */
62 enum {
63 	SCIx_ERI_IRQ,
64 	SCIx_RXI_IRQ,
65 	SCIx_TXI_IRQ,
66 	SCIx_BRI_IRQ,
67 	SCIx_NR_IRQS,
68 
69 	SCIx_MUX_IRQ = SCIx_NR_IRQS,	/* special case */
70 };
71 
72 /* Offsets into the sci_port->gpios array */
73 enum {
74 	SCIx_SCK,
75 	SCIx_RXD,
76 	SCIx_TXD,
77 	SCIx_CTS,
78 	SCIx_RTS,
79 
80 	SCIx_NR_FNS,
81 };
82 
83 enum {
84 	SCIx_PROBE_REGTYPE,
85 
86 	SCIx_SCI_REGTYPE,
87 	SCIx_IRDA_REGTYPE,
88 	SCIx_SCIFA_REGTYPE,
89 	SCIx_SCIFB_REGTYPE,
90 	SCIx_SH2_SCIF_FIFODATA_REGTYPE,
91 	SCIx_SH3_SCIF_REGTYPE,
92 	SCIx_SH4_SCIF_REGTYPE,
93 	SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE,
94 	SCIx_SH4_SCIF_FIFODATA_REGTYPE,
95 	SCIx_SH7705_SCIF_REGTYPE,
96 	SCIx_HSCIF_REGTYPE,
97 
98 	SCIx_NR_REGTYPES,
99 };
100 
101 #define SCIx_IRQ_MUXED(irq)		\
102 {					\
103 	[SCIx_ERI_IRQ]	= (irq),	\
104 	[SCIx_RXI_IRQ]	= (irq),	\
105 	[SCIx_TXI_IRQ]	= (irq),	\
106 	[SCIx_BRI_IRQ]	= (irq),	\
107 }
108 
109 #define SCIx_IRQ_IS_MUXED(port)			\
110 	((port)->cfg->irqs[SCIx_ERI_IRQ] ==	\
111 	 (port)->cfg->irqs[SCIx_RXI_IRQ]) ||	\
112 	((port)->cfg->irqs[SCIx_ERI_IRQ] &&	\
113 	 !(port)->cfg->irqs[SCIx_RXI_IRQ])
114 /*
115  * SCI register subset common for all port types.
116  * Not all registers will exist on all parts.
117  */
118 enum {
119 	SCSMR, SCBRR, SCSCR, SCxSR,
120 	SCFCR, SCFDR, SCxTDR, SCxRDR,
121 	SCLSR, SCTFDR, SCRFDR, SCSPTR,
122 	HSSRR,
123 
124 	SCIx_NR_REGS,
125 };
126 
127 struct device;
128 
129 struct plat_sci_port_ops {
130 	void (*init_pins)(struct uart_port *, unsigned int cflag);
131 };
132 
133 /*
134  * Port-specific capabilities
135  */
136 #define SCIx_HAVE_RTSCTS	(1 << 0)
137 
138 /*
139  * Platform device specific platform_data struct
140  */
141 struct plat_sci_port {
142 	unsigned long	mapbase;		/* resource base */
143 	unsigned int	irqs[SCIx_NR_IRQS];	/* ERI, RXI, TXI, BRI */
144 	unsigned int	gpios[SCIx_NR_FNS];	/* SCK, RXD, TXD, CTS, RTS */
145 	unsigned int	type;			/* SCI / SCIF / IRDA / HSCIF */
146 	upf_t		flags;			/* UPF_* flags */
147 	unsigned long	capabilities;		/* Port features/capabilities */
148 
149 	unsigned int	scbrr_algo_id;		/* SCBRR calculation algo */
150 	unsigned int	scscr;			/* SCSCR initialization */
151 
152 	/*
153 	 * Platform overrides if necessary, defaults otherwise.
154 	 */
155 	int		overrun_bit;
156 	unsigned int	error_mask;
157 
158 	int		port_reg;
159 	unsigned char	regshift;
160 	unsigned char	regtype;
161 
162 	struct plat_sci_port_ops	*ops;
163 
164 	unsigned int	dma_slave_tx;
165 	unsigned int	dma_slave_rx;
166 };
167 
168 #endif /* __LINUX_SERIAL_SCI_H */
169