sys/dev/cardbus/cardbusreg.h

   1 /*-
   2  * Copyright (c) 2000,2001 Jonathan Chen.
   3  * 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  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 /*
  30  * Register definitions for the Cardbus Bus
  31  */
  32
  33
  34 /* Cardbus bus constants */
  35 #define CARDBUS_SLOTMAX         0
  36 #define CARDBUS_FUNCMAX         7
  37
  38 /* Cardbus configuration header registers */
  39 #define CARDBUS_BASE0_REG       0x10
  40 #define CARDBUS_BASE1_REG       0x14
  41 #define CARDBUS_BASE2_REG       0x18
  42 #define CARDBUS_BASE3_REG       0x1C
  43 #define CARDBUS_BASE4_REG       0x20
  44 #define CARDBUS_BASE5_REG       0x24
  45 #define CARDBUS_CIS_REG         0x28
  46 # define        CARDBUS_CIS_ASIMASK             0x07
  47 # define        CARDBUS_CIS_ADDRMASK            0x0ffffff8
  48 # define        CARDBUS_CIS_ASI_TUPLE           0x00
  49 # define        CARDBUS_CIS_ASI_BAR0            0x01
  50 # define        CARDBUS_CIS_ASI_BAR1            0x02
  51 # define        CARDBUS_CIS_ASI_BAR2            0x03
  52 # define        CARDBUS_CIS_ASI_BAR3            0x04
  53 # define        CARDBUS_CIS_ASI_BAR4            0x05
  54 # define        CARDBUS_CIS_ASI_BAR5            0x06
  55 # define        CARDBUS_CIS_ASI_ROM             0x07
  56 #define CARDBUS_ROM_REG         0x30
  57 # define        CARDBUS_ROM_ENABLE              0x00000001
  58 # define        CARDBUS_ROM_ADDRMASK            0xfffff800
  59
  60 /* EXROM offsets for reading CIS */
  61 #define CARDBUS_EXROM_SIGNATURE 0x00
  62 #define CARDBUS_EXROM_DATA_PTR  0x18
  63
  64 #define CARDBUS_EXROM_DATA_SIGNATURE    0x00 /* Signature ("PCIR") */
  65 #define CARDBUS_EXROM_DATA_VENDOR_ID    0x04 /* Vendor Identification */
  66 #define CARDBUS_EXROM_DATA_DEVICE_ID    0x06 /* Device Identification */
  67 #define CARDBUS_EXROM_DATA_LENGTH       0x0a /* PCI Data Structure Length */
  68 #define CARDBUS_EXROM_DATA_REV          0x0c /* PCI Data Structure Revision */
  69 #define CARDBUS_EXROM_DATA_CLASS_CODE   0x0d /* Class Code */
  70 #define CARDBUS_EXROM_DATA_IMAGE_LENGTH 0x10 /* Image Length */
  71 #define CARDBUS_EXROM_DATA_DATA_REV     0x12 /* Revision Level of Code/Data */
  72 #define CARDBUS_EXROM_DATA_CODE_TYPE    0x14 /* Code Type */
  73 #define CARDBUS_EXROM_DATA_INDICATOR    0x15 /* Indicator */
  74
  75 /* useful macros */
  76 #define CARDBUS_CIS_ADDR(x)                                             \
  77         (CARDBUS_CIS_ADDRMASK & (x))
  78 #define CARDBUS_CIS_SPACE(x)                                            \
  79         (CARDBUS_CIS_ASIMASK & (x))
  80 #define CARDBUS_CIS_ASI_BAR(x)                                          \
  81         (((CARDBUS_CIS_ASIMASK & (x))-1)*4+0x10)
  82 #define CARDBUS_CIS_ASI_ROM_IMAGE(x)                                    \
  83         (((x) >> 28) & 0xf)
  84
  85 #define CARDBUS_MAPREG_MEM_ADDR_MASK    0x0ffffff0
  86 #define CARDBUS_MAPREG_MEM_ADDR(mr)                                     \
  87         ((mr) & CARDBUS_MAPREG_MEM_ADDR_MASK)
  88 #define CARDBUS_MAPREG_MEM_SIZE(mr)                                     \
  89         (CARDBUS_MAPREG_MEM_ADDR(mr) & (~CARDBUS_MAPREG_MEM_ADDR(mr) + 1))