sys/dev/pccard/pccardvar.h

   1 /*      $NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $     */
   2 /* $FreeBSD$ */
   3
   4 /*-
   5  * Copyright (c) 1997 Marc Horowitz.  All rights reserved.
   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  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *      This product includes software developed by Marc Horowitz.
  18  * 4. The name of the author may not be used to endorse or promote products
  19  *    derived from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * Contains information about mapped/allocated i/o spaces.
  35  */
  36 struct pccard_io_handle {
  37         bus_space_tag_t iot;            /* bus space tag (from chipset) */
  38         bus_space_handle_t ioh;         /* mapped space handle */
  39         bus_addr_t      addr;           /* resulting address in bus space */
  40         bus_size_t      size;           /* size of i/o space */
  41         int             flags;          /* misc. information */
  42         int             width;
  43 };
  44
  45 #define PCCARD_IO_ALLOCATED     0x01    /* i/o space was allocated */
  46
  47 /*
  48  * Contains information about allocated memory space.
  49  */
  50 struct pccard_mem_handle {
  51         bus_space_tag_t memt;           /* bus space tag (from chipset) */
  52         bus_space_handle_t memh;        /* mapped space handle */
  53         bus_addr_t      addr;           /* resulting address in bus space */
  54         bus_size_t      size;           /* size of mem space */
  55         bus_size_t      realsize;       /* how much we really allocated */
  56         bus_addr_t      cardaddr;       /* Absolute address on card */
  57         int             kind;
  58 };
  59
  60 /* Bits for kind */
  61 #define PCCARD_MEM_16BIT        1       /* 1 -> 16bit 0 -> 8bit */
  62 #define PCCARD_MEM_ATTR         2       /* 1 -> attribute mem 0 -> common */
  63
  64 #define PCCARD_WIDTH_AUTO       0
  65 #define PCCARD_WIDTH_IO8        1
  66 #define PCCARD_WIDTH_IO16       2
  67
  68 struct pccard_tuple {
  69         unsigned int    code;
  70         unsigned int    length;
  71         u_long          mult;           /* dist btn successive bytes */
  72         bus_addr_t      ptr;
  73         bus_space_tag_t memt;
  74         bus_space_handle_t memh;
  75 };
  76
  77 typedef int (*pccard_scan_t)(const struct pccard_tuple *, void *);
  78
  79 struct pccard_product {
  80         const char      *pp_name;
  81 #define PCCARD_VENDOR_ANY (0xffffffff)
  82         uint32_t        pp_vendor;              /* 0 == end of table */
  83 #define PCCARD_PRODUCT_ANY (0xffffffff)
  84         uint32_t        pp_product;
  85         const char      *pp_cis[4];
  86 };
  87
  88 /**
  89  * Note: There's no cis3 or cis4 reported for NOMATCH / pnpinfo events for pccard
  90  * It's unclear if we actually need that for automatic loading or not. These stirngs
  91  * are informative, according to the standard, but I have a dim memory of using these
  92  * strings to match things, though I can't find the example right now.
  93  */
  94 #define PCCARD_PNP_DESCR "D:#;V32:manufacturer;V32:product;Z:cisvendor;Z:cisproduct;"
  95 #define PCCARD_PNP_INFO(t) \
  96         MODULE_PNP_INFO(PCCARD_PNP_DESCR, pccard, t, t, sizeof(t[0]), sizeof(t) / sizeof(t[0])); \
  97
  98 typedef int (*pccard_product_match_fn) (device_t dev,
  99     const struct pccard_product *ent, int vpfmatch);
 100
 101 #include "card_if.h"
 102
 103 /*
 104  * make this inline so that we don't have to worry about dangling references
 105  * to it in the modules or the code.
 106  */
 107 static inline const struct pccard_product *
 108 pccard_product_lookup(device_t dev, const struct pccard_product *tab,
 109     size_t ent_size, pccard_product_match_fn matchfn)
 110 {
 111         return CARD_DO_PRODUCT_LOOKUP(device_get_parent(dev), dev,
 112             tab, ent_size, matchfn);
 113 }
 114
 115 #define pccard_cis_read_1(tuple, idx0)                                  \
 116         (bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0)))
 117
 118 #define pccard_tuple_read_1(tuple, idx1)                                \
 119         (pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1)))))
 120
 121 #define pccard_tuple_read_2(tuple, idx2)                                \
 122         (pccard_tuple_read_1((tuple), (idx2)) |                         \
 123          (pccard_tuple_read_1((tuple), (idx2)+1)<<8))
 124
 125 #define pccard_tuple_read_3(tuple, idx3)                                \
 126         (pccard_tuple_read_1((tuple), (idx3)) |                         \
 127          (pccard_tuple_read_1((tuple), (idx3)+1)<<8) |                  \
 128          (pccard_tuple_read_1((tuple), (idx3)+2)<<16))
 129
 130 #define pccard_tuple_read_4(tuple, idx4)                                \
 131         (pccard_tuple_read_1((tuple), (idx4)) |                         \
 132          (pccard_tuple_read_1((tuple), (idx4)+1)<<8) |                  \
 133          (pccard_tuple_read_1((tuple), (idx4)+2)<<16) |                 \
 134          (pccard_tuple_read_1((tuple), (idx4)+3)<<24))
 135
 136 #define pccard_tuple_read_n(tuple, n, idxn)                             \
 137         (((n)==1)?pccard_tuple_read_1((tuple), (idxn)) :                \
 138          (((n)==2)?pccard_tuple_read_2((tuple), (idxn)) :               \
 139           (((n)==3)?pccard_tuple_read_3((tuple), (idxn)) :              \
 140            /* n == 4 */ pccard_tuple_read_4((tuple), (idxn)))))
 141
 142 #define PCCARD_SPACE_MEMORY     1
 143 #define PCCARD_SPACE_IO         2
 144
 145 #define pccard_mfc(sc)                                                  \
 146                 (STAILQ_FIRST(&(sc)->card.pf_head) &&                   \
 147                  STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list))
 148
 149 /* Convenience functions */
 150
 151 static inline int
 152 pccard_cis_scan(device_t dev, pccard_scan_t fct, void *arg)
 153 {
 154         return (CARD_CIS_SCAN(device_get_parent(dev), dev, fct, arg));
 155 }
 156
 157 static inline int
 158 pccard_attr_read_1(device_t dev, uint32_t offset, uint8_t *val)
 159 {
 160         return (CARD_ATTR_READ(device_get_parent(dev), dev, offset, val));
 161 }
 162
 163 static inline int
 164 pccard_attr_write_1(device_t dev, uint32_t offset, uint8_t val)
 165 {
 166         return (CARD_ATTR_WRITE(device_get_parent(dev), dev, offset, val));
 167 }
 168
 169 static inline int
 170 pccard_ccr_read_1(device_t dev, uint32_t offset, uint8_t *val)
 171 {
 172         return (CARD_CCR_READ(device_get_parent(dev), dev, offset, val));
 173 }
 174
 175 static inline int
 176 pccard_ccr_write_1(device_t dev, uint32_t offset, uint8_t val)
 177 {
 178         return (CARD_CCR_WRITE(device_get_parent(dev), dev, offset, val));
 179 }
 180
 181 /* Hack */
 182 int pccard_select_cfe(device_t dev, int entry);
 183
 184 /* ivar interface */
 185 enum {
 186         PCCARD_IVAR_ETHADDR,    /* read ethernet address from CIS tupple */
 187         PCCARD_IVAR_VENDOR,
 188         PCCARD_IVAR_PRODUCT,
 189         PCCARD_IVAR_PRODEXT,
 190         PCCARD_IVAR_FUNCTION_NUMBER,
 191         PCCARD_IVAR_VENDOR_STR, /* CIS string for "Manufacturer" */
 192         PCCARD_IVAR_PRODUCT_STR,/* CIS string for "Product" */
 193         PCCARD_IVAR_CIS3_STR,
 194         PCCARD_IVAR_CIS4_STR,
 195         PCCARD_IVAR_FUNCTION,
 196         PCCARD_IVAR_FUNCE_DISK
 197 };
 198
 199 #define PCCARD_ACCESSOR(A, B, T)                                        \
 200 static inline int                                                       \
 201 pccard_get_ ## A(device_t dev, T *t)                                    \
 202 {                                                                       \
 203         return BUS_READ_IVAR(device_get_parent(dev), dev,               \
 204             PCCARD_IVAR_ ## B, (uintptr_t *) t);                        \
 205 }
 206
 207 PCCARD_ACCESSOR(ether,          ETHADDR,                uint8_t)
 208 PCCARD_ACCESSOR(vendor,         VENDOR,                 uint32_t)
 209 PCCARD_ACCESSOR(product,        PRODUCT,                uint32_t)
 210 PCCARD_ACCESSOR(prodext,        PRODEXT,                uint16_t)
 211 PCCARD_ACCESSOR(function_number,FUNCTION_NUMBER,        uint32_t)
 212 PCCARD_ACCESSOR(function,       FUNCTION,               uint32_t)
 213 PCCARD_ACCESSOR(funce_disk,     FUNCE_DISK,             uint16_t)
 214 PCCARD_ACCESSOR(vendor_str,     VENDOR_STR,             const char *)
 215 PCCARD_ACCESSOR(product_str,    PRODUCT_STR,            const char *)
 216 PCCARD_ACCESSOR(cis3_str,       CIS3_STR,               const char *)
 217 PCCARD_ACCESSOR(cis4_str,       CIS4_STR,               const char *)
 218
 219 /* shared memory flags */
 220 enum {
 221         PCCARD_A_MEM_COM,       /* common */
 222         PCCARD_A_MEM_ATTR,      /* attribute */
 223         PCCARD_A_MEM_8BIT,      /* 8 bit */
 224         PCCARD_A_MEM_16BIT      /* 16 bit */
 225 };
 226
 227 #define PCCARD_S(a, b) PCMCIA_STR_ ## a ## _ ## b
 228 #define PCCARD_P(a, b) PCMCIA_PRODUCT_ ## a ## _ ## b
 229 #define PCCARD_C(a, b) PCMCIA_CIS_ ## a ## _ ## b
 230 #define PCMCIA_CARD_D(v, p) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \
 231                 PCCARD_P(v, p), PCCARD_C(v, p) }
 232 #define PCMCIA_CARD(v, p) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \
 233                 PCCARD_P(v, p), PCCARD_C(v, p) }
 234
 235 /*
 236  * Defines to decode the get_funce_disk return value.  See the PCMCIA standard
 237  * for all the details of what these bits mean.
 238  */
 239 #define PFD_I_V_MASK            0x3
 240 #define PFD_I_V_NONE_REQUIRED   0x0
 241 #define PFD_I_V_REQ_MOD_ACC     0x1
 242 #define PFD_I_V_REQ_ACC         0x2
 243 #define PFD_I_V_REQ_ALWYS       0x1
 244 #define PFD_I_S                 0x4     /* 0 rotating, 1 silicon */
 245 #define PFD_I_U                 0x8     /* SN Uniq? */
 246 #define PFD_I_D                 0x10    /* 0 - 1 drive, 1 - 2 drives */
 247 #define PFD_P_P0                0x100
 248 #define PFD_P_P1                0x200
 249 #define PFD_P_P2                0x400
 250 #define PFD_P_P3                0x800
 251 #define PFD_P_N                 0x1000  /* 3f7/377 excluded? */
 252 #define PFD_P_E                 0x2000  /* Index bit supported? */
 253 #define PFD_P_I                 0x4000  /* twincard */