sys/pccard/pcic_pci.h

   1 /*
   2  * Copyright (c) 2001 M. Warner Losh. All rights reserved.
   3  * Copyright (c) 1997 Ted Faber. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice immediately at the beginning of the file, without modification,
  11  *    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  * 3. Absolutely no warranty of function or purpose is made by the author
  16  *    Ted Faber.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 /* Share the devid database with NEWCARD */
  33 #include <dev/pccbb/pccbbdevid.h>
  34
  35 /* CL-PD683x CardBus defines */
  36 #define CLPD6833_CFG_MISC_1             0x98
  37
  38 /* Configuration constants */
  39 #define CLPD6832_BCR_MGMT_IRQ_ENA       0x0800
  40 #define CLPD6833_CM1_MGMT_EXCA_ENA      0x0001  /* Set ExCA, Clr PCI */
  41
  42 /* End of CL-PD6832 defines */
  43 /* Texas Instruments PCI-1130/1131 CardBus Controller */
  44 #define TI113X_PCI_SYSTEM_CONTROL       0x80    /* System Control */
  45 #define TI12XX_PCI_MULTIMEDIA_CONTROL   0x84    /* Zoom Video */
  46 #define TI113X_PCI_RETRY_STATUS         0x90    /* Retry Status */
  47 #define TI113X_PCI_CARD_CONTROL         0x91    /* Card Control */
  48 #define TI113X_PCI_DEVICE_CONTROL       0x92    /* Device Control */
  49 #define TI113X_PCI_BUFFER_CONTROL       0x93    /* Buffer Control */
  50 #define TI12XX_PCI_DIAGNOSTIC           0x93    /* Diagnostic register */
  51 #define TI113X_PCI_SOCKET_DMA0          0x94    /* Socket DMA Register 0 */
  52 #define TI113X_PCI_SOCKET_DMA1          0x98    /* Socket DMA Register 1 */
  53
  54 /* Card control register (TI113X_SYSTEM_CONTROL == 0x80) */
  55 #define TI113X_SYSCNTL_INTRTIE          0x20000000u
  56 #define TI113X_SYSCNTL_SMIENB           0x00800000u
  57 #define TI113X_SYSCNTL_VCC_PROTECT      0x00200000u
  58 #define TI113X_SYSCNTL_CLKRUN_SEL       0x00000080u
  59 #define TI113X_SYSCNTL_PWRSAVINGS       0x00000040u
  60 #define TI113X_SYSCNTL_KEEP_CLK         0x00000002u
  61 #define TI113X_SYSCNTL_CLKRUN_ENA       0x00000001u
  62
  63 /* Card control register (TI113X_CARD_CONTROL == 0x91) */
  64 #define TI113X_CARDCNTL_RING_ENA        0x80u
  65 #define TI113X_CARDCNTL_ZOOM_VIDEO      0x40u
  66 #define TI113X_CARDCNTL_PCI_IRQ_ENA     0x20u
  67 #define TI113X_CARDCNTL_PCI_IREQ        0x10u
  68 #define TI113X_CARDCNTL_PCI_CSC         0x08u
  69 #define TI113X_CARDCNTL_MASK            (TI113X_CARDCNTL_PCI_IRQ_ENA | TI113X_CARDCNTL_PCI_IREQ | TI113X_CARDCNTL_PCI_CSC)
  70 #define TI113X_FUNC0_VALID              TI113X_CARDCNTL_MASK
  71 #define TI113X_FUNC1_VALID              (TI113X_CARDCNTL_PCI_IREQ | TI113X_CARDCNTL_PCI_CSC)
  72 /* Reserved bit                         0x04u */
  73 #define TI113X_CARDCNTL_SPKR_ENA        0x02u
  74 #define TI113X_CARDCNTL_INT             0x01u
  75
  76 /* Device control register (TI113X_DEVICE_CONTROL == 0x92) */
  77 #define TI113X_DEVCNTL_5V_SOCKET        0x40u
  78 #define TI113X_DEVCNTL_3V_SOCKET        0x20u
  79 #define TI113X_DEVCNTL_INTR_MASK        0x06u
  80 #define TI113X_DEVCNTL_INTR_NONE        0x00u
  81 #define TI113X_DEVCNTL_INTR_ISA         0x02u
  82 #define TI113X_DEVCNTL_INTR_SERIAL      0x04u
  83 /* TI12XX specific code */
  84 #define TI12XX_DEVCNTL_INTR_ALLSERIAL   0x06u
  85
  86 /* Diagnostic register (misnamed) TI12XX_PCI_DIAGNOSTIC == 0x93 */
  87 #define TI12XX_DIAG_CSC_INTR            0x20    /* see datasheet */
  88
  89 /* Texas Instruments PCI-1130/1131 CardBus Controller */
  90 #define TI113X_ExCA_IO_OFFSET0          0x36    /* Offset of I/O window */
  91 #define TI113X_ExCA_IO_OFFSET1          0x38    /* Offset of I/O window */
  92 #define TI113X_ExCA_MEM_WINDOW_PAGE     0x3C    /* Memory Window Page */
  93
  94 /*
  95  * Ricoh R5C47[5678] parts have these registers.  Maybe the 46x also use
  96  * them, but I can't find out for sure without datasheets...
  97  */
  98 #define R5C47X_MISC_CONTROL_REGISTER_2  0xa0
  99 #define R5C47X_MCR2_CSC_TO_INTX_DISABLE 0x0010  /* Bit 7 */
 100
 101 /*
 102  * Special resister definition for Toshiba ToPIC95/97
 103  * These values are borrowed from pcmcia-cs/Linux.
 104  */
 105 #define TOPIC_SOCKET_CTRL  0x90
 106 # define TOPIC_SOCKET_CTRL_SCR_IRQSEL 0x00000001 /* PCI intr */
 107
 108 #define TOPIC_SLOT_CTRL    0xa0
 109 # define TOPIC_SLOT_CTRL_SLOTON       0x00000080
 110 # define TOPIC_SLOT_CTRL_SLOTEN       0x00000040
 111 # define TOPIC_SLOT_CTRL_ID_LOCK      0x00000020
 112 # define TOPIC_SLOT_CTRL_ID_WP        0x00000010
 113 # define TOPIC_SLOT_CTRL_PORT_MASK    0x0000000c
 114 # define TOPIC_SLOT_CTRL_PORT_SHIFT            2
 115 # define TOPIC_SLOT_CTRL_OSF_MASK     0x00000003
 116 # define TOPIC_SLOT_CTRL_OSF_SHIFT             0
 117
 118 # define TOPIC_SLOT_CTRL_INTB         0x00002000
 119 # define TOPIC_SLOT_CTRL_INTA         0x00001000
 120 # define TOPIC_SLOT_CTRL_INT_MASK     0x00003000
 121 # define TOPIC_SLOT_CTRL_CLOCK_MASK   0x00000c00
 122 # define TOPIC_SLOT_CTRL_CLOCK_2      0x00000800 /* PCI Clock/2 */
 123 # define TOPIC_SLOT_CTRL_CLOCK_1      0x00000400 /* PCI Clock */
 124 # define TOPIC_SLOT_CTRL_CLOCK_0      0x00000000 /* no clock */
 125 # define TOPIC97_SLOT_CTRL_STSIRQP    0x00000400 /* status change intr pulse */
 126 # define TOPIC97_SLOT_CTRL_IRQP       0x00000200 /* function intr pulse */
 127 # define TOPIC97_SLOT_CTRL_PCIINT     0x00000100 /* intr routing to PCI INT */
 128
 129 # define TOPIC_SLOT_CTRL_CARDBUS      0x80000000
 130 # define TOPIC_SLOT_CTRL_VS1          0x04000000
 131 # define TOPIC_SLOT_CTRL_VS2          0x02000000
 132 # define TOPIC_SLOT_CTRL_SWDETECT     0x01000000
 133
 134 #define TOPIC_REG_CTRL     0x00a4
 135 # define TOPIC_REG_CTRL_RESUME_RESET  0x80000000
 136 # define TOPIC_REG_CTRL_REMOVE_RESET  0x40000000
 137 # define TOPIC97_REG_CTRL_CLKRUN_ENA  0x20000000
 138 # define TOPIC97_REG_CTRL_TESTMODE    0x10000000
 139 # define TOPIC97_REG_CTRL_IOPLUP      0x08000000
 140 # define TOPIC_REG_CTRL_BUFOFF_PWROFF 0x02000000
 141 # define TOPIC_REG_CTRL_BUFOFF_SIGOFF 0x01000000
 142 # define TOPIC97_REG_CTRL_CB_DEV_MASK 0x0000f800
 143 # define TOPIC97_REG_CTRL_CB_DEV_SHIFT 11
 144 # define TOPIC97_REG_CTRL_RI_DISABLE  0x00000004
 145 # define TOPIC97_REG_CTRL_CAUDIO_OFF  0x00000002
 146 # define TOPIC_REG_CTRL_CAUDIO_INVERT 0x00000001
 147
 148 /* For Bridge Control register (CB_PCI_BRIDGE_CTRL) */
 149 #define CB_BCR_MASTER_ABORT     0x0020
 150 #define CB_BCR_CB_RESET         0x0040
 151 #define CB_BCR_INT_EXCA         0x0080
 152 #define CB_BCR_WRITE_POST_EN    0x0400
 153   /* additional bits for Ricoh's cardbus products */
 154 #define CB_BCR_RL_3E0_EN        0x0800
 155 #define CB_BCR_RL_3E2_EN        0x1000
 156
 157 /* PCI Configuration Registers (common) */
 158 #define CB_PCI_VENDOR_ID        0x00    /* vendor ID */
 159 #define CB_PCI_DEVICE_ID        0x02    /* device ID */
 160 #define CB_PCI_COMMAND          0x04    /* PCI command */
 161 #define CB_PCI_STATUS           0x06    /* PCI status */
 162 #define CB_PCI_REVISION_ID      0x08    /* PCI revision ID */
 163 #define CB_PCI_CLASS            0x09    /* PCI class code */
 164 #define CB_PCI_CACHE_LINE_SIZE  0x0c    /* Cache line size */
 165 #define CB_PCI_LATENCY          0x0d    /* PCI latency timer */
 166 #define CB_PCI_HEADER_TYPE      0x0e    /* PCI header type */
 167 #define CB_PCI_BIST             0x0f    /* Built-in self test */
 168 #define CB_PCI_SOCKET_BASE      0x10    /* Socket/ExCA base address reg. */
 169 #define CB_PCI_CB_STATUS        0x16    /* CardBus Status */
 170 #define CB_PCI_PCI_BUS_NUM      0x18    /* PCI bus number */
 171 #define CB_PCI_CB_BUS_NUM       0x19    /* CardBus bus number */
 172 #define CB_PCI_CB_SUB_BUS_NUM   0x1A    /* Subordinate CardBus bus number */
 173 #define CB_PCI_CB_LATENCY       0x1A    /* CardBus latency timer */
 174 #define CB_PCI_MEMBASE0         0x1C    /* Memory base register 0 */
 175 #define CB_PCI_MEMLIMIT0        0x20    /* Memory limit register 0 */
 176 #define CB_PCI_MEMBASE1         0x24    /* Memory base register 1 */
 177 #define CB_PCI_MEMLIMIT1        0x28    /* Memory limit register 1 */
 178 #define CB_PCI_IOBASE0          0x2C    /* I/O base register 0 */
 179 #define CB_PCI_IOLIMIT0         0x30    /* I/O limit register 0 */
 180 #define CB_PCI_IOBASE1          0x34    /* I/O base register 1 */
 181 #define CB_PCI_IOLIMIT1         0x38    /* I/O limit register 1 */
 182 #define CB_PCI_INT_LINE         0x3C    /* Interrupt Line */
 183 #define CB_PCI_INT_PIN          0x3D    /* Interrupt Pin */
 184 #define CB_PCI_BRIDGE_CTRL      0x3E    /* Bridge Control */
 185 #define CB_PCI_SUBSYS_VENDOR_ID 0x40    /* Subsystem Vendor ID */
 186 #define CB_PCI_SUBSYS_ID        0x42    /* Subsystem ID */
 187 #define CB_PCI_LEGACY16_IOADDR  0x44    /* Legacy 16bit I/O address */
 188 #define CB_PCI_LEGACY16_IOENABLE 0x01   /* Enable Legacy 16bit I/O address */
 189
 190 /* PCI Memory register offsets for YENTA devices */
 191 #define CB_SOCKET_EVENT         0x00
 192 #define CB_SOCKET_MASK          0x04
 193 #define CB_SOCKET_STATE         0x08
 194 #define CB_SOCKET_FORCE         0x0c
 195 #define CB_SOCKET_POWER         0x10
 196 #define CB_EXCA_OFFSET          0x800   /* Offset for ExCA registers */
 197
 198 #define CB_SE_CD                0x6     /* Socket Event Card detect */
 199 #define CB_SE_POWER             0x8
 200
 201 #define CB_SM_CD                0x6     /* Socket MASK Card detect */
 202 #define CB_SM_POWER             0x8
 203
 204 /* Socket State Register */
 205 #define CB_SS_CARDSTS           0x00000001 /* Card Status Change */
 206 #define CB_SS_CD1               0x00000002 /* Card Detect 1 */
 207 #define CB_SS_CD2               0x00000004 /* Card Detect 2 */
 208 #define CB_SS_CD                0x00000006 /* Card Detect all */
 209 #define CB_SS_PWRCYCLE          0x00000008 /* Power Cycle */
 210 #define CB_SS_16BIT             0x00000010 /* 16-bit Card */
 211 #define CB_SS_CB                0x00000020 /* Cardbus Card */
 212 #define CB_SS_IREQ              0x00000040 /* Ready */
 213 #define CB_SS_NOTCARD           0x00000080 /* Unrecognized Card */
 214 #define CB_SS_DATALOST          0x00000100 /* Data Lost */
 215 #define CB_SS_BADVCC            0x00000200 /* Bad VccRequest */
 216 #define CB_SS_5VCARD            0x00000400 /* 5 V Card */
 217 #define CB_SS_3VCARD            0x00000800 /* 3.3 V Card */
 218 #define CB_SS_XVCARD            0x00001000 /* X.X V Card */
 219 #define CB_SS_YVCARD            0x00002000 /* Y.Y V Card */
 220 #define CB_SS_CARD_MASK         0x00003c00 /* *VCARD signal */
 221 #define CB_SS_5VSOCK            0x10000000 /* 5 V Socket */
 222 #define CB_SS_3VSOCK            0x20000000 /* 3.3 V Socket */
 223 #define CB_SS_XVSOCK            0x40000000 /* X.X V Socket */
 224 #define CB_SS_YVSOCK            0x80000000 /* Y.Y V Socket */
 225
 226 /* Socket power register */
 227 #define CB_SP_CLKSTOP           0x80    /* Cardbus clock stop protocol */
 228 #define CB_SP_VCC_MASK          0x70
 229 #define CB_SP_VCC_0V            0x00
 230                                         /* 0x10 is reserved 12V in VPP */
 231 #define CB_SP_VCC_5V            0x20
 232 #define CB_SP_VCC_3V            0x30
 233 #define CB_SP_VCC_XV            0x40
 234 #define CB_SP_VCC_YV            0x50
 235                                         /* 0x60 and 0x70 are reserved */
 236 #define CB_SP_VPP_MASK          0x07
 237 #define CB_SP_VPP_0V            0x00
 238 #define CB_SP_VPP_12V           0x01
 239 #define CB_SP_VPP_5V            0x02
 240 #define CB_SP_VPP_3V            0x03
 241 #define CB_SP_VPP_XV            0x04
 242 #define CB_SP_VPP_YV            0x05
 243
 244 /* Socket force register */
 245 #define CB_SF_INTCVS            (1 << 14)       /* Interregate CVS/CCD pins */
 246 #define CB_SF_5VCARD            (1 << 11)
 247 #define CB_SF_3VCARD            (1 << 10)
 248 #define CB_SF_BADVCC            (1 << 9)
 249 #define CB_SF_DATALOST          (1 << 8)
 250 #define CB_SF_NOTACARD          (1 << 7)
 251 #define CB_SF_CBCARD            (1 << 5)
 252 #define CB_SF_16CARD            (1 << 4)
 253 #define CB_SF_POWERCYCLE        (1 << 3)
 254 #define CB_SF_CCD2              (1 << 2)
 255 #define CB_SF_CCD1              (1 << 1)
 256 #define CB_SF_CSTCHG            (1 << 0)
 257                                         /* 0x6 and 0x7 are reserved */