]>
Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
8348c259 | 2 | * pxa2xx_ssp.h |
1da177e4 LT |
3 | * |
4 | * Copyright (C) 2003 Russell King, All Rights Reserved. | |
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 version 2 as | |
8 | * published by the Free Software Foundation. | |
9 | * | |
10 | * This driver supports the following PXA CPU/SSP ports:- | |
11 | * | |
12 | * PXA250 SSP | |
13 | * PXA255 SSP, NSSP | |
14 | * PXA26x SSP, NSSP, ASSP | |
15 | * PXA27x SSP1, SSP2, SSP3 | |
88286450 | 16 | * PXA3xx SSP1, SSP2, SSP3, SSP4 |
1da177e4 LT |
17 | */ |
18 | ||
8348c259 SAS |
19 | #ifndef __LINUX_SSP_H |
20 | #define __LINUX_SSP_H | |
88286450 | 21 | |
22 | #include <linux/list.h> | |
63bef547 | 23 | #include <linux/io.h> |
6446221c DM |
24 | #include <linux/of.h> |
25 | ||
88286450 | 26 | |
83f28896 EM |
27 | /* |
28 | * SSP Serial Port Registers | |
29 | * PXA250, PXA255, PXA26x and PXA27x SSP controllers are all slightly different. | |
30 | * PXA255, PXA26x and PXA27x have extra ports, registers and bits. | |
31 | */ | |
32 | ||
33 | #define SSCR0 (0x00) /* SSP Control Register 0 */ | |
34 | #define SSCR1 (0x04) /* SSP Control Register 1 */ | |
35 | #define SSSR (0x08) /* SSP Status Register */ | |
36 | #define SSITR (0x0C) /* SSP Interrupt Test Register */ | |
37 | #define SSDR (0x10) /* SSP Data Write/Data Read Register */ | |
38 | ||
39 | #define SSTO (0x28) /* SSP Time Out Register */ | |
c4827bb8 | 40 | #define DDS_RATE (0x28) /* SSP DDS Clock Rate Register (Intel Quark) */ |
83f28896 EM |
41 | #define SSPSP (0x2C) /* SSP Programmable Serial Protocol */ |
42 | #define SSTSA (0x30) /* SSP Tx Timeslot Active */ | |
43 | #define SSRSA (0x34) /* SSP Rx Timeslot Active */ | |
44 | #define SSTSS (0x38) /* SSP Timeslot Status */ | |
45 | #define SSACD (0x3C) /* SSP Audio Clock Divider */ | |
83f28896 | 46 | #define SSACDD (0x40) /* SSP Audio Clock Dither Divider */ |
83f28896 EM |
47 | |
48 | /* Common PXA2xx bits first */ | |
49 | #define SSCR0_DSS (0x0000000f) /* Data Size Select (mask) */ | |
50 | #define SSCR0_DataSize(x) ((x) - 1) /* Data Size Select [4..16] */ | |
51 | #define SSCR0_FRF (0x00000030) /* FRame Format (mask) */ | |
52 | #define SSCR0_Motorola (0x0 << 4) /* Motorola's Serial Peripheral Interface (SPI) */ | |
53 | #define SSCR0_TI (0x1 << 4) /* Texas Instruments' Synchronous Serial Protocol (SSP) */ | |
54 | #define SSCR0_National (0x2 << 4) /* National Microwire */ | |
55 | #define SSCR0_ECS (1 << 6) /* External clock select */ | |
56 | #define SSCR0_SSE (1 << 7) /* Synchronous Serial Port Enable */ | |
57 | #define SSCR0_SCR(x) ((x) << 8) /* Serial Clock Rate (mask) */ | |
58 | ||
004690f0 | 59 | /* PXA27x, PXA3xx */ |
83f28896 EM |
60 | #define SSCR0_EDSS (1 << 20) /* Extended data size select */ |
61 | #define SSCR0_NCS (1 << 21) /* Network clock select */ | |
62 | #define SSCR0_RIM (1 << 22) /* Receive FIFO overrrun interrupt mask */ | |
63 | #define SSCR0_TUM (1 << 23) /* Transmit FIFO underrun interrupt mask */ | |
64 | #define SSCR0_FRDC (0x07000000) /* Frame rate divider control (mask) */ | |
65 | #define SSCR0_SlotsPerFrm(x) (((x) - 1) << 24) /* Time slots per frame [1..8] */ | |
004690f0 | 66 | #define SSCR0_FPCKE (1 << 29) /* FIFO packing enable */ |
83f28896 EM |
67 | #define SSCR0_ACS (1 << 30) /* Audio clock select */ |
68 | #define SSCR0_MOD (1 << 31) /* Mode (normal or network) */ | |
83f28896 | 69 | |
83f28896 EM |
70 | |
71 | #define SSCR1_RIE (1 << 0) /* Receive FIFO Interrupt Enable */ | |
72 | #define SSCR1_TIE (1 << 1) /* Transmit FIFO Interrupt Enable */ | |
73 | #define SSCR1_LBM (1 << 2) /* Loop-Back Mode */ | |
74 | #define SSCR1_SPO (1 << 3) /* Motorola SPI SSPSCLK polarity setting */ | |
75 | #define SSCR1_SPH (1 << 4) /* Motorola SPI SSPSCLK phase setting */ | |
76 | #define SSCR1_MWDS (1 << 5) /* Microwire Transmit Data Size */ | |
83f28896 | 77 | |
2a8626a9 | 78 | #define SSSR_ALT_FRM_MASK 3 /* Masks the SFRM signal number */ |
83f28896 EM |
79 | #define SSSR_TNF (1 << 2) /* Transmit FIFO Not Full */ |
80 | #define SSSR_RNE (1 << 3) /* Receive FIFO Not Empty */ | |
81 | #define SSSR_BSY (1 << 4) /* SSP Busy */ | |
82 | #define SSSR_TFS (1 << 5) /* Transmit FIFO Service Request */ | |
83 | #define SSSR_RFS (1 << 6) /* Receive FIFO Service Request */ | |
84 | #define SSSR_ROR (1 << 7) /* Receive FIFO Overrun */ | |
d0777f2c | 85 | |
d0777f2c SAS |
86 | #define RX_THRESH_DFLT 8 |
87 | #define TX_THRESH_DFLT 8 | |
88 | ||
89 | #define SSSR_TFL_MASK (0xf << 8) /* Transmit FIFO Level mask */ | |
90 | #define SSSR_RFL_MASK (0xf << 12) /* Receive FIFO Level mask */ | |
91 | ||
92 | #define SSCR1_TFT (0x000003c0) /* Transmit FIFO Threshold (mask) */ | |
63971c56 | 93 | #define SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..16] */ |
d0777f2c | 94 | #define SSCR1_RFT (0x00003c00) /* Receive FIFO Threshold (mask) */ |
63971c56 | 95 | #define SSCR1_RxTresh(x) (((x) - 1) << 10) /* level [1..16] */ |
d0777f2c | 96 | |
7c7289a4 AS |
97 | #define RX_THRESH_CE4100_DFLT 2 |
98 | #define TX_THRESH_CE4100_DFLT 2 | |
d0777f2c | 99 | |
7c7289a4 AS |
100 | #define CE4100_SSSR_TFL_MASK (0x3 << 8) /* Transmit FIFO Level mask */ |
101 | #define CE4100_SSSR_RFL_MASK (0x3 << 12) /* Receive FIFO Level mask */ | |
d0777f2c | 102 | |
7c7289a4 AS |
103 | #define CE4100_SSCR1_TFT (0x000000c0) /* Transmit FIFO Threshold (mask) */ |
104 | #define CE4100_SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..4] */ | |
105 | #define CE4100_SSCR1_RFT (0x00000c00) /* Receive FIFO Threshold (mask) */ | |
106 | #define CE4100_SSCR1_RxTresh(x) (((x) - 1) << 10) /* level [1..4] */ | |
83f28896 | 107 | |
e5262d05 | 108 | /* QUARK_X1000 SSCR0 bit definition */ |
63971c56 AS |
109 | #define QUARK_X1000_SSCR0_DSS (0x1F << 0) /* Data Size Select (mask) */ |
110 | #define QUARK_X1000_SSCR0_DataSize(x) ((x) - 1) /* Data Size Select [4..32] */ | |
111 | #define QUARK_X1000_SSCR0_FRF (0x3 << 5) /* FRame Format (mask) */ | |
e5262d05 WC |
112 | #define QUARK_X1000_SSCR0_Motorola (0x0 << 5) /* Motorola's Serial Peripheral Interface (SPI) */ |
113 | ||
114 | #define RX_THRESH_QUARK_X1000_DFLT 1 | |
115 | #define TX_THRESH_QUARK_X1000_DFLT 16 | |
116 | ||
117 | #define QUARK_X1000_SSSR_TFL_MASK (0x1F << 8) /* Transmit FIFO Level mask */ | |
118 | #define QUARK_X1000_SSSR_RFL_MASK (0x1F << 13) /* Receive FIFO Level mask */ | |
119 | ||
120 | #define QUARK_X1000_SSCR1_TFT (0x1F << 6) /* Transmit FIFO Threshold (mask) */ | |
121 | #define QUARK_X1000_SSCR1_TxTresh(x) (((x) - 1) << 6) /* level [1..32] */ | |
122 | #define QUARK_X1000_SSCR1_RFT (0x1F << 11) /* Receive FIFO Threshold (mask) */ | |
123 | #define QUARK_X1000_SSCR1_RxTresh(x) (((x) - 1) << 11) /* level [1..32] */ | |
63971c56 AS |
124 | #define QUARK_X1000_SSCR1_STRF (1 << 17) /* Select FIFO or EFWR */ |
125 | #define QUARK_X1000_SSCR1_EFWR (1 << 16) /* Enable FIFO Write/Read */ | |
e5262d05 | 126 | |
83f28896 EM |
127 | /* extra bits in PXA255, PXA26x and PXA27x SSP ports */ |
128 | #define SSCR0_TISSP (1 << 4) /* TI Sync Serial Protocol */ | |
129 | #define SSCR0_PSP (3 << 4) /* PSP - Programmable Serial Protocol */ | |
130 | #define SSCR1_TTELP (1 << 31) /* TXD Tristate Enable Last Phase */ | |
131 | #define SSCR1_TTE (1 << 30) /* TXD Tristate Enable */ | |
132 | #define SSCR1_EBCEI (1 << 29) /* Enable Bit Count Error interrupt */ | |
133 | #define SSCR1_SCFR (1 << 28) /* Slave Clock free Running */ | |
134 | #define SSCR1_ECRA (1 << 27) /* Enable Clock Request A */ | |
135 | #define SSCR1_ECRB (1 << 26) /* Enable Clock request B */ | |
136 | #define SSCR1_SCLKDIR (1 << 25) /* Serial Bit Rate Clock Direction */ | |
137 | #define SSCR1_SFRMDIR (1 << 24) /* Frame Direction */ | |
138 | #define SSCR1_RWOT (1 << 23) /* Receive Without Transmit */ | |
139 | #define SSCR1_TRAIL (1 << 22) /* Trailing Byte */ | |
140 | #define SSCR1_TSRE (1 << 21) /* Transmit Service Request Enable */ | |
141 | #define SSCR1_RSRE (1 << 20) /* Receive Service Request Enable */ | |
142 | #define SSCR1_TINTE (1 << 19) /* Receiver Time-out Interrupt enable */ | |
25985edc | 143 | #define SSCR1_PINTE (1 << 18) /* Peripheral Trailing Byte Interrupt Enable */ |
83f28896 EM |
144 | #define SSCR1_IFS (1 << 16) /* Invert Frame Signal */ |
145 | #define SSCR1_STRF (1 << 15) /* Select FIFO or EFWR */ | |
146 | #define SSCR1_EFWR (1 << 14) /* Enable FIFO Write/Read */ | |
147 | ||
148 | #define SSSR_BCE (1 << 23) /* Bit Count Error */ | |
149 | #define SSSR_CSS (1 << 22) /* Clock Synchronisation Status */ | |
150 | #define SSSR_TUR (1 << 21) /* Transmit FIFO Under Run */ | |
151 | #define SSSR_EOC (1 << 20) /* End Of Chain */ | |
152 | #define SSSR_TINT (1 << 19) /* Receiver Time-out Interrupt */ | |
153 | #define SSSR_PINT (1 << 18) /* Peripheral Trailing Byte Interrupt */ | |
154 | ||
83f28896 | 155 | |
83f28896 | 156 | #define SSPSP_SCMODE(x) ((x) << 0) /* Serial Bit Rate Clock Mode */ |
004690f0 HZ |
157 | #define SSPSP_SFRMP (1 << 2) /* Serial Frame Polarity */ |
158 | #define SSPSP_ETDS (1 << 3) /* End of Transfer data State */ | |
159 | #define SSPSP_STRTDLY(x) ((x) << 4) /* Start Delay */ | |
160 | #define SSPSP_DMYSTRT(x) ((x) << 7) /* Dummy Start */ | |
161 | #define SSPSP_SFRMDLY(x) ((x) << 9) /* Serial Frame Delay */ | |
162 | #define SSPSP_SFRMWDTH(x) ((x) << 16) /* Serial Frame Width */ | |
163 | #define SSPSP_DMYSTOP(x) ((x) << 23) /* Dummy Stop */ | |
164 | #define SSPSP_FSRT (1 << 25) /* Frame Sync Relative Timing */ | |
165 | ||
166 | /* PXA3xx */ | |
167 | #define SSPSP_EDMYSTRT(x) ((x) << 26) /* Extended Dummy Start */ | |
168 | #define SSPSP_EDMYSTOP(x) ((x) << 28) /* Extended Dummy Stop */ | |
169 | #define SSPSP_TIMING_MASK (0x7f8001f0) | |
83f28896 EM |
170 | |
171 | #define SSACD_SCDB (1 << 3) /* SSPSYSCLK Divider Bypass */ | |
172 | #define SSACD_ACPS(x) ((x) << 4) /* Audio clock PLL select */ | |
173 | #define SSACD_ACDS(x) ((x) << 0) /* Audio clock divider select */ | |
05739375 DM |
174 | #define SSACD_ACDS_1 (0) |
175 | #define SSACD_ACDS_2 (1) | |
176 | #define SSACD_ACDS_4 (2) | |
177 | #define SSACD_ACDS_8 (3) | |
178 | #define SSACD_ACDS_16 (4) | |
179 | #define SSACD_ACDS_32 (5) | |
180 | #define SSACD_SCDB_4X (0) | |
181 | #define SSACD_SCDB_1X (1) | |
83f28896 | 182 | #define SSACD_SCDX8 (1 << 7) /* SYSCLK division ratio select */ |
83f28896 | 183 | |
a0d2642e MW |
184 | /* LPSS SSP */ |
185 | #define SSITF 0x44 /* TX FIFO trigger level */ | |
186 | #define SSITF_TxLoThresh(x) (((x) - 1) << 8) | |
187 | #define SSITF_TxHiThresh(x) ((x) - 1) | |
188 | ||
189 | #define SSIRF 0x48 /* RX FIFO trigger level */ | |
190 | #define SSIRF_RxThresh(x) ((x) - 1) | |
191 | ||
88286450 | 192 | enum pxa_ssp_type { |
193 | SSP_UNDEFINED = 0, | |
194 | PXA25x_SSP, /* pxa 210, 250, 255, 26x */ | |
195 | PXA25x_NSSP, /* pxa 255, 26x (including ASSP) */ | |
196 | PXA27x_SSP, | |
972a55b6 | 197 | PXA3xx_SSP, |
7e499228 | 198 | PXA168_SSP, |
87ae1d2d | 199 | MMP2_SSP, |
60172215 | 200 | PXA910_SSP, |
2a8626a9 | 201 | CE4100_SSP, |
e5262d05 | 202 | QUARK_X1000_SSP, |
dccf7369 | 203 | LPSS_LPT_SSP, /* Keep LPSS types sorted with lpss_platforms[] */ |
03fbf488 | 204 | LPSS_BYT_SSP, |
30f3a6ab | 205 | LPSS_BSW_SSP, |
34cadd9c | 206 | LPSS_SPT_SSP, |
b7c08cf8 | 207 | LPSS_BXT_SSP, |
fc0b2acc | 208 | LPSS_CNL_SSP, |
88286450 | 209 | }; |
210 | ||
211 | struct ssp_device { | |
212 | struct platform_device *pdev; | |
213 | struct list_head node; | |
214 | ||
215 | struct clk *clk; | |
216 | void __iomem *mmio_base; | |
217 | unsigned long phys_base; | |
218 | ||
219 | const char *label; | |
220 | int port_id; | |
55ef8262 | 221 | enum pxa_ssp_type type; |
88286450 | 222 | int use_count; |
223 | int irq; | |
6446221c DM |
224 | |
225 | struct device_node *of_node; | |
88286450 | 226 | }; |
1da177e4 | 227 | |
63bef547 | 228 | /** |
baffe169 | 229 | * pxa_ssp_write_reg - Write to a SSP register |
63bef547 MB |
230 | * |
231 | * @dev: SSP device to access | |
232 | * @reg: Register to write to | |
233 | * @val: Value to be written. | |
234 | */ | |
baffe169 | 235 | static inline void pxa_ssp_write_reg(struct ssp_device *dev, u32 reg, u32 val) |
63bef547 MB |
236 | { |
237 | __raw_writel(val, dev->mmio_base + reg); | |
238 | } | |
239 | ||
240 | /** | |
baffe169 | 241 | * pxa_ssp_read_reg - Read from a SSP register |
63bef547 MB |
242 | * |
243 | * @dev: SSP device to access | |
244 | * @reg: Register to read from | |
245 | */ | |
baffe169 | 246 | static inline u32 pxa_ssp_read_reg(struct ssp_device *dev, u32 reg) |
63bef547 MB |
247 | { |
248 | return __raw_readl(dev->mmio_base + reg); | |
249 | } | |
250 | ||
1ced9a5b | 251 | #if IS_ENABLED(CONFIG_PXA_SSP) |
baffe169 HZ |
252 | struct ssp_device *pxa_ssp_request(int port, const char *label); |
253 | void pxa_ssp_free(struct ssp_device *); | |
6446221c DM |
254 | struct ssp_device *pxa_ssp_request_of(const struct device_node *of_node, |
255 | const char *label); | |
851bacf5 MW |
256 | #else |
257 | static inline struct ssp_device *pxa_ssp_request(int port, const char *label) | |
258 | { | |
259 | return NULL; | |
260 | } | |
6446221c DM |
261 | static inline struct ssp_device *pxa_ssp_request_of(const struct device_node *n, |
262 | const char *name) | |
263 | { | |
264 | return NULL; | |
265 | } | |
851bacf5 MW |
266 | static inline void pxa_ssp_free(struct ssp_device *ssp) {} |
267 | #endif | |
268 | ||
8348c259 | 269 | #endif |