cardbusvar.h revision 1.18
1 /* $NetBSD: cardbusvar.h,v 1.18 2000/04/13 10:11:15 joda Exp $ */ 2 3 /* 4 * Copyright (c) 1998, 1999 and 2000 5 * HAYAKAWA Koichi. 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 the author. 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 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 26 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #ifndef _DEV_CARDBUS_CARDBUSVAR_H_ 36 #define _DEV_CARDBUS_CARDBUSVAR_H_ 37 38 #include <dev/pci/pcivar.h> /* for pcitag_t */ 39 40 #if 1 41 #include <dev/cardbus/rbus.h> 42 #endif 43 44 45 46 typedef void *cardbus_chipset_tag_t; 47 typedef int cardbus_intr_handle_t; 48 49 50 /* XXX they must be in cardbusreg.h */ 51 typedef u_int32_t cardbusreg_t; 52 typedef pcitag_t cardbustag_t; 53 typedef int cardbus_intr_line_t; 54 55 #define CARDBUS_ID_REG 0x00 56 57 typedef u_int16_t cardbus_vendor_id_t; 58 typedef u_int16_t cardbus_product_id_t; 59 60 # define CARDBUS_VENDOR_SHIFT 0 61 # define CARDBUS_VENDOR_MASK 0xffff 62 # define CARDBUS_VENDOR(id) \ 63 (((id) >> CARDBUS_VENDOR_SHIFT) & CARDBUS_VENDOR_MASK) 64 65 # define CARDBUS_PRODUCT_SHIFT 16 66 # define CARDBUS_PRODUCT_MASK 0xffff 67 # define CARDBUS_PRODUCT(id) \ 68 (((id) >> CARDBUS_PRODUCT_SHIFT) & CARDBUS_PRODUCT_MASK) 69 70 71 #define CARDBUS_COMMAND_STATUS_REG 0x04 72 73 # define CARDBUS_COMMAND_IO_ENABLE 0x00000001 74 # define CARDBUS_COMMAND_MEM_ENABLE 0x00000002 75 # define CARDBUS_COMMAND_MASTER_ENABLE 0x00000004 76 77 78 #define CARDBUS_CLASS_REG 0x08 79 80 #define CARDBUS_CLASS_SHIFT 24 81 #define CARDBUS_CLASS_MASK 0xff 82 #define CARDBUS_CLASS(cr) \ 83 (((cr) >> CARDBUS_CLASS_SHIFT) & CARDBUS_CLASS_MASK) 84 85 #define CARDBUS_SUBCLASS_SHIFT 16 86 #define CARDBUS_SUBCLASS_MASK 0xff 87 #define CARDBUS_SUBCLASS(cr) \ 88 (((cr) >> CARDBUS_SUBCLASS_SHIFT) & CARDBUS_SUBCLASS_MASK) 89 90 #define CARDBUS_INTERFACE_SHIFT 8 91 #define CARDBUS_INTERFACE_MASK 0xff 92 #define CARDBUS_INTERFACE(cr) \ 93 (((cr) >> CARDBUS_INTERFACE_SHIFT) & CARDBUS_INTERFACE_MASK) 94 95 #define CARDBUS_REVISION_SHIFT 0 96 #define CARDBUS_REVISION_MASK 0xff 97 #define CARDBUS_REVISION(cr) \ 98 (((cr) >> CARDBUS_REVISION_SHIFT) & CARDBUS_REVISION_MASK) 99 100 /* base classes */ 101 #define CARDBUS_CLASS_PREHISTORIC 0x00 102 #define CARDBUS_CLASS_MASS_STORAGE 0x01 103 #define CARDBUS_CLASS_NETWORK 0x02 104 #define CARDBUS_CLASS_DISPLAY 0x03 105 #define CARDBUS_CLASS_MULTIMEDIA 0x04 106 #define CARDBUS_CLASS_MEMORY 0x05 107 #define CARDBUS_CLASS_BRIDGE 0x06 108 #define CARDBUS_CLASS_COMMUNICATIONS 0x07 109 #define CARDBUS_CLASS_SYSTEM 0x08 110 #define CARDBUS_CLASS_INPUT 0x09 111 #define CARDBUS_CLASS_DOCK 0x0a 112 #define CARDBUS_CLASS_PROCESSOR 0x0b 113 #define CARDBUS_CLASS_SERIALBUS 0x0c 114 #define CARDBUS_CLASS_UNDEFINED 0xff 115 116 /* 0x07 serial bus subclasses */ 117 #define CARDBUS_SUBCLASS_COMMUNICATIONS_SERIAL 0x00 118 119 /* 0x0c serial bus subclasses */ 120 #define CARDBUS_SUBCLASS_SERIALBUS_FIREWIRE 0x00 121 #define CARDBUS_SUBCLASS_SERIALBUS_ACCESS 0x01 122 #define CARDBUS_SUBCLASS_SERIALBUS_SSA 0x02 123 #define CARDBUS_SUBCLASS_SERIALBUS_USB 0x03 124 #define CARDBUS_SUBCLASS_SERIALBUS_FIBER 0x04 125 126 /* BIST, Header Type, Latency Timer, Cache Line Size */ 127 #define CARDBUS_BHLC_REG 0x0c 128 129 #define CARDBUS_BIST_SHIFT 24 130 #define CARDBUS_BIST_MASK 0xff 131 #define CARDBUS_BIST(bhlcr) \ 132 (((bhlcr) >> CARDBUS_BIST_SHIFT) & CARDBUS_BIST_MASK) 133 134 #define CARDBUS_HDRTYPE_SHIFT 16 135 #define CARDBUS_HDRTYPE_MASK 0xff 136 #define CARDBUS_HDRTYPE(bhlcr) \ 137 (((bhlcr) >> CARDBUS_HDRTYPE_SHIFT) & CARDBUS_HDRTYPE_MASK) 138 139 #define CARDBUS_HDRTYPE_TYPE(bhlcr) \ 140 (CARDBUS_HDRTYPE(bhlcr) & 0x7f) 141 #define CARDBUS_HDRTYPE_MULTIFN(bhlcr) \ 142 ((CARDBUS_HDRTYPE(bhlcr) & 0x80) != 0) 143 144 #define CARDBUS_LATTIMER_SHIFT 8 145 #define CARDBUS_LATTIMER_MASK 0xff 146 #define CARDBUS_LATTIMER(bhlcr) \ 147 (((bhlcr) >> CARDBUS_LATTIMER_SHIFT) & CARDBUS_LATTIMER_MASK) 148 149 #define CARDBUS_CACHELINE_SHIFT 0 150 #define CARDBUS_CACHELINE_MASK 0xff 151 #define CARDBUS_CACHELINE(bhlcr) \ 152 (((bhlcr) >> CARDBUS_CACHELINE_SHIFT) & CARDBUS_CACHELINE_MASK) 153 154 155 /* Base Resisters */ 156 #define CARDBUS_BASE0_REG 0x10 157 #define CARDBUS_BASE1_REG 0x14 158 #define CARDBUS_BASE2_REG 0x18 159 #define CARDBUS_BASE3_REG 0x1C 160 #define CARDBUS_BASE4_REG 0x20 161 #define CARDBUS_BASE5_REG 0x24 162 #define CARDBUS_CIS_REG 0x28 163 #define CARDBUS_ROM_REG 0x30 164 # define CARDBUS_CIS_ASIMASK 0x07 165 # define CARDBUS_CIS_ASI(x) (CARDBUS_CIS_ASIMASK & (x)) 166 # define CARDBUS_CIS_ASI_TUPLE 0x00 167 # define CARDBUS_CIS_ASI_BAR0 0x01 168 # define CARDBUS_CIS_ASI_BAR1 0x02 169 # define CARDBUS_CIS_ASI_BAR2 0x03 170 # define CARDBUS_CIS_ASI_BAR3 0x04 171 # define CARDBUS_CIS_ASI_BAR4 0x05 172 # define CARDBUS_CIS_ASI_BAR5 0x06 173 # define CARDBUS_CIS_ASI_ROM 0x07 174 # define CARDBUS_CIS_ADDRMASK 0x0ffffff8 175 # define CARDBUS_CIS_ADDR(x) (CARDBUS_CIS_ADDRMASK & (x)) 176 # define CARDBUS_CIS_ASI_BAR(x) (((CARDBUS_CIS_ASIMASK & (x))-1)*4+0x10) 177 # define CARDBUS_CIS_ASI_ROM_IMAGE(x) (((x) >> 28) & 0xf) 178 179 #define CARDBUS_INTERRUPT_REG 0x3c 180 181 #define CARDBUS_MAPREG_TYPE_MEM 0x00000000 182 #define CARDBUS_MAPREG_TYPE_IO 0x00000001 183 184 /* XXX end */ 185 186 #if rbus 187 188 typedef struct cardbus_functions { 189 int (*cardbus_space_alloc) __P((cardbus_chipset_tag_t, rbus_tag_t, 190 bus_addr_t addr, bus_size_t size, 191 bus_addr_t mask, bus_size_t align, 192 int flags, bus_addr_t *addrp, 193 bus_space_handle_t *bshp)); 194 int (*cardbus_space_free) __P((cardbus_chipset_tag_t, rbus_tag_t, 195 bus_space_handle_t, bus_size_t)); 196 void *(*cardbus_intr_establish) __P((cardbus_chipset_tag_t, int irq, int level, int (*ih)(void *), void *sc)); 197 void (*cardbus_intr_disestablish) __P((cardbus_chipset_tag_t ct, void *ih)); 198 int (*cardbus_ctrl) __P((cardbus_chipset_tag_t, int)); 199 int (*cardbus_power) __P((cardbus_chipset_tag_t, int)); 200 201 cardbustag_t (*cardbus_make_tag) __P((cardbus_chipset_tag_t, int, int, int)); 202 void (*cardbus_free_tag) __P((cardbus_chipset_tag_t, cardbustag_t)); 203 cardbusreg_t (*cardbus_conf_read) __P((cardbus_chipset_tag_t, cardbustag_t, int)); 204 void (*cardbus_conf_write) __P((cardbus_chipset_tag_t, cardbustag_t, int, cardbusreg_t)); 205 } cardbus_function_t, *cardbus_function_tag_t; 206 207 #else 208 209 typedef struct cardbus_functions { 210 int (*cardbus_ctrl) __P((cardbus_chipset_tag_t, int)); 211 int (*cardbus_power) __P((cardbus_chipset_tag_t, int)); 212 int (*cardbus_mem_open) __P((cardbus_chipset_tag_t, int, u_int32_t, u_int32_t)); 213 int (*cardbus_mem_close) __P((cardbus_chipset_tag_t, int)); 214 int (*cardbus_io_open) __P((cardbus_chipset_tag_t, int, u_int32_t, u_int32_t)); 215 int (*cardbus_io_close) __P((cardbus_chipset_tag_t, int)); 216 void *(*cardbus_intr_establish) __P((cardbus_chipset_tag_t, int irq, int level, int (*ih)(void *), void *sc)); 217 void (*cardbus_intr_disestablish) __P((cardbus_chipset_tag_t ct, void *ih)); 218 219 cardbustag_t (*cardbus_make_tag) __P((cardbus_chipset_tag_t, int, int, int)); cardbusreg_t (*cardbus_conf_read) __P((cardbus_chipset_tag_t, cardbustag_t, int)); 220 void (*cardbus_conf_write) __P((cardbus_chipset_tag_t, cardbustag_t, int, cardbusreg_t)); 221 } cardbus_function_t, *cardbus_function_tag_t; 222 #endif /* rbus */ 223 224 /* 225 * struct cbslot_attach_args is the attach argument for cardbus card. 226 */ 227 struct cbslot_attach_args { 228 char *cba_busname; 229 bus_space_tag_t cba_iot; /* cardbus i/o space tag */ 230 bus_space_tag_t cba_memt; /* cardbus mem space tag */ 231 bus_dma_tag_t cba_dmat; /* DMA tag */ 232 233 int cba_bus; /* cardbus bus number */ 234 235 cardbus_chipset_tag_t cba_cc; /* cardbus chipset */ 236 cardbus_function_tag_t cba_cf; /* cardbus functions */ 237 int cba_intrline; /* interrupt line */ 238 239 #if rbus 240 rbus_tag_t cba_rbus_iot; /* CardBus i/o rbus tag */ 241 rbus_tag_t cba_rbus_memt; /* CardBus mem rbus tag */ 242 #endif 243 244 int cba_cacheline; /* cache line size */ 245 int cba_lattimer; /* latency timer */ 246 }; 247 248 249 #define cbslotcf_dev cf_loc[0] 250 #define cbslotcf_func cf_loc[1] 251 #define CBSLOT_UNK_DEV -1 252 #define CBSLOT_UNK_FUNC -1 253 254 255 struct cardbus_devfunc; 256 257 /* 258 * struct cardbus_softc is the softc for cardbus card. 259 */ 260 struct cardbus_softc { 261 struct device sc_dev; /* fundamental device structure */ 262 263 int sc_bus; /* cardbus bus number */ 264 int sc_device; /* cardbus device number */ 265 int sc_intrline; /* CardBus intrline */ 266 267 bus_space_tag_t sc_iot; /* CardBus I/O space tag */ 268 bus_space_tag_t sc_memt; /* CardBus MEM space tag */ 269 bus_dma_tag_t sc_dmat; /* DMA tag */ 270 271 cardbus_chipset_tag_t sc_cc; /* CardBus chipset */ 272 cardbus_function_tag_t sc_cf; /* CardBus function */ 273 274 #if rbus 275 rbus_tag_t sc_rbus_iot; /* CardBus i/o rbus tag */ 276 rbus_tag_t sc_rbus_memt; /* CardBus mem rbus tag */ 277 #endif 278 279 int sc_cacheline; /* cache line size */ 280 int sc_lattimer; /* latency timer */ 281 int sc_volt; /* applied Vcc voltage */ 282 #define PCCARD_33V 0x02 283 #define PCCARD_XXV 0x04 284 #define PCCARD_YYV 0x08 285 int sc_poweron_func; 286 struct cardbus_devfunc *sc_funcs; /* list of cardbus device functions */ 287 }; 288 289 290 /* 291 * struct cardbus_devfunc: 292 * 293 * This is the data deposit for each function of a CardBus device. 294 * This structure is used for memory or i/o space allocation and 295 * disallocation. 296 */ 297 typedef struct cardbus_devfunc { 298 cardbus_chipset_tag_t ct_cc; 299 cardbus_function_tag_t ct_cf; 300 struct cardbus_softc *ct_sc; /* pointer to the parent */ 301 int ct_bus; /* bus number */ 302 int ct_dev; /* device number */ 303 int ct_func; /* function number */ 304 305 #if rbus 306 rbus_tag_t ct_rbus_iot; /* CardBus i/o rbus tag */ 307 rbus_tag_t ct_rbus_memt; /* CardBus mem rbus tag */ 308 #endif 309 310 u_int32_t ct_bar[6]; /* Base Address Regs 0 to 6 */ 311 u_int32_t ct_lc; /* Latency timer and cache line size */ 312 /* u_int32_t ct_cisreg; */ /* CIS reg: is it needed??? */ 313 314 struct device *ct_device; /* pointer to the device */ 315 316 struct cardbus_devfunc *ct_next; 317 318 /* some data structure needed for tuple??? */ 319 } *cardbus_devfunc_t; 320 321 322 /* XXX various things extracted from CIS */ 323 struct cardbus_cis_info { 324 int32_t manufacturer; 325 int32_t product; 326 char cis1_info_buf[256]; 327 char* cis1_info[4]; 328 struct cb_bar_info { 329 unsigned int flags; 330 unsigned int size; 331 } bar[7]; 332 unsigned int funcid; 333 union { 334 struct { 335 char netid[6]; 336 char netid_present; 337 char __filler; 338 } network; 339 } funce; 340 }; 341 342 struct cardbus_attach_args { 343 int ca_unit; 344 cardbus_devfunc_t ca_ct; 345 346 bus_space_tag_t ca_iot; /* CardBus I/O space tag */ 347 bus_space_tag_t ca_memt; /* CardBus MEM space tag */ 348 bus_dma_tag_t ca_dmat; /* DMA tag */ 349 350 u_int ca_device; 351 u_int ca_function; 352 cardbustag_t ca_tag; 353 cardbusreg_t ca_id; 354 cardbusreg_t ca_class; 355 356 /* interrupt information */ 357 cardbus_intr_line_t ca_intrline; 358 359 #if rbus 360 rbus_tag_t ca_rbus_iot; /* CardBus i/o rbus tag */ 361 rbus_tag_t ca_rbus_memt; /* CardBus mem rbus tag */ 362 #endif 363 364 struct cardbus_cis_info ca_cis; 365 }; 366 367 368 #define CARDBUS_ENABLE 1 /* enable the channel */ 369 #define CARDBUS_DISABLE 2 /* disable the channel */ 370 #define CARDBUS_RESET 4 371 #define CARDBUS_CD 7 372 # define CARDBUS_NOCARD 0 373 # define CARDBUS_5V_CARD 0x01 /* XXX: It must not exist */ 374 # define CARDBUS_3V_CARD 0x02 375 # define CARDBUS_XV_CARD 0x04 376 # define CARDBUS_YV_CARD 0x08 377 #define CARDBUS_IO_ENABLE 100 378 #define CARDBUS_IO_DISABLE 101 379 #define CARDBUS_MEM_ENABLE 102 380 #define CARDBUS_MEM_DISABLE 103 381 #define CARDBUS_BM_ENABLE 104 /* bus master */ 382 #define CARDBUS_BM_DISABLE 105 383 384 #define CARDBUS_VCC_UC 0x0000 385 #define CARDBUS_VCC_3V 0x0001 386 #define CARDBUS_VCC_XV 0x0002 387 #define CARDBUS_VCC_YV 0x0003 388 #define CARDBUS_VCC_0V 0x0004 389 #define CARDBUS_VCC_5V 0x0005 /* ??? */ 390 #define CARDBUS_VCCMASK 0x000f 391 #define CARDBUS_VPP_UC 0x0000 392 #define CARDBUS_VPP_VCC 0x0010 393 #define CARDBUS_VPP_12V 0x0030 394 #define CARDBUS_VPP_0V 0x0040 395 #define CARDBUS_VPPMASK 0x00f0 396 397 398 #include "locators.h" 399 400 /* 401 * Locators devies that attach to 'cardbus', as specified to config. 402 */ 403 #define cardbuscf_dev cf_loc[CARDBUSCF_DEV] 404 #define CARDBUS_UNK_DEV CARDBUSCF_DEV_DEFAULT 405 406 #define cardbuscf_function cf_loc[CARDBUSCF_FUNCTION] 407 #define CARDBUS_UNK_FUNCTION CARDBUSCF_FUNCTION_DEFAULT 408 409 int cardbus_attach_card __P((struct cardbus_softc *)); 410 void cardbus_detach_card __P((struct cardbus_softc *)); 411 void *cardbus_intr_establish __P((cardbus_chipset_tag_t, cardbus_function_tag_t, cardbus_intr_handle_t irq, int level, int (*func) (void *), void *arg)); 412 void cardbus_intr_disestablish __P((cardbus_chipset_tag_t, cardbus_function_tag_t, void *handler)); 413 414 int cardbus_mapreg_map __P((struct cardbus_softc *, int, int, cardbusreg_t, 415 int, bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *, bus_size_t *)); 416 int cardbus_mapreg_unmap __P((struct cardbus_softc *, int, int, 417 bus_space_tag_t, bus_space_handle_t, bus_size_t)); 418 419 int cardbus_save_bar __P((cardbus_devfunc_t)); 420 int cardbus_restore_bar __P((cardbus_devfunc_t)); 421 422 int cardbus_function_enable __P((struct cardbus_softc *, int function)); 423 int cardbus_function_disable __P((struct cardbus_softc *, int function)); 424 425 int cardbus_get_capability __P((cardbus_chipset_tag_t, cardbus_function_tag_t, 426 cardbustag_t, int, int *, cardbusreg_t *)); 427 428 #define Cardbus_function_enable(ct) cardbus_function_enable((ct)->ct_sc, (ct)->ct_func) 429 #define Cardbus_function_disable(ct) cardbus_function_disable((ct)->ct_sc, (ct)->ct_func) 430 431 432 433 #define Cardbus_mapreg_map(ct, reg, type, busflags, tagp, handlep, basep, sizep) \ 434 cardbus_mapreg_map((ct)->ct_sc, (ct->ct_func), (reg), (type),\ 435 (busflags), (tagp), (handlep), (basep), (sizep)) 436 #define Cardbus_mapreg_unmap(ct, reg, tag, handle, size) \ 437 cardbus_mapreg_unmap((ct)->ct_sc, (ct->ct_func), (reg), (tag), (handle), (size)) 438 439 #define Cardbus_make_tag(ct) (*(ct)->ct_cf->cardbus_make_tag)((ct)->ct_cc, (ct)->ct_bus, (ct)->ct_dev, (ct)->ct_func) 440 #define cardbus_make_tag(cc, cf, bus, device, function) ((cf)->cardbus_make_tag)((cc), (bus), (device), (function)) 441 442 #define Cardbus_free_tag(ct, tag) (*(ct)->ct_cf->cardbus_free_tag)((ct)->ct_cc, (tag)) 443 #define cardbus_free_tag(cc, cf, tag) (*(cf)->cardbus_free_tag)(cc, (tag)) 444 445 #define Cardbus_conf_read(ct, tag, offs) (*(ct)->ct_cf->cardbus_conf_read)((ct)->ct_cf, (tag), (offs)) 446 #define cardbus_conf_read(cc, cf, tag, offs) ((cf)->cardbus_conf_read)((cc), (tag), (offs)) 447 #define Cardbus_conf_write(ct, tag, offs, val) (*(ct)->ct_cf->cardbus_conf_write)((ct)->ct_cf, (tag), (offs), (val)) 448 #define cardbus_conf_write(cc, cf, tag, offs, val) ((cf)->cardbus_conf_write)((cc), (tag), (offs), (val)) 449 450 #endif /* !_DEV_CARDBUS_CARDBUSVAR_H_ */ 451
Indexes created Wed Oct 01 15:09:59 GMT 2025