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