sys/arm/at91/at91_mcireg.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2006 Berndt Walter.  All rights reserved.
   5  * Copyright (c) 2006 M. Warner Losh.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 /* $FreeBSD$ */
  30
  31 #ifndef ARM_AT91_AT91_MCIREG_H
  32 #define ARM_AT91_AT91_MCIREG_H
  33
  34 #define MMC_MAX         30
  35
  36 #define MCI_CR          0x00    /* MCI Control Register */
  37 #define MCI_MR          0x04    /* MCI Mode Register */
  38 #define MCI_DTOR        0x08    /* MCI Data Timeout Register */
  39 #define MCI_SDCR        0x0c    /* MCI SD Card Register */
  40 #define MCI_ARGR        0x10    /* MCI Argument Register */
  41 #define MCI_CMDR        0x14    /* MCI Command Register */
  42 #define MCI_RSPR        0x20    /* MCI Response Registers - 4 of them */
  43 #define MCI_RDR         0x30    /* MCI Receive Data Register */
  44 #define MCI_TDR         0x34    /* MCI Transmit Data Register */
  45 #define MCI_SR          0x40    /* MCI Status Register */
  46 #define MCI_IER         0x44    /* MCI Interrupt Enable Register */
  47 #define MCI_IDR         0x48    /* MCI Interrupt Disable Register */
  48 #define MCI_IMR         0x4c    /* MCI Interrupt Mask Register */
  49
  50 /* -------- MCI_CR : (MCI Offset: 0x0) MCI Control Register --------  */
  51 #define MCI_CR_MCIEN       (0x1u <<  0) /* (MCI) Multimedia Interface Enable */
  52 #define MCI_CR_MCIDIS      (0x1u <<  1) /* (MCI) Multimedia Interface Disable */
  53 #define MCI_CR_PWSEN       (0x1u <<  2) /* (MCI) Power Save Mode Enable */
  54 #define MCI_CR_PWSDIS      (0x1u <<  3) /* (MCI) Power Save Mode Disable */
  55 #define MCI_CR_SWRST      (0x1u <<  7) /* (MCI) Software Reset */
  56 /* -------- MCI_MR : (MCI Offset: 0x4) MCI Mode Register --------  */
  57 #define MCI_MR_CLKDIV      (0xffu <<  0) /* (MCI) Clock Divider */
  58 #define MCI_MR_PWSDIV      (0x3fu <<  8) /* (MCI) Power Saving Divider */
  59 #define MCI_MR_RDPROOF  (0x1u << 11)    /* (MCI) Read Proof Enable */
  60 #define MCI_MR_WRPROOF  (0x1u << 12)    /* (MCI) Write Proof Enable */
  61 #define MCI_MR_PDCFBYTE (0x1u << 13)    /* (MCI) PDC Force Byte Transfer */
  62 #define MCI_MR_PDCPADV     (0x1u << 14) /* (MCI) PDC Padding Value */
  63 #define MCI_MR_PDCMODE     (0x1u << 15) /* (MCI) PDC Oriented Mode */
  64 #define MCI_MR_BLKLEN      0x3fff0000ul /* (MCI) Data Block Length */
  65 /* -------- MCI_DTOR : (MCI Offset: 0x8) MCI Data Timeout Register --------  */
  66 #define MCI_DTOR_DTOCYC      (0xfu <<  0) /* (MCI) Data Timeout Cycle Number */
  67 #define MCI_DTOR_DTOMUL      (0x7u <<  4) /* (MCI) Data Timeout Multiplier */
  68 #define         MCI_DTOR_DTOMUL_1                    (0x0u <<  4) /* (MCI) DTOCYC x 1 */
  69 #define         MCI_DTOR_DTOMUL_16                   (0x1u <<  4) /* (MCI) DTOCYC x 16 */
  70 #define         MCI_DTOR_DTOMUL_128                  (0x2u <<  4) /* (MCI) DTOCYC x 128 */
  71 #define         MCI_DTOR_DTOMUL_256                  (0x3u <<  4) /* (MCI) DTOCYC x 256 */
  72 #define         MCI_DTOR_DTOMUL_1k                   (0x4u <<  4) /* (MCI) DTOCYC x 1024 */
  73 #define         MCI_DTOR_DTOMUL_4k                   (0x5u <<  4) /* (MCI) DTOCYC x 4096 */
  74 #define         MCI_DTOR_DTOMUL_64k                  (0x6u <<  4) /* (MCI) DTOCYC x 65536 */
  75 #define         MCI_DTOR_DTOMUL_1M                   (0x7u <<  4) /* (MCI) DTOCYC x 1048576 */
  76 /* -------- MCI_SDCR : (MCI Offset: 0xc) MCI SD Card Register --------  */
  77 #define MCI_SDCR_SDCSEL      (0x1u <<  0) /* (MCI) SD Card Selector */
  78 #define MCI_SDCR_SDCBUS      (0x1u <<  7) /* (MCI) SD Card Bus Width */
  79 /* -------- MCI_CMDR : (MCI Offset: 0x14) MCI Command Register --------  */
  80 #define MCI_CMDR_CMDNB       (0x1Fu <<  0) /* (MCI) Command Number */
  81 #define MCI_CMDR_RSPTYP      (0x3u <<  6) /* (MCI) Response Type */
  82 #define         MCI_CMDR_RSPTYP_NO                   (0x0u <<  6) /* (MCI) No response */
  83 #define         MCI_CMDR_RSPTYP_48                   (0x1u <<  6) /* (MCI) 48-bit response */
  84 #define         MCI_CMDR_RSPTYP_136                  (0x2u <<  6) /* (MCI) 136-bit response */
  85 #define MCI_CMDR_SPCMD       (0x7u <<  8) /* (MCI) Special CMD */
  86 #define         MCI_CMDR_SPCMD_NONE                 (0x0u <<  8) /* (MCI) Not a special CMD */
  87 #define         MCI_CMDR_SPCMD_INIT                 (0x1u <<  8) /* (MCI) Initialization CMD */
  88 #define         MCI_CMDR_SPCMD_SYNC                 (0x2u <<  8) /* (MCI) Synchronized CMD */
  89 #define         MCI_CMDR_SPCMD_IT_CMD               (0x4u <<  8) /* (MCI) Interrupt command */
  90 #define         MCI_CMDR_SPCMD_IT_REP               (0x5u <<  8) /* (MCI) Interrupt response */
  91 #define MCI_CMDR_OPDCMD      (0x1u << 11) /* (MCI) Open Drain Command */
  92 #define MCI_CMDR_MAXLAT      (0x1u << 12) /* (MCI) Maximum Latency for Command to respond */
  93 #define MCI_CMDR_TRCMD       (0x3u << 16) /* (MCI) Transfer CMD */
  94 #define         MCI_CMDR_TRCMD_NO                   (0x0u << 16) /* (MCI) No transfer */
  95 #define         MCI_CMDR_TRCMD_START                (0x1u << 16) /* (MCI) Start transfer */
  96 #define         MCI_CMDR_TRCMD_STOP                 (0x2u << 16) /* (MCI) Stop transfer */
  97 #define MCI_CMDR_TRDIR       (0x1u << 18) /* (MCI) Transfer Direction */
  98 #define MCI_CMDR_TRTYP       (0x3u << 19) /* (MCI) Transfer Type */
  99 #define         MCI_CMDR_TRTYP_BLOCK                (0x0u << 19) /* (MCI) Block Transfer type */
 100 #define         MCI_CMDR_TRTYP_MULTIPLE             (0x1u << 19) /* (MCI) Multiple Block transfer type */
 101 #define         MCI_CMDR_TRTYP_STREAM               (0x2u << 19) /* (MCI) Stream transfer type */
 102 /* -------- MCI_SR : (MCI Offset: 0x40) MCI Status Register --------  */
 103 #define MCI_SR_CMDRDY   (0x1u <<  0) /* (MCI) Command Ready flag */
 104 #define MCI_SR_RXRDY    (0x1u <<  1) /* (MCI) RX Ready flag */
 105 #define MCI_SR_TXRDY    (0x1u <<  2) /* (MCI) TX Ready flag */
 106 #define MCI_SR_BLKE     (0x1u <<  3) /* (MCI) Data Block Transfer Ended flag */
 107 #define MCI_SR_DTIP     (0x1u <<  4) /* (MCI) Data Transfer in Progress flag */
 108 #define MCI_SR_NOTBUSY  (0x1u <<  5) /* (MCI) Data Line Not Busy flag */
 109 #define MCI_SR_ENDRX    (0x1u <<  6) /* (MCI) End of RX Buffer flag */
 110 #define MCI_SR_ENDTX    (0x1u <<  7) /* (MCI) End of TX Buffer flag */
 111 #define MCI_SR_RXBUFF   (0x1u << 14) /* (MCI) RX Buffer Full flag */
 112 #define MCI_SR_TXBUFE   (0x1u << 15) /* (MCI) TX Buffer Empty flag */
 113 #define MCI_SR_RINDE    (0x1u << 16) /* (MCI) Response Index Error flag */
 114 #define MCI_SR_RDIRE    (0x1u << 17) /* (MCI) Response Direction Error flag */
 115 #define MCI_SR_RCRCE    (0x1u << 18) /* (MCI) Response CRC Error flag */
 116 #define MCI_SR_RENDE    (0x1u << 19) /* (MCI) Response End Bit Error flag */
 117 #define MCI_SR_RTOE     (0x1u << 20) /* (MCI) Response Time-out Error flag */
 118 #define MCI_SR_DCRCE    (0x1u << 21) /* (MCI) data CRC Error flag */
 119 #define MCI_SR_DTOE     (0x1u << 22) /* (MCI) Data timeout Error flag */
 120 #define MCI_SR_OVRE     (0x1u << 30) /* (MCI) Overrun flag */
 121 #define MCI_SR_UNRE     (0x1u << 31) /* (MCI) Underrun flag */
 122
 123 /*      TXRDY,DTIP,ENDTX,TXBUFE,RTOE */
 124
 125 #define MCI_SR_BITSTRING \
 126         "\020" \
 127         "\001CMDRDY" \
 128         "\002RXRDY" \
 129         "\003TXRDY" \
 130         "\004BLKE" \
 131         "\005DTIP" \
 132         "\006NOTBUSY" \
 133         "\007ENDRX" \
 134         "\010ENDTX" \
 135         "\017RXBUFF" \
 136         "\020TXBUFE" \
 137         "\021RINDE" \
 138         "\022RDIRE" \
 139         "\023RCRCE" \
 140         "\024RENDE" \
 141         "\025RTOE" \
 142         "\026DCRCE" \
 143         "\027DTOE" \
 144         "\037OVRE" \
 145         "\040UNRE"
 146
 147 /* -------- MCI_IER : (MCI Offset: 0x44) MCI Interrupt Enable Register --------  */
 148 /* -------- MCI_IDR : (MCI Offset: 0x48) MCI Interrupt Disable Register --------  */
 149 /* -------- MCI_IMR : (MCI Offset: 0x4c) MCI Interrupt Mask Register --------  */
 150
 151 #define MCI_SR_ERROR    (MCI_SR_UNRE | MCI_SR_OVRE | MCI_SR_DTOE | \
 152                         MCI_SR_DCRCE | MCI_SR_RTOE | MCI_SR_RENDE | \
 153                         MCI_SR_RCRCE | MCI_SR_RDIRE | MCI_SR_RINDE)
 154
 155 #define AT91C_BUS_WIDTH_1BIT            0x00
 156 #define AT91C_BUS_WIDTH_4BITS           0x02
 157
 158 #endif /* ARM_AT91_AT91_MCIREG_H */