arch/arm/plat-omap/include/mach/mcbsp.h

   1 /*
   2  * arch/arm/plat-omap/include/mach/mcbsp.h
   3  *
   4  * Defines for Multi-Channel Buffered Serial Port
   5  *
   6  * Copyright (C) 2002 RidgeRun, Inc.
   7  * Author: Steve Johnson
   8  *
   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.
  13  *
  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.
  18  *
  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
  22  *
  23  */
  24 #ifndef __ASM_ARCH_OMAP_MCBSP_H
  25 #define __ASM_ARCH_OMAP_MCBSP_H
  26
  27 #include <linux/completion.h>
  28 #include <linux/spinlock.h>
  29
  30 #include <mach/hardware.h>
  31 #include <mach/clock.h>
  32
  33 #define OMAP730_MCBSP1_BASE     0xfffb1000
  34 #define OMAP730_MCBSP2_BASE     0xfffb1800
  35
  36 #define OMAP1510_MCBSP1_BASE    0xe1011800
  37 #define OMAP1510_MCBSP2_BASE    0xfffb1000
  38 #define OMAP1510_MCBSP3_BASE    0xe1017000
  39
  40 #define OMAP1610_MCBSP1_BASE    0xe1011800
  41 #define OMAP1610_MCBSP2_BASE    0xfffb1000
  42 #define OMAP1610_MCBSP3_BASE    0xe1017000
  43
  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
  49
  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
  55
  56 #if defined(CONFIG_ARCH_OMAP15XX) || defined(CONFIG_ARCH_OMAP16XX) || defined(CONFIG_ARCH_OMAP730)
  57
  58 #define OMAP_MCBSP_REG_DRR2     0x00
  59 #define OMAP_MCBSP_REG_DRR1     0x02
  60 #define OMAP_MCBSP_REG_DXR2     0x04
  61 #define OMAP_MCBSP_REG_DXR1     0x06
  62 #define OMAP_MCBSP_REG_SPCR2    0x08
  63 #define OMAP_MCBSP_REG_SPCR1    0x0a
  64 #define OMAP_MCBSP_REG_RCR2     0x0c
  65 #define OMAP_MCBSP_REG_RCR1     0x0e
  66 #define OMAP_MCBSP_REG_XCR2     0x10
  67 #define OMAP_MCBSP_REG_XCR1     0x12
  68 #define OMAP_MCBSP_REG_SRGR2    0x14
  69 #define OMAP_MCBSP_REG_SRGR1    0x16
  70 #define OMAP_MCBSP_REG_MCR2     0x18
  71 #define OMAP_MCBSP_REG_MCR1     0x1a
  72 #define OMAP_MCBSP_REG_RCERA    0x1c
  73 #define OMAP_MCBSP_REG_RCERB    0x1e
  74 #define OMAP_MCBSP_REG_XCERA    0x20
  75 #define OMAP_MCBSP_REG_XCERB    0x22
  76 #define OMAP_MCBSP_REG_PCR0     0x24
  77 #define OMAP_MCBSP_REG_RCERC    0x26
  78 #define OMAP_MCBSP_REG_RCERD    0x28
  79 #define OMAP_MCBSP_REG_XCERC    0x2A
  80 #define OMAP_MCBSP_REG_XCERD    0x2C
  81 #define OMAP_MCBSP_REG_RCERE    0x2E
  82 #define OMAP_MCBSP_REG_RCERF    0x30
  83 #define OMAP_MCBSP_REG_XCERE    0x32
  84 #define OMAP_MCBSP_REG_XCERF    0x34
  85 #define OMAP_MCBSP_REG_RCERG    0x36
  86 #define OMAP_MCBSP_REG_RCERH    0x38
  87 #define OMAP_MCBSP_REG_XCERG    0x3A
  88 #define OMAP_MCBSP_REG_XCERH    0x3C
  89
  90 /* Dummy defines, these are not available on omap1 */
  91 #define OMAP_MCBSP_REG_XCCR     0x00
  92 #define OMAP_MCBSP_REG_RCCR     0x00
  93 #define OMAP_MCBSP_REG_SYSCON   0x00
  94 #define OMAP_MCBSP_REG_WAKEUPEN 0x00
  95
  96 #define AUDIO_MCBSP_DATAWRITE   (OMAP1510_MCBSP1_BASE + OMAP_MCBSP_REG_DXR1)
  97 #define AUDIO_MCBSP_DATAREAD    (OMAP1510_MCBSP1_BASE + OMAP_MCBSP_REG_DRR1)
  98
  99 #define AUDIO_MCBSP             OMAP_MCBSP1
 100 #define AUDIO_DMA_TX            OMAP_DMA_MCBSP1_TX
 101 #define AUDIO_DMA_RX            OMAP_DMA_MCBSP1_RX
 102
 103 #elif defined(CONFIG_ARCH_OMAP24XX) || defined(CONFIG_ARCH_OMAP34XX)
 104
 105 #define OMAP_MCBSP_REG_DRR2     0x00
 106 #define OMAP_MCBSP_REG_DRR1     0x04
 107 #define OMAP_MCBSP_REG_DXR2     0x08
 108 #define OMAP_MCBSP_REG_DXR1     0x0C
 109 #define OMAP_MCBSP_REG_DRR      0x00
 110 #define OMAP_MCBSP_REG_DXR      0x08
 111 #define OMAP_MCBSP_REG_SPCR2    0x10
 112 #define OMAP_MCBSP_REG_SPCR1    0x14
 113 #define OMAP_MCBSP_REG_RCR2     0x18
 114 #define OMAP_MCBSP_REG_RCR1     0x1C
 115 #define OMAP_MCBSP_REG_XCR2     0x20
 116 #define OMAP_MCBSP_REG_XCR1     0x24
 117 #define OMAP_MCBSP_REG_SRGR2    0x28
 118 #define OMAP_MCBSP_REG_SRGR1    0x2C
 119 #define OMAP_MCBSP_REG_MCR2     0x30
 120 #define OMAP_MCBSP_REG_MCR1     0x34
 121 #define OMAP_MCBSP_REG_RCERA    0x38
 122 #define OMAP_MCBSP_REG_RCERB    0x3C
 123 #define OMAP_MCBSP_REG_XCERA    0x40
 124 #define OMAP_MCBSP_REG_XCERB    0x44
 125 #define OMAP_MCBSP_REG_PCR0     0x48
 126 #define OMAP_MCBSP_REG_RCERC    0x4C
 127 #define OMAP_MCBSP_REG_RCERD    0x50
 128 #define OMAP_MCBSP_REG_XCERC    0x54
 129 #define OMAP_MCBSP_REG_XCERD    0x58
 130 #define OMAP_MCBSP_REG_RCERE    0x5C
 131 #define OMAP_MCBSP_REG_RCERF    0x60
 132 #define OMAP_MCBSP_REG_XCERE    0x64
 133 #define OMAP_MCBSP_REG_XCERF    0x68
 134 #define OMAP_MCBSP_REG_RCERG    0x6C
 135 #define OMAP_MCBSP_REG_RCERH    0x70
 136 #define OMAP_MCBSP_REG_XCERG    0x74
 137 #define OMAP_MCBSP_REG_XCERH    0x78
 138 #define OMAP_MCBSP_REG_SYSCON   0x8C
 139 #define OMAP_MCBSP_REG_WAKEUPEN 0xA8
 140 #define OMAP_MCBSP_REG_XCCR     0xAC
 141 #define OMAP_MCBSP_REG_RCCR     0xB0
 142
 143 #define AUDIO_MCBSP_DATAWRITE   (OMAP24XX_MCBSP2_BASE + OMAP_MCBSP_REG_DXR1)
 144 #define AUDIO_MCBSP_DATAREAD    (OMAP24XX_MCBSP2_BASE + OMAP_MCBSP_REG_DRR1)
 145
 146 #define AUDIO_MCBSP             OMAP_MCBSP2
 147 #define AUDIO_DMA_TX            OMAP24XX_DMA_MCBSP2_TX
 148 #define AUDIO_DMA_RX            OMAP24XX_DMA_MCBSP2_RX
 149
 150 #endif
 151
 152 /************************** McBSP SPCR1 bit definitions ***********************/
 153 #define RRST                    0x0001
 154 #define RRDY                    0x0002
 155 #define RFULL                   0x0004
 156 #define RSYNC_ERR               0x0008
 157 #define RINTM(value)            ((value)<<4)    /* bits 4:5 */
 158 #define ABIS                    0x0040
 159 #define DXENA                   0x0080
 160 #define CLKSTP(value)           ((value)<<11)   /* bits 11:12 */
 161 #define RJUST(value)            ((value)<<13)   /* bits 13:14 */
 162 #define ALB                     0x8000
 163 #define DLB                     0x8000
 164
 165 /************************** McBSP SPCR2 bit definitions ***********************/
 166 #define XRST            0x0001
 167 #define XRDY            0x0002
 168 #define XEMPTY          0x0004
 169 #define XSYNC_ERR       0x0008
 170 #define XINTM(value)    ((value)<<4)            /* bits 4:5 */
 171 #define GRST            0x0040
 172 #define FRST            0x0080
 173 #define SOFT            0x0100
 174 #define FREE            0x0200
 175
 176 /************************** McBSP PCR bit definitions *************************/
 177 #define CLKRP           0x0001
 178 #define CLKXP           0x0002
 179 #define FSRP            0x0004
 180 #define FSXP            0x0008
 181 #define DR_STAT         0x0010
 182 #define DX_STAT         0x0020
 183 #define CLKS_STAT       0x0040
 184 #define SCLKME          0x0080
 185 #define CLKRM           0x0100
 186 #define CLKXM           0x0200
 187 #define FSRM            0x0400
 188 #define FSXM            0x0800
 189 #define RIOEN           0x1000
 190 #define XIOEN           0x2000
 191 #define IDLE_EN         0x4000
 192
 193 /************************** McBSP RCR1 bit definitions ************************/
 194 #define RWDLEN1(value)          ((value)<<5)    /* Bits 5:7 */
 195 #define RFRLEN1(value)          ((value)<<8)    /* Bits 8:14 */
 196
 197 /************************** McBSP XCR1 bit definitions ************************/
 198 #define XWDLEN1(value)          ((value)<<5)    /* Bits 5:7 */
 199 #define XFRLEN1(value)          ((value)<<8)    /* Bits 8:14 */
 200
 201 /*************************** McBSP RCR2 bit definitions ***********************/
 202 #define RDATDLY(value)          (value)         /* Bits 0:1 */
 203 #define RFIG                    0x0004
 204 #define RCOMPAND(value)         ((value)<<3)    /* Bits 3:4 */
 205 #define RWDLEN2(value)          ((value)<<5)    /* Bits 5:7 */
 206 #define RFRLEN2(value)          ((value)<<8)    /* Bits 8:14 */
 207 #define RPHASE                  0x8000
 208
 209 /*************************** McBSP XCR2 bit definitions ***********************/
 210 #define XDATDLY(value)          (value)         /* Bits 0:1 */
 211 #define XFIG                    0x0004
 212 #define XCOMPAND(value)         ((value)<<3)    /* Bits 3:4 */
 213 #define XWDLEN2(value)          ((value)<<5)    /* Bits 5:7 */
 214 #define XFRLEN2(value)          ((value)<<8)    /* Bits 8:14 */
 215 #define XPHASE                  0x8000
 216
 217 /************************* McBSP SRGR1 bit definitions ************************/
 218 #define CLKGDV(value)           (value)         /* Bits 0:7 */
 219 #define FWID(value)             ((value)<<8)    /* Bits 8:15 */
 220
 221 /************************* McBSP SRGR2 bit definitions ************************/
 222 #define FPER(value)             (value)         /* Bits 0:11 */
 223 #define FSGM                    0x1000
 224 #define CLKSM                   0x2000
 225 #define CLKSP                   0x4000
 226 #define GSYNC                   0x8000
 227
 228 /************************* McBSP MCR1 bit definitions *************************/
 229 #define RMCM                    0x0001
 230 #define RCBLK(value)            ((value)<<2)    /* Bits 2:4 */
 231 #define RPABLK(value)           ((value)<<5)    /* Bits 5:6 */
 232 #define RPBBLK(value)           ((value)<<7)    /* Bits 7:8 */
 233
 234 /************************* McBSP MCR2 bit definitions *************************/
 235 #define XMCM(value)             (value)         /* Bits 0:1 */
 236 #define XCBLK(value)            ((value)<<2)    /* Bits 2:4 */
 237 #define XPABLK(value)           ((value)<<5)    /* Bits 5:6 */
 238 #define XPBBLK(value)           ((value)<<7)    /* Bits 7:8 */
 239
 240 /*********************** McBSP XCCR bit definitions *************************/
 241 #define EXTCLKGATE              0x8000
 242 #define PPCONNECT               0x4000
 243 #define DXENDLY(value)          ((value)<<12)   /* Bits 12:13 */
 244 #define XFULL_CYCLE             0x0800
 245 #define DILB                    0x0020
 246 #define XDMAEN                  0x0008
 247 #define XDISABLE                0x0001
 248
 249 /********************** McBSP RCCR bit definitions *************************/
 250 #define RFULL_CYCLE             0x0800
 251 #define RDMAEN                  0x0008
 252 #define RDISABLE                0x0001
 253
 254 /********************** McBSP SYSCONFIG bit definitions ********************/
 255 #define CLOCKACTIVITY(value)    ((value)<<8)
 256 #define SIDLEMODE(value)        ((value)<<3)
 257 #define ENAWAKEUP               0x0004
 258 #define SOFTRST                 0x0002
 259
 260 /********************** McBSP WAKEUPEN bit definitions *********************/
 261 #define XEMPTYEOFEN             0x4000
 262 #define XRDYEN                  0x0400
 263 #define XEOFEN                  0x0200
 264 #define XFSXEN                  0x0100
 265 #define XSYNCERREN              0x0080
 266 #define RRDYEN                  0x0008
 267 #define REOFEN                  0x0004
 268 #define RFSREN                  0x0002
 269 #define RSYNCERREN              0x0001
 270 #define WAKEUPEN_ALL            (XEMPTYEOFEN | XRDYEN | XEOFEN | XFSXEN | \
 271                                  XSYNCERREN | RRDYEN | REOFEN | RFSREN | \
 272                                  RSYNCERREN)
 273
 274 /* we don't do multichannel for now */
 275 struct omap_mcbsp_reg_cfg {
 276         u16 spcr2;
 277         u16 spcr1;
 278         u16 rcr2;
 279         u16 rcr1;
 280         u16 xcr2;
 281         u16 xcr1;
 282         u16 srgr2;
 283         u16 srgr1;
 284         u16 mcr2;
 285         u16 mcr1;
 286         u16 pcr0;
 287         u16 rcerc;
 288         u16 rcerd;
 289         u16 xcerc;
 290         u16 xcerd;
 291         u16 rcere;
 292         u16 rcerf;
 293         u16 xcere;
 294         u16 xcerf;
 295         u16 rcerg;
 296         u16 rcerh;
 297         u16 xcerg;
 298         u16 xcerh;
 299         u16 xccr;
 300         u16 rccr;
 301 };
 302
 303 typedef enum {
 304         OMAP_MCBSP1 = 0,
 305         OMAP_MCBSP2,
 306         OMAP_MCBSP3,
 307         OMAP_MCBSP4,
 308         OMAP_MCBSP5
 309 } omap_mcbsp_id;
 310
 311 typedef int __bitwise omap_mcbsp_io_type_t;
 312 #define OMAP_MCBSP_IRQ_IO ((__force omap_mcbsp_io_type_t) 1)
 313 #define OMAP_MCBSP_POLL_IO ((__force omap_mcbsp_io_type_t) 2)
 314
 315 typedef enum {
 316         OMAP_MCBSP_WORD_8 = 0,
 317         OMAP_MCBSP_WORD_12,
 318         OMAP_MCBSP_WORD_16,
 319         OMAP_MCBSP_WORD_20,
 320         OMAP_MCBSP_WORD_24,
 321         OMAP_MCBSP_WORD_32,
 322 } omap_mcbsp_word_length;
 323
 324 typedef enum {
 325         OMAP_MCBSP_CLK_RISING = 0,
 326         OMAP_MCBSP_CLK_FALLING,
 327 } omap_mcbsp_clk_polarity;
 328
 329 typedef enum {
 330         OMAP_MCBSP_FS_ACTIVE_HIGH = 0,
 331         OMAP_MCBSP_FS_ACTIVE_LOW,
 332 } omap_mcbsp_fs_polarity;
 333
 334 typedef enum {
 335         OMAP_MCBSP_CLK_STP_MODE_NO_DELAY = 0,
 336         OMAP_MCBSP_CLK_STP_MODE_DELAY,
 337 } omap_mcbsp_clk_stp_mode;
 338
 339
 340 /******* SPI specific mode **********/
 341 typedef enum {
 342         OMAP_MCBSP_SPI_MASTER = 0,
 343         OMAP_MCBSP_SPI_SLAVE,
 344 } omap_mcbsp_spi_mode;
 345
 346 struct omap_mcbsp_spi_cfg {
 347         omap_mcbsp_spi_mode             spi_mode;
 348         omap_mcbsp_clk_polarity         rx_clock_polarity;
 349         omap_mcbsp_clk_polarity         tx_clock_polarity;
 350         omap_mcbsp_fs_polarity          fsx_polarity;
 351         u8                              clk_div;
 352         omap_mcbsp_clk_stp_mode         clk_stp_mode;
 353         omap_mcbsp_word_length          word_length;
 354 };
 355
 356 /* Platform specific configuration */
 357 struct omap_mcbsp_ops {
 358         void (*request)(unsigned int);
 359         void (*free)(unsigned int);
 360 };
 361
 362 struct omap_mcbsp_platform_data {
 363         unsigned long phys_base;
 364         u8 dma_rx_sync, dma_tx_sync;
 365         u16 rx_irq, tx_irq;
 366         struct omap_mcbsp_ops *ops;
 367         char const **clk_names;
 368         int num_clks;
 369 };
 370
 371 struct omap_mcbsp {
 372         struct device *dev;
 373         unsigned long phys_base;
 374         void __iomem *io_base;
 375         u8 id;
 376         u8 free;
 377         omap_mcbsp_word_length rx_word_length;
 378         omap_mcbsp_word_length tx_word_length;
 379
 380         omap_mcbsp_io_type_t io_type; /* IRQ or poll */
 381         /* IRQ based TX/RX */
 382         int rx_irq;
 383         int tx_irq;
 384
 385         /* DMA stuff */
 386         u8 dma_rx_sync;
 387         short dma_rx_lch;
 388         u8 dma_tx_sync;
 389         short dma_tx_lch;
 390
 391         /* Completion queues */
 392         struct completion tx_irq_completion;
 393         struct completion rx_irq_completion;
 394         struct completion tx_dma_completion;
 395         struct completion rx_dma_completion;
 396
 397         /* Protect the field .free, while checking if the mcbsp is in use */
 398         spinlock_t lock;
 399         struct omap_mcbsp_platform_data *pdata;
 400         struct clk **clks;
 401         int num_clks;
 402 };
 403 extern struct omap_mcbsp **mcbsp_ptr;
 404 extern int omap_mcbsp_count;
 405
 406 int omap_mcbsp_init(void);
 407 void omap_mcbsp_register_board_cfg(struct omap_mcbsp_platform_data *config,
 408                                         int size);
 409 void omap_mcbsp_config(unsigned int id, const struct omap_mcbsp_reg_cfg * config);
 410 int omap_mcbsp_request(unsigned int id);
 411 void omap_mcbsp_free(unsigned int id);
 412 void omap_mcbsp_start(unsigned int id);
 413 void omap_mcbsp_stop(unsigned int id);
 414 void omap_mcbsp_xmit_word(unsigned int id, u32 word);
 415 u32 omap_mcbsp_recv_word(unsigned int id);
 416
 417 int omap_mcbsp_xmit_buffer(unsigned int id, dma_addr_t buffer, unsigned int length);
 418 int omap_mcbsp_recv_buffer(unsigned int id, dma_addr_t buffer, unsigned int length);
 419 int omap_mcbsp_spi_master_xmit_word_poll(unsigned int id, u32 word);
 420 int omap_mcbsp_spi_master_recv_word_poll(unsigned int id, u32 * word);
 421
 422
 423 /* SPI specific API */
 424 void omap_mcbsp_set_spi_mode(unsigned int id, const struct omap_mcbsp_spi_cfg * spi_cfg);
 425
 426 /* Polled read/write functions */
 427 int omap_mcbsp_pollread(unsigned int id, u16 * buf);
 428 int omap_mcbsp_pollwrite(unsigned int id, u16 buf);
 429 int omap_mcbsp_set_io_type(unsigned int id, omap_mcbsp_io_type_t io_type);
 430
 431 #endif