2 * arch/arm/plat-omap/include/mach/mcbsp.h
4 * Defines for Multi-Channel Buffered Serial Port
6 * Copyright (C) 2002 RidgeRun, Inc.
7 * Author: Steve Johnson
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #ifndef __ASM_ARCH_OMAP_MCBSP_H
25 #define __ASM_ARCH_OMAP_MCBSP_H
27 #include <linux/completion.h>
28 #include <linux/spinlock.h>
30 #include <mach/hardware.h>
31 #include <plat/clock.h>
33 #define OMAP7XX_MCBSP1_BASE 0xfffb1000
34 #define OMAP7XX_MCBSP2_BASE 0xfffb1800
36 #define OMAP1510_MCBSP1_BASE 0xe1011800
37 #define OMAP1510_MCBSP2_BASE 0xfffb1000
38 #define OMAP1510_MCBSP3_BASE 0xe1017000
40 #define OMAP1610_MCBSP1_BASE 0xe1011800
41 #define OMAP1610_MCBSP2_BASE 0xfffb1000
42 #define OMAP1610_MCBSP3_BASE 0xe1017000
44 #define OMAP24XX_MCBSP1_BASE 0x48074000
45 #define OMAP24XX_MCBSP2_BASE 0x48076000
46 #define OMAP2430_MCBSP3_BASE 0x4808c000
47 #define OMAP2430_MCBSP4_BASE 0x4808e000
48 #define OMAP2430_MCBSP5_BASE 0x48096000
50 #define OMAP34XX_MCBSP1_BASE 0x48074000
51 #define OMAP34XX_MCBSP2_BASE 0x49022000
52 #define OMAP34XX_MCBSP3_BASE 0x49024000
53 #define OMAP34XX_MCBSP4_BASE 0x49026000
54 #define OMAP34XX_MCBSP5_BASE 0x48096000
56 #define OMAP44XX_MCBSP1_BASE 0x49022000
57 #define OMAP44XX_MCBSP2_BASE 0x49024000
58 #define OMAP44XX_MCBSP3_BASE 0x49026000
59 #define OMAP44XX_MCBSP4_BASE 0x48074000
61 #if defined(CONFIG_ARCH_OMAP15XX) || defined(CONFIG_ARCH_OMAP16XX) || defined(CONFIG_ARCH_OMAP730) || defined(CONFIG_ARCH_OMAP850)
63 #define OMAP_MCBSP_REG_DRR2 0x00
64 #define OMAP_MCBSP_REG_DRR1 0x02
65 #define OMAP_MCBSP_REG_DXR2 0x04
66 #define OMAP_MCBSP_REG_DXR1 0x06
67 #define OMAP_MCBSP_REG_SPCR2 0x08
68 #define OMAP_MCBSP_REG_SPCR1 0x0a
69 #define OMAP_MCBSP_REG_RCR2 0x0c
70 #define OMAP_MCBSP_REG_RCR1 0x0e
71 #define OMAP_MCBSP_REG_XCR2 0x10
72 #define OMAP_MCBSP_REG_XCR1 0x12
73 #define OMAP_MCBSP_REG_SRGR2 0x14
74 #define OMAP_MCBSP_REG_SRGR1 0x16
75 #define OMAP_MCBSP_REG_MCR2 0x18
76 #define OMAP_MCBSP_REG_MCR1 0x1a
77 #define OMAP_MCBSP_REG_RCERA 0x1c
78 #define OMAP_MCBSP_REG_RCERB 0x1e
79 #define OMAP_MCBSP_REG_XCERA 0x20
80 #define OMAP_MCBSP_REG_XCERB 0x22
81 #define OMAP_MCBSP_REG_PCR0 0x24
82 #define OMAP_MCBSP_REG_RCERC 0x26
83 #define OMAP_MCBSP_REG_RCERD 0x28
84 #define OMAP_MCBSP_REG_XCERC 0x2A
85 #define OMAP_MCBSP_REG_XCERD 0x2C
86 #define OMAP_MCBSP_REG_RCERE 0x2E
87 #define OMAP_MCBSP_REG_RCERF 0x30
88 #define OMAP_MCBSP_REG_XCERE 0x32
89 #define OMAP_MCBSP_REG_XCERF 0x34
90 #define OMAP_MCBSP_REG_RCERG 0x36
91 #define OMAP_MCBSP_REG_RCERH 0x38
92 #define OMAP_MCBSP_REG_XCERG 0x3A
93 #define OMAP_MCBSP_REG_XCERH 0x3C
95 /* Dummy defines, these are not available on omap1 */
96 #define OMAP_MCBSP_REG_XCCR 0x00
97 #define OMAP_MCBSP_REG_RCCR 0x00
99 #define AUDIO_MCBSP_DATAWRITE (OMAP1510_MCBSP1_BASE + OMAP_MCBSP_REG_DXR1)
100 #define AUDIO_MCBSP_DATAREAD (OMAP1510_MCBSP1_BASE + OMAP_MCBSP_REG_DRR1)
102 #define AUDIO_MCBSP OMAP_MCBSP1
103 #define AUDIO_DMA_TX OMAP_DMA_MCBSP1_TX
104 #define AUDIO_DMA_RX OMAP_DMA_MCBSP1_RX
108 #define OMAP_MCBSP_REG_DRR2 0x00
109 #define OMAP_MCBSP_REG_DRR1 0x04
110 #define OMAP_MCBSP_REG_DXR2 0x08
111 #define OMAP_MCBSP_REG_DXR1 0x0C
112 #define OMAP_MCBSP_REG_DRR 0x00
113 #define OMAP_MCBSP_REG_DXR 0x08
114 #define OMAP_MCBSP_REG_SPCR2 0x10
115 #define OMAP_MCBSP_REG_SPCR1 0x14
116 #define OMAP_MCBSP_REG_RCR2 0x18
117 #define OMAP_MCBSP_REG_RCR1 0x1C
118 #define OMAP_MCBSP_REG_XCR2 0x20
119 #define OMAP_MCBSP_REG_XCR1 0x24
120 #define OMAP_MCBSP_REG_SRGR2 0x28
121 #define OMAP_MCBSP_REG_SRGR1 0x2C
122 #define OMAP_MCBSP_REG_MCR2 0x30
123 #define OMAP_MCBSP_REG_MCR1 0x34
124 #define OMAP_MCBSP_REG_RCERA 0x38
125 #define OMAP_MCBSP_REG_RCERB 0x3C
126 #define OMAP_MCBSP_REG_XCERA 0x40
127 #define OMAP_MCBSP_REG_XCERB 0x44
128 #define OMAP_MCBSP_REG_PCR0 0x48
129 #define OMAP_MCBSP_REG_RCERC 0x4C
130 #define OMAP_MCBSP_REG_RCERD 0x50
131 #define OMAP_MCBSP_REG_XCERC 0x54
132 #define OMAP_MCBSP_REG_XCERD 0x58
133 #define OMAP_MCBSP_REG_RCERE 0x5C
134 #define OMAP_MCBSP_REG_RCERF 0x60
135 #define OMAP_MCBSP_REG_XCERE 0x64
136 #define OMAP_MCBSP_REG_XCERF 0x68
137 #define OMAP_MCBSP_REG_RCERG 0x6C
138 #define OMAP_MCBSP_REG_RCERH 0x70
139 #define OMAP_MCBSP_REG_XCERG 0x74
140 #define OMAP_MCBSP_REG_XCERH 0x78
141 #define OMAP_MCBSP_REG_SYSCON 0x8C
142 #define OMAP_MCBSP_REG_THRSH2 0x90
143 #define OMAP_MCBSP_REG_THRSH1 0x94
144 #define OMAP_MCBSP_REG_IRQST 0xA0
145 #define OMAP_MCBSP_REG_IRQEN 0xA4
146 #define OMAP_MCBSP_REG_WAKEUPEN 0xA8
147 #define OMAP_MCBSP_REG_XCCR 0xAC
148 #define OMAP_MCBSP_REG_RCCR 0xB0
150 #define AUDIO_MCBSP_DATAWRITE (OMAP24XX_MCBSP2_BASE + OMAP_MCBSP_REG_DXR1)
151 #define AUDIO_MCBSP_DATAREAD (OMAP24XX_MCBSP2_BASE + OMAP_MCBSP_REG_DRR1)
153 #define AUDIO_MCBSP OMAP_MCBSP2
154 #define AUDIO_DMA_TX OMAP24XX_DMA_MCBSP2_TX
155 #define AUDIO_DMA_RX OMAP24XX_DMA_MCBSP2_RX
159 /************************** McBSP SPCR1 bit definitions ***********************/
163 #define RSYNC_ERR 0x0008
164 #define RINTM(value) ((value)<<4) /* bits 4:5 */
167 #define CLKSTP(value) ((value)<<11) /* bits 11:12 */
168 #define RJUST(value) ((value)<<13) /* bits 13:14 */
172 /************************** McBSP SPCR2 bit definitions ***********************/
175 #define XEMPTY 0x0004
176 #define XSYNC_ERR 0x0008
177 #define XINTM(value) ((value)<<4) /* bits 4:5 */
183 /************************** McBSP PCR bit definitions *************************/
188 #define DR_STAT 0x0010
189 #define DX_STAT 0x0020
190 #define CLKS_STAT 0x0040
191 #define SCLKME 0x0080
198 #define IDLE_EN 0x4000
200 /************************** McBSP RCR1 bit definitions ************************/
201 #define RWDLEN1(value) ((value)<<5) /* Bits 5:7 */
202 #define RFRLEN1(value) ((value)<<8) /* Bits 8:14 */
204 /************************** McBSP XCR1 bit definitions ************************/
205 #define XWDLEN1(value) ((value)<<5) /* Bits 5:7 */
206 #define XFRLEN1(value) ((value)<<8) /* Bits 8:14 */
208 /*************************** McBSP RCR2 bit definitions ***********************/
209 #define RDATDLY(value) (value) /* Bits 0:1 */
211 #define RCOMPAND(value) ((value)<<3) /* Bits 3:4 */
212 #define RWDLEN2(value) ((value)<<5) /* Bits 5:7 */
213 #define RFRLEN2(value) ((value)<<8) /* Bits 8:14 */
214 #define RPHASE 0x8000
216 /*************************** McBSP XCR2 bit definitions ***********************/
217 #define XDATDLY(value) (value) /* Bits 0:1 */
219 #define XCOMPAND(value) ((value)<<3) /* Bits 3:4 */
220 #define XWDLEN2(value) ((value)<<5) /* Bits 5:7 */
221 #define XFRLEN2(value) ((value)<<8) /* Bits 8:14 */
222 #define XPHASE 0x8000
224 /************************* McBSP SRGR1 bit definitions ************************/
225 #define CLKGDV(value) (value) /* Bits 0:7 */
226 #define FWID(value) ((value)<<8) /* Bits 8:15 */
228 /************************* McBSP SRGR2 bit definitions ************************/
229 #define FPER(value) (value) /* Bits 0:11 */
235 /************************* McBSP MCR1 bit definitions *************************/
237 #define RCBLK(value) ((value)<<2) /* Bits 2:4 */
238 #define RPABLK(value) ((value)<<5) /* Bits 5:6 */
239 #define RPBBLK(value) ((value)<<7) /* Bits 7:8 */
241 /************************* McBSP MCR2 bit definitions *************************/
242 #define XMCM(value) (value) /* Bits 0:1 */
243 #define XCBLK(value) ((value)<<2) /* Bits 2:4 */
244 #define XPABLK(value) ((value)<<5) /* Bits 5:6 */
245 #define XPBBLK(value) ((value)<<7) /* Bits 7:8 */
247 /*********************** McBSP XCCR bit definitions *************************/
248 #define EXTCLKGATE 0x8000
249 #define PPCONNECT 0x4000
250 #define DXENDLY(value) ((value)<<12) /* Bits 12:13 */
251 #define XFULL_CYCLE 0x0800
253 #define XDMAEN 0x0008
254 #define XDISABLE 0x0001
256 /********************** McBSP RCCR bit definitions *************************/
257 #define RFULL_CYCLE 0x0800
258 #define RDMAEN 0x0008
259 #define RDISABLE 0x0001
261 /********************** McBSP SYSCONFIG bit definitions ********************/
262 #define CLOCKACTIVITY(value) ((value)<<8)
263 #define SIDLEMODE(value) ((value)<<3)
264 #define ENAWAKEUP 0x0004
265 #define SOFTRST 0x0002
267 /********************** McBSP DMA operating modes **************************/
268 #define MCBSP_DMA_MODE_ELEMENT 0
269 #define MCBSP_DMA_MODE_THRESHOLD 1
270 #define MCBSP_DMA_MODE_FRAME 2
272 /********************** McBSP WAKEUPEN bit definitions *********************/
273 #define XEMPTYEOFEN 0x4000
274 #define XRDYEN 0x0400
275 #define XEOFEN 0x0200
276 #define XFSXEN 0x0100
277 #define XSYNCERREN 0x0080
278 #define RRDYEN 0x0008
279 #define REOFEN 0x0004
280 #define RFSREN 0x0002
281 #define RSYNCERREN 0x0001
283 /* we don't do multichannel for now */
284 struct omap_mcbsp_reg_cfg {
320 typedef int __bitwise omap_mcbsp_io_type_t;
321 #define OMAP_MCBSP_IRQ_IO ((__force omap_mcbsp_io_type_t) 1)
322 #define OMAP_MCBSP_POLL_IO ((__force omap_mcbsp_io_type_t) 2)
325 OMAP_MCBSP_WORD_8 = 0,
331 } omap_mcbsp_word_length;
334 OMAP_MCBSP_CLK_RISING = 0,
335 OMAP_MCBSP_CLK_FALLING,
336 } omap_mcbsp_clk_polarity;
339 OMAP_MCBSP_FS_ACTIVE_HIGH = 0,
340 OMAP_MCBSP_FS_ACTIVE_LOW,
341 } omap_mcbsp_fs_polarity;
344 OMAP_MCBSP_CLK_STP_MODE_NO_DELAY = 0,
345 OMAP_MCBSP_CLK_STP_MODE_DELAY,
346 } omap_mcbsp_clk_stp_mode;
349 /******* SPI specific mode **********/
351 OMAP_MCBSP_SPI_MASTER = 0,
352 OMAP_MCBSP_SPI_SLAVE,
353 } omap_mcbsp_spi_mode;
355 struct omap_mcbsp_spi_cfg {
356 omap_mcbsp_spi_mode spi_mode;
357 omap_mcbsp_clk_polarity rx_clock_polarity;
358 omap_mcbsp_clk_polarity tx_clock_polarity;
359 omap_mcbsp_fs_polarity fsx_polarity;
361 omap_mcbsp_clk_stp_mode clk_stp_mode;
362 omap_mcbsp_word_length word_length;
365 /* Platform specific configuration */
366 struct omap_mcbsp_ops {
367 void (*request)(unsigned int);
368 void (*free)(unsigned int);
371 struct omap_mcbsp_platform_data {
372 unsigned long phys_base;
373 u8 dma_rx_sync, dma_tx_sync;
375 struct omap_mcbsp_ops *ops;
376 #ifdef CONFIG_ARCH_OMAP3
383 unsigned long phys_base;
384 void __iomem *io_base;
387 omap_mcbsp_word_length rx_word_length;
388 omap_mcbsp_word_length tx_word_length;
390 omap_mcbsp_io_type_t io_type; /* IRQ or poll */
391 /* IRQ based TX/RX */
401 /* Completion queues */
402 struct completion tx_irq_completion;
403 struct completion rx_irq_completion;
404 struct completion tx_dma_completion;
405 struct completion rx_dma_completion;
407 /* Protect the field .free, while checking if the mcbsp is in use */
409 struct omap_mcbsp_platform_data *pdata;
412 #ifdef CONFIG_ARCH_OMAP3
418 extern struct omap_mcbsp **mcbsp_ptr;
419 extern int omap_mcbsp_count;
421 int omap_mcbsp_init(void);
422 void omap_mcbsp_register_board_cfg(struct omap_mcbsp_platform_data *config,
424 void omap_mcbsp_config(unsigned int id, const struct omap_mcbsp_reg_cfg * config);
425 #ifdef CONFIG_ARCH_OMAP3
426 void omap_mcbsp_set_tx_threshold(unsigned int id, u16 threshold);
427 void omap_mcbsp_set_rx_threshold(unsigned int id, u16 threshold);
428 u16 omap_mcbsp_get_max_tx_threshold(unsigned int id);
429 u16 omap_mcbsp_get_max_rx_threshold(unsigned int id);
430 int omap_mcbsp_get_dma_op_mode(unsigned int id);
432 static inline void omap_mcbsp_set_tx_threshold(unsigned int id, u16 threshold)
434 static inline void omap_mcbsp_set_rx_threshold(unsigned int id, u16 threshold)
436 static inline u16 omap_mcbsp_get_max_tx_threshold(unsigned int id) { return 0; }
437 static inline u16 omap_mcbsp_get_max_rx_threshold(unsigned int id) { return 0; }
438 static inline int omap_mcbsp_get_dma_op_mode(unsigned int id) { return 0; }
440 int omap_mcbsp_request(unsigned int id);
441 void omap_mcbsp_free(unsigned int id);
442 void omap_mcbsp_start(unsigned int id, int tx, int rx);
443 void omap_mcbsp_stop(unsigned int id, int tx, int rx);
444 void omap_mcbsp_xmit_word(unsigned int id, u32 word);
445 u32 omap_mcbsp_recv_word(unsigned int id);
447 int omap_mcbsp_xmit_buffer(unsigned int id, dma_addr_t buffer, unsigned int length);
448 int omap_mcbsp_recv_buffer(unsigned int id, dma_addr_t buffer, unsigned int length);
449 int omap_mcbsp_spi_master_xmit_word_poll(unsigned int id, u32 word);
450 int omap_mcbsp_spi_master_recv_word_poll(unsigned int id, u32 * word);
453 /* SPI specific API */
454 void omap_mcbsp_set_spi_mode(unsigned int id, const struct omap_mcbsp_spi_cfg * spi_cfg);
456 /* Polled read/write functions */
457 int omap_mcbsp_pollread(unsigned int id, u16 * buf);
458 int omap_mcbsp_pollwrite(unsigned int id, u16 buf);
459 int omap_mcbsp_set_io_type(unsigned int id, omap_mcbsp_io_type_t io_type);