Paul Mundt | 96de1a8 | 2008-02-26 14:52:45 +0900 | [diff] [blame] | 1 | #ifndef __LINUX_SERIAL_SCI_H |
| 2 | #define __LINUX_SERIAL_SCI_H |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 3 | |
| 4 | #include <linux/serial_core.h> |
Paul Mundt | 14baf9d | 2010-05-24 16:31:08 +0900 | [diff] [blame] | 5 | #include <linux/sh_dma.h> |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 6 | |
| 7 | /* |
Guenter Roeck | 4b08478 | 2013-08-30 06:01:49 -0700 | [diff] [blame] | 8 | * Generic header for SuperH (H)SCI(F) (used by sh/sh64 and related parts) |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 9 | */ |
| 10 | |
Paul Mundt | debf950 | 2011-06-08 18:19:37 +0900 | [diff] [blame] | 11 | #define SCIx_NOT_SUPPORTED (-1) |
| 12 | |
Paul Mundt | 26c92f3 | 2009-06-24 18:23:52 +0900 | [diff] [blame] | 13 | enum { |
Laurent Pinchart | ec09c5e | 2013-12-06 10:59:20 +0100 | [diff] [blame^] | 14 | SCBRR_ALGO_NONE, /* Compute sampling rate in the driver */ |
Laurent Pinchart | 6557b1f | 2013-12-06 10:59:12 +0100 | [diff] [blame] | 15 | SCBRR_ALGO_1, /* clk / (16 * bps) */ |
| 16 | SCBRR_ALGO_2, /* DIV_ROUND_CLOSEST(clk, 32 * bps) - 1 */ |
| 17 | SCBRR_ALGO_3, /* clk / (8 * bps) */ |
| 18 | SCBRR_ALGO_4, /* DIV_ROUND_CLOSEST(clk, 16 * bps) - 1 */ |
Ulrich Hecht | f303b36 | 2013-05-31 17:57:01 +0200 | [diff] [blame] | 19 | SCBRR_ALGO_6, /* HSCIF variable sample rate algorithm */ |
Paul Mundt | 26c92f3 | 2009-06-24 18:23:52 +0900 | [diff] [blame] | 20 | }; |
| 21 | |
Paul Mundt | 00b9de9 | 2009-06-24 17:53:33 +0900 | [diff] [blame] | 22 | #define SCSCR_TIE (1 << 7) |
| 23 | #define SCSCR_RIE (1 << 6) |
| 24 | #define SCSCR_TE (1 << 5) |
| 25 | #define SCSCR_RE (1 << 4) |
Paul Mundt | f43dc23 | 2011-01-13 15:06:28 +0900 | [diff] [blame] | 26 | #define SCSCR_REIE (1 << 3) /* not supported by all parts */ |
Paul Mundt | 00b9de9 | 2009-06-24 17:53:33 +0900 | [diff] [blame] | 27 | #define SCSCR_TOIE (1 << 2) /* not supported by all parts */ |
| 28 | #define SCSCR_CKE1 (1 << 1) |
| 29 | #define SCSCR_CKE0 (1 << 0) |
| 30 | |
Paul Mundt | debf950 | 2011-06-08 18:19:37 +0900 | [diff] [blame] | 31 | /* SCxSR SCI */ |
| 32 | #define SCI_TDRE 0x80 |
| 33 | #define SCI_RDRF 0x40 |
| 34 | #define SCI_ORER 0x20 |
| 35 | #define SCI_FER 0x10 |
| 36 | #define SCI_PER 0x08 |
| 37 | #define SCI_TEND 0x04 |
| 38 | |
| 39 | #define SCI_DEFAULT_ERROR_MASK (SCI_PER | SCI_FER) |
| 40 | |
Ulrich Hecht | f303b36 | 2013-05-31 17:57:01 +0200 | [diff] [blame] | 41 | /* SCxSR SCIF, HSCIF */ |
Paul Mundt | debf950 | 2011-06-08 18:19:37 +0900 | [diff] [blame] | 42 | #define SCIF_ER 0x0080 |
| 43 | #define SCIF_TEND 0x0040 |
| 44 | #define SCIF_TDFE 0x0020 |
| 45 | #define SCIF_BRK 0x0010 |
| 46 | #define SCIF_FER 0x0008 |
| 47 | #define SCIF_PER 0x0004 |
| 48 | #define SCIF_RDF 0x0002 |
| 49 | #define SCIF_DR 0x0001 |
| 50 | |
| 51 | #define SCIF_DEFAULT_ERROR_MASK (SCIF_PER | SCIF_FER | SCIF_ER | SCIF_BRK) |
| 52 | |
Paul Mundt | faf02f8 | 2011-12-02 17:44:50 +0900 | [diff] [blame] | 53 | /* SCSPTR, optional */ |
| 54 | #define SCSPTR_RTSIO (1 << 7) |
| 55 | #define SCSPTR_CTSIO (1 << 5) |
Shimoda, Yoshihiro | bbb4ce5 | 2012-04-06 09:59:14 +0900 | [diff] [blame] | 56 | #define SCSPTR_SPB2IO (1 << 1) |
| 57 | #define SCSPTR_SPB2DT (1 << 0) |
Paul Mundt | faf02f8 | 2011-12-02 17:44:50 +0900 | [diff] [blame] | 58 | |
Ulrich Hecht | f303b36 | 2013-05-31 17:57:01 +0200 | [diff] [blame] | 59 | /* HSSRR HSCIF */ |
| 60 | #define HSCIF_SRE 0x8000 |
| 61 | |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 62 | /* Offsets into the sci_port->irqs array */ |
| 63 | enum { |
| 64 | SCIx_ERI_IRQ, |
| 65 | SCIx_RXI_IRQ, |
| 66 | SCIx_TXI_IRQ, |
| 67 | SCIx_BRI_IRQ, |
| 68 | SCIx_NR_IRQS, |
Paul Mundt | 9174fc8 | 2011-06-28 15:25:36 +0900 | [diff] [blame] | 69 | |
| 70 | SCIx_MUX_IRQ = SCIx_NR_IRQS, /* special case */ |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 71 | }; |
| 72 | |
Paul Mundt | 61a6976 | 2011-06-14 12:40:19 +0900 | [diff] [blame] | 73 | enum { |
| 74 | SCIx_PROBE_REGTYPE, |
| 75 | |
| 76 | SCIx_SCI_REGTYPE, |
| 77 | SCIx_IRDA_REGTYPE, |
| 78 | SCIx_SCIFA_REGTYPE, |
| 79 | SCIx_SCIFB_REGTYPE, |
Phil Edworthy | 3af1f8a | 2011-10-03 15:16:47 +0100 | [diff] [blame] | 80 | SCIx_SH2_SCIF_FIFODATA_REGTYPE, |
Paul Mundt | 61a6976 | 2011-06-14 12:40:19 +0900 | [diff] [blame] | 81 | SCIx_SH3_SCIF_REGTYPE, |
| 82 | SCIx_SH4_SCIF_REGTYPE, |
| 83 | SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE, |
| 84 | SCIx_SH4_SCIF_FIFODATA_REGTYPE, |
| 85 | SCIx_SH7705_SCIF_REGTYPE, |
Ulrich Hecht | f303b36 | 2013-05-31 17:57:01 +0200 | [diff] [blame] | 86 | SCIx_HSCIF_REGTYPE, |
Paul Mundt | 61a6976 | 2011-06-14 12:40:19 +0900 | [diff] [blame] | 87 | |
| 88 | SCIx_NR_REGTYPES, |
| 89 | }; |
| 90 | |
Paul Mundt | 22cc837 | 2011-01-19 14:37:14 +0900 | [diff] [blame] | 91 | #define SCIx_IRQ_MUXED(irq) \ |
| 92 | { \ |
| 93 | [SCIx_ERI_IRQ] = (irq), \ |
| 94 | [SCIx_RXI_IRQ] = (irq), \ |
| 95 | [SCIx_TXI_IRQ] = (irq), \ |
| 96 | [SCIx_BRI_IRQ] = (irq), \ |
| 97 | } |
| 98 | |
Paul Mundt | 9174fc8 | 2011-06-28 15:25:36 +0900 | [diff] [blame] | 99 | #define SCIx_IRQ_IS_MUXED(port) \ |
Laurent Pinchart | 1fcc91a | 2013-12-06 10:59:16 +0100 | [diff] [blame] | 100 | ((port)->irqs[SCIx_ERI_IRQ] == \ |
| 101 | (port)->irqs[SCIx_RXI_IRQ]) || \ |
| 102 | ((port)->irqs[SCIx_ERI_IRQ] && \ |
| 103 | ((port)->irqs[SCIx_RXI_IRQ] < 0)) |
Paul Mundt | 61a6976 | 2011-06-14 12:40:19 +0900 | [diff] [blame] | 104 | /* |
| 105 | * SCI register subset common for all port types. |
| 106 | * Not all registers will exist on all parts. |
| 107 | */ |
| 108 | enum { |
| 109 | SCSMR, SCBRR, SCSCR, SCxSR, |
| 110 | SCFCR, SCFDR, SCxTDR, SCxRDR, |
| 111 | SCLSR, SCTFDR, SCRFDR, SCSPTR, |
Ulrich Hecht | f303b36 | 2013-05-31 17:57:01 +0200 | [diff] [blame] | 112 | HSSRR, |
Paul Mundt | 61a6976 | 2011-06-14 12:40:19 +0900 | [diff] [blame] | 113 | |
| 114 | SCIx_NR_REGS, |
| 115 | }; |
| 116 | |
Guennadi Liakhovetski | 73a19e4 | 2010-03-02 11:39:15 +0900 | [diff] [blame] | 117 | struct device; |
| 118 | |
Paul Mundt | 61a6976 | 2011-06-14 12:40:19 +0900 | [diff] [blame] | 119 | struct plat_sci_port_ops { |
| 120 | void (*init_pins)(struct uart_port *, unsigned int cflag); |
| 121 | }; |
| 122 | |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 123 | /* |
Paul Mundt | faf02f8 | 2011-12-02 17:44:50 +0900 | [diff] [blame] | 124 | * Port-specific capabilities |
| 125 | */ |
| 126 | #define SCIx_HAVE_RTSCTS (1 << 0) |
| 127 | |
| 128 | /* |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 129 | * Platform device specific platform_data struct |
| 130 | */ |
| 131 | struct plat_sci_port { |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 132 | unsigned long mapbase; /* resource base */ |
| 133 | unsigned int irqs[SCIx_NR_IRQS]; /* ERI, RXI, TXI, BRI */ |
Ulrich Hecht | f303b36 | 2013-05-31 17:57:01 +0200 | [diff] [blame] | 134 | unsigned int type; /* SCI / SCIF / IRDA / HSCIF */ |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 135 | upf_t flags; /* UPF_* flags */ |
Paul Mundt | faf02f8 | 2011-12-02 17:44:50 +0900 | [diff] [blame] | 136 | unsigned long capabilities; /* Port features/capabilities */ |
Paul Mundt | 00b9de9 | 2009-06-24 17:53:33 +0900 | [diff] [blame] | 137 | |
Laurent Pinchart | ec09c5e | 2013-12-06 10:59:20 +0100 | [diff] [blame^] | 138 | unsigned int sampling_rate; |
Paul Mundt | 26c92f3 | 2009-06-24 18:23:52 +0900 | [diff] [blame] | 139 | unsigned int scbrr_algo_id; /* SCBRR calculation algo */ |
Paul Mundt | 00b9de9 | 2009-06-24 17:53:33 +0900 | [diff] [blame] | 140 | unsigned int scscr; /* SCSCR initialization */ |
Paul Mundt | f43dc23 | 2011-01-13 15:06:28 +0900 | [diff] [blame] | 141 | |
Paul Mundt | debf950 | 2011-06-08 18:19:37 +0900 | [diff] [blame] | 142 | /* |
| 143 | * Platform overrides if necessary, defaults otherwise. |
| 144 | */ |
Paul Mundt | 514820e | 2011-06-08 18:51:32 +0900 | [diff] [blame] | 145 | int port_reg; |
Paul Mundt | 61a6976 | 2011-06-14 12:40:19 +0900 | [diff] [blame] | 146 | unsigned char regshift; |
| 147 | unsigned char regtype; |
| 148 | |
| 149 | struct plat_sci_port_ops *ops; |
Paul Mundt | 514820e | 2011-06-08 18:51:32 +0900 | [diff] [blame] | 150 | |
Paul Mundt | 27bd107 | 2011-01-19 15:37:31 +0900 | [diff] [blame] | 151 | unsigned int dma_slave_tx; |
| 152 | unsigned int dma_slave_rx; |
Paul Mundt | ecd9561 | 2006-09-27 17:32:30 +0900 | [diff] [blame] | 153 | }; |
| 154 | |
Paul Mundt | 96de1a8 | 2008-02-26 14:52:45 +0900 | [diff] [blame] | 155 | #endif /* __LINUX_SERIAL_SCI_H */ |