blob: e9c3021a37ae149bb1f2844068cc9507d49a2db3 [file] [log] [blame]
Paul Mundt96de1a82008-02-26 14:52:45 +09001#ifndef __LINUX_SERIAL_SCI_H
2#define __LINUX_SERIAL_SCI_H
Paul Mundtecd95612006-09-27 17:32:30 +09003
4#include <linux/serial_core.h>
Paul Mundt14baf9d2010-05-24 16:31:08 +09005#include <linux/sh_dma.h>
Paul Mundtecd95612006-09-27 17:32:30 +09006
7/*
Guenter Roeck4b084782013-08-30 06:01:49 -07008 * Generic header for SuperH (H)SCI(F) (used by sh/sh64 and related parts)
Paul Mundtecd95612006-09-27 17:32:30 +09009 */
10
Paul Mundtdebf9502011-06-08 18:19:37 +090011#define SCIx_NOT_SUPPORTED (-1)
12
Paul Mundt26c92f32009-06-24 18:23:52 +090013enum {
Laurent Pinchart6557b1f2013-12-06 10:59:12 +010014 SCBRR_ALGO_1, /* clk / (16 * bps) */
15 SCBRR_ALGO_2, /* DIV_ROUND_CLOSEST(clk, 32 * bps) - 1 */
16 SCBRR_ALGO_3, /* clk / (8 * bps) */
17 SCBRR_ALGO_4, /* DIV_ROUND_CLOSEST(clk, 16 * bps) - 1 */
Ulrich Hechtf303b362013-05-31 17:57:01 +020018 SCBRR_ALGO_6, /* HSCIF variable sample rate algorithm */
Paul Mundt26c92f32009-06-24 18:23:52 +090019};
20
Paul Mundt00b9de92009-06-24 17:53:33 +090021#define SCSCR_TIE (1 << 7)
22#define SCSCR_RIE (1 << 6)
23#define SCSCR_TE (1 << 5)
24#define SCSCR_RE (1 << 4)
Paul Mundtf43dc232011-01-13 15:06:28 +090025#define SCSCR_REIE (1 << 3) /* not supported by all parts */
Paul Mundt00b9de92009-06-24 17:53:33 +090026#define SCSCR_TOIE (1 << 2) /* not supported by all parts */
27#define SCSCR_CKE1 (1 << 1)
28#define SCSCR_CKE0 (1 << 0)
29
Paul Mundtdebf9502011-06-08 18:19:37 +090030/* 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
Ulrich Hechtf303b362013-05-31 17:57:01 +020040/* SCxSR SCIF, HSCIF */
Paul Mundtdebf9502011-06-08 18:19:37 +090041#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
Paul Mundtfaf02f82011-12-02 17:44:50 +090052/* SCSPTR, optional */
53#define SCSPTR_RTSIO (1 << 7)
54#define SCSPTR_CTSIO (1 << 5)
Shimoda, Yoshihirobbb4ce52012-04-06 09:59:14 +090055#define SCSPTR_SPB2IO (1 << 1)
56#define SCSPTR_SPB2DT (1 << 0)
Paul Mundtfaf02f82011-12-02 17:44:50 +090057
Ulrich Hechtf303b362013-05-31 17:57:01 +020058/* HSSRR HSCIF */
59#define HSCIF_SRE 0x8000
60
Paul Mundtecd95612006-09-27 17:32:30 +090061/* Offsets into the sci_port->irqs array */
62enum {
63 SCIx_ERI_IRQ,
64 SCIx_RXI_IRQ,
65 SCIx_TXI_IRQ,
66 SCIx_BRI_IRQ,
67 SCIx_NR_IRQS,
Paul Mundt9174fc82011-06-28 15:25:36 +090068
69 SCIx_MUX_IRQ = SCIx_NR_IRQS, /* special case */
Paul Mundtecd95612006-09-27 17:32:30 +090070};
71
Paul Mundt61a69762011-06-14 12:40:19 +090072enum {
73 SCIx_PROBE_REGTYPE,
74
75 SCIx_SCI_REGTYPE,
76 SCIx_IRDA_REGTYPE,
77 SCIx_SCIFA_REGTYPE,
78 SCIx_SCIFB_REGTYPE,
Phil Edworthy3af1f8a2011-10-03 15:16:47 +010079 SCIx_SH2_SCIF_FIFODATA_REGTYPE,
Paul Mundt61a69762011-06-14 12:40:19 +090080 SCIx_SH3_SCIF_REGTYPE,
81 SCIx_SH4_SCIF_REGTYPE,
82 SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE,
83 SCIx_SH4_SCIF_FIFODATA_REGTYPE,
84 SCIx_SH7705_SCIF_REGTYPE,
Ulrich Hechtf303b362013-05-31 17:57:01 +020085 SCIx_HSCIF_REGTYPE,
Paul Mundt61a69762011-06-14 12:40:19 +090086
87 SCIx_NR_REGTYPES,
88};
89
Paul Mundt22cc8372011-01-19 14:37:14 +090090#define SCIx_IRQ_MUXED(irq) \
91{ \
92 [SCIx_ERI_IRQ] = (irq), \
93 [SCIx_RXI_IRQ] = (irq), \
94 [SCIx_TXI_IRQ] = (irq), \
95 [SCIx_BRI_IRQ] = (irq), \
96}
97
Paul Mundt9174fc82011-06-28 15:25:36 +090098#define SCIx_IRQ_IS_MUXED(port) \
Laurent Pinchart1fcc91a2013-12-06 10:59:16 +010099 ((port)->irqs[SCIx_ERI_IRQ] == \
100 (port)->irqs[SCIx_RXI_IRQ]) || \
101 ((port)->irqs[SCIx_ERI_IRQ] && \
102 ((port)->irqs[SCIx_RXI_IRQ] < 0))
Paul Mundt61a69762011-06-14 12:40:19 +0900103/*
104 * SCI register subset common for all port types.
105 * Not all registers will exist on all parts.
106 */
107enum {
108 SCSMR, SCBRR, SCSCR, SCxSR,
109 SCFCR, SCFDR, SCxTDR, SCxRDR,
110 SCLSR, SCTFDR, SCRFDR, SCSPTR,
Ulrich Hechtf303b362013-05-31 17:57:01 +0200111 HSSRR,
Paul Mundt61a69762011-06-14 12:40:19 +0900112
113 SCIx_NR_REGS,
114};
115
Guennadi Liakhovetski73a19e4c2010-03-02 11:39:15 +0900116struct device;
117
Paul Mundt61a69762011-06-14 12:40:19 +0900118struct plat_sci_port_ops {
119 void (*init_pins)(struct uart_port *, unsigned int cflag);
120};
121
Paul Mundtecd95612006-09-27 17:32:30 +0900122/*
Paul Mundtfaf02f82011-12-02 17:44:50 +0900123 * Port-specific capabilities
124 */
125#define SCIx_HAVE_RTSCTS (1 << 0)
126
127/*
Paul Mundtecd95612006-09-27 17:32:30 +0900128 * Platform device specific platform_data struct
129 */
130struct plat_sci_port {
Paul Mundtecd95612006-09-27 17:32:30 +0900131 unsigned long mapbase; /* resource base */
132 unsigned int irqs[SCIx_NR_IRQS]; /* ERI, RXI, TXI, BRI */
Ulrich Hechtf303b362013-05-31 17:57:01 +0200133 unsigned int type; /* SCI / SCIF / IRDA / HSCIF */
Paul Mundtecd95612006-09-27 17:32:30 +0900134 upf_t flags; /* UPF_* flags */
Paul Mundtfaf02f82011-12-02 17:44:50 +0900135 unsigned long capabilities; /* Port features/capabilities */
Paul Mundt00b9de92009-06-24 17:53:33 +0900136
Paul Mundt26c92f32009-06-24 18:23:52 +0900137 unsigned int scbrr_algo_id; /* SCBRR calculation algo */
Paul Mundt00b9de92009-06-24 17:53:33 +0900138 unsigned int scscr; /* SCSCR initialization */
Paul Mundtf43dc232011-01-13 15:06:28 +0900139
Paul Mundtdebf9502011-06-08 18:19:37 +0900140 /*
141 * Platform overrides if necessary, defaults otherwise.
142 */
Paul Mundt514820e2011-06-08 18:51:32 +0900143 int port_reg;
Paul Mundt61a69762011-06-14 12:40:19 +0900144 unsigned char regshift;
145 unsigned char regtype;
146
147 struct plat_sci_port_ops *ops;
Paul Mundt514820e2011-06-08 18:51:32 +0900148
Paul Mundt27bd1072011-01-19 15:37:31 +0900149 unsigned int dma_slave_tx;
150 unsigned int dma_slave_rx;
Paul Mundtecd95612006-09-27 17:32:30 +0900151};
152
Paul Mundt96de1a82008-02-26 14:52:45 +0900153#endif /* __LINUX_SERIAL_SCI_H */