cardbusvar.h revision 1.37
1 /* $NetBSD: cardbusvar.h,v 1.37 2007/12/09 20:27:55 jmcneill 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/cardbus/cardbusreg.h> 39 #if 1 40 #include <dev/cardbus/rbus.h> 41 #endif 42 43 44 45 typedef void *cardbus_chipset_tag_t; 46 typedef int cardbus_intr_handle_t; 47 48 49 #if rbus 50 /* 51 * struct cardbus_functions contains the pointers for basic cardbus 52 * functions. Those functions must be provided by cardbus bridge. 53 * The child devices can use those functions. The contained functions 54 * are: cardbus_space_alloc, cardbus_space_free, 55 * cardbus_intr_establish, cardbus_intr_disestablish, cardbus_ctrl, 56 * cardbus_power, cardbus_make_tag, cardbus_free_tag and 57 * cardbus_conf_write. 58 * 59 * int (*cardbus_space_alloc)(cardbus_chipset_tag_t ct, rbus_tag_t rb, 60 * bus_addr_t addr, bus_size_t size, 61 * bus_addr_t mask, bus_size_t align, 62 * int flags, bus_addr_t *addrp, 63 * bus_space_handle_t *bshp); 64 * 65 * int (*cardbus_space_free)(cardbus_chipset_tag_t ct, rbus_tag_t rb, 66 * bus_space_handle_t, bus_size_t); 67 * 68 * cardbus_space_alloc and cardbus_space_free allocates and 69 * disallocate bus space for the requesters. 70 * 71 * void *(*cardbus_intr_establish)(cardbus_chipset_tag_t ct, int irq, 72 * int level, int (*ih)(void *), void *sc); 73 * 74 * void (*cardbus_intr_disestablish)(cardbus_chipset_tag_t ct, void *ih); 75 * int (*cardbus_ctrl)(cardbus_chipset_tag_t ct, int command); 76 * int (*cardbus_power)(cardbus_chipset_tag_t ct, int voltage); 77 * 78 * cardbustag_t (*cardbus_make_tag)(cardbus_chipset_tag_t ct, 79 * int busno, int functionno); 80 * void (*cardbus_free_tag)(cardbus_chipset_tag_t ct, cardbustag_t tag); 81 * cardbusreg_t (*cardbus_conf_read)(cardbus_chipset_tag_t ct, 82 * cardbustag_t tag, int offs); 83 * void (*cardbus_conf_write)(cardbus_chipset_tag_t ct, 84 * cardbustag_t tag, int offs, cardbusreg_t val); 85 */ 86 typedef struct cardbus_functions { 87 int (*cardbus_space_alloc)(cardbus_chipset_tag_t, rbus_tag_t, 88 bus_addr_t, bus_size_t, bus_addr_t, bus_size_t, 89 int, bus_addr_t *, bus_space_handle_t *); 90 int (*cardbus_space_free)(cardbus_chipset_tag_t, rbus_tag_t, 91 bus_space_handle_t, bus_size_t); 92 void *(*cardbus_intr_establish)(cardbus_chipset_tag_t, int, int, 93 int (*)(void *), void *); 94 void (*cardbus_intr_disestablish)(cardbus_chipset_tag_t, void *); 95 int (*cardbus_ctrl)(cardbus_chipset_tag_t, int); 96 int (*cardbus_power)(cardbus_chipset_tag_t, int); 97 98 cardbustag_t (*cardbus_make_tag)(cardbus_chipset_tag_t, int, int); 99 void (*cardbus_free_tag)(cardbus_chipset_tag_t, cardbustag_t); 100 cardbusreg_t (*cardbus_conf_read)(cardbus_chipset_tag_t, 101 cardbustag_t, int); 102 void (*cardbus_conf_write)(cardbus_chipset_tag_t, cardbustag_t, 103 int, cardbusreg_t); 104 } cardbus_function_t, *cardbus_function_tag_t; 105 106 #else 107 108 typedef struct cardbus_functions { 109 int (*cardbus_ctrl)(cardbus_chipset_tag_t, int); 110 int (*cardbus_power)(cardbus_chipset_tag_t, int); 111 int (*cardbus_mem_open)(cardbus_chipset_tag_t, int, u_int32_t, 112 u_int32_t); 113 int (*cardbus_mem_close)(cardbus_chipset_tag_t, int); 114 int (*cardbus_io_open)(cardbus_chipset_tag_t, int, u_int32_t, 115 u_int32_t); 116 int (*cardbus_io_close)(cardbus_chipset_tag_t, int); 117 void *(*cardbus_intr_establish)(cardbus_chipset_tag_t, int, int, 118 int (*)(void *), void *); 119 void (*cardbus_intr_disestablish)(cardbus_chipset_tag_t, void *); 120 121 cardbustag_t (*cardbus_make_tag)(cardbus_chipset_tag_t, int, int); 122 cardbusreg_t (*cardbus_conf_read)(cardbus_chipset_tag_t, 123 cardbustag_t, int); 124 void (*cardbus_conf_write)(cardbus_chipset_tag_t, cardbustag_t, 125 int, cardbusreg_t); 126 } cardbus_function_t, *cardbus_function_tag_t; 127 #endif /* rbus */ 128 129 /* 130 * struct cbslot_attach_args is the attach argument for Cardbus cardslot. 131 */ 132 struct cbslot_attach_args { 133 const char *cba_busname; 134 bus_space_tag_t cba_iot; /* cardbus i/o space tag */ 135 bus_space_tag_t cba_memt; /* cardbus mem space tag */ 136 bus_dma_tag_t cba_dmat; /* DMA tag */ 137 138 int cba_bus; /* cardbus bus number */ 139 140 cardbus_chipset_tag_t cba_cc; /* cardbus chipset */ 141 cardbus_function_tag_t cba_cf; /* cardbus functions */ 142 int cba_intrline; /* interrupt line */ 143 144 #if rbus 145 rbus_tag_t cba_rbus_iot; /* CardBus i/o rbus tag */ 146 rbus_tag_t cba_rbus_memt; /* CardBus mem rbus tag */ 147 #endif 148 149 int cba_cacheline; /* cache line size */ 150 int cba_max_lattimer; /* No card's latency timer may 151 * exceed this. On a PCI-Cardbus 152 * bridge, I let the latency timer on 153 * the primary bus (PCI bus) set 154 * the maximum. That is kind of an 155 * arbitrary choice. A more sensible 156 * choice may be either the 157 * latency timer on the primary bus, 158 * or the bridge's buffer size, 159 * whichever is larger. 160 */ 161 }; 162 163 164 struct cardbus_devfunc; 165 166 /* 167 * struct cardbus_softc is the softc for cardbus card. 168 */ 169 struct cardbus_softc { 170 struct device sc_dev; /* fundamental device structure */ 171 172 int sc_bus; /* cardbus bus number */ 173 int sc_intrline; /* CardBus intrline */ 174 175 bus_space_tag_t sc_iot; /* CardBus I/O space tag */ 176 bus_space_tag_t sc_memt; /* CardBus MEM space tag */ 177 bus_dma_tag_t sc_dmat; /* DMA tag */ 178 179 cardbus_chipset_tag_t sc_cc; /* CardBus chipset */ 180 cardbus_function_tag_t sc_cf; /* CardBus function */ 181 182 #if rbus 183 rbus_tag_t sc_rbus_iot; /* CardBus i/o rbus tag */ 184 rbus_tag_t sc_rbus_memt; /* CardBus mem rbus tag */ 185 #endif 186 187 int sc_cacheline; /* cache line size */ 188 int sc_max_lattimer; /* No card's latency timer 189 * may exceed this. On a PCI-Cardbus 190 * bridge, the latency timer on 191 * the primary bus (PCI bus) sets 192 * the maximum. 193 */ 194 int sc_volt; /* applied Vcc voltage */ 195 #define PCCARD_33V 0x02 196 #define PCCARD_XXV 0x04 197 #define PCCARD_YYV 0x08 198 int sc_poweron_func; 199 struct cardbus_devfunc *sc_funcs[8]; /* list of cardbus device functions */ 200 }; 201 202 struct cardbus_conf_state { 203 cardbusreg_t reg[16]; 204 }; 205 206 /* 207 * struct cardbus_devfunc: 208 * 209 * This is the data deposit for each function of a CardBus device. 210 * This structure is used for memory or i/o space allocation and 211 * disallocation. 212 */ 213 typedef struct cardbus_devfunc { 214 cardbus_chipset_tag_t ct_cc; 215 cardbus_function_tag_t ct_cf; 216 struct cardbus_softc *ct_sc; /* pointer to the parent */ 217 int ct_bus; /* bus number */ 218 int ct_func; /* function number */ 219 220 #if rbus 221 rbus_tag_t ct_rbus_iot; /* CardBus i/o rbus tag */ 222 rbus_tag_t ct_rbus_memt; /* CardBus mem rbus tag */ 223 #endif 224 225 cardbusreg_t ct_bar[6]; /* Base Address Regs 0 to 6 */ 226 cardbusreg_t ct_bhlc; /* Latency timer and cache line size */ 227 /* u_int32_t ct_cisreg; */ /* CIS reg: is it needed??? */ 228 229 struct device *ct_device; /* pointer to the device */ 230 231 /* some data structure needed for tuple??? */ 232 } *cardbus_devfunc_t; 233 234 235 /* XXX various things extracted from CIS */ 236 struct cardbus_cis_info { 237 int32_t manufacturer; 238 int32_t product; 239 char cis1_info_buf[256]; 240 char* cis1_info[4]; 241 struct cb_bar_info { 242 unsigned int flags; 243 unsigned int size; 244 } bar[7]; 245 unsigned int funcid; 246 union { 247 struct { 248 int uart_type; 249 int uart_present; 250 } serial; 251 struct { 252 char netid[6]; 253 char netid_present; 254 char __filler; 255 } network; 256 } funce; 257 }; 258 259 struct cardbus_attach_args { 260 cardbus_devfunc_t ca_ct; 261 262 bus_space_tag_t ca_iot; /* CardBus I/O space tag */ 263 bus_space_tag_t ca_memt; /* CardBus MEM space tag */ 264 bus_dma_tag_t ca_dmat; /* DMA tag */ 265 266 u_int ca_bus; 267 u_int ca_function; 268 cardbustag_t ca_tag; 269 cardbusreg_t ca_id; 270 cardbusreg_t ca_class; 271 272 /* interrupt information */ 273 cardbus_intr_line_t ca_intrline; 274 275 #if rbus 276 rbus_tag_t ca_rbus_iot; /* CardBus i/o rbus tag */ 277 rbus_tag_t ca_rbus_memt; /* CardBus mem rbus tag */ 278 #endif 279 280 struct cardbus_cis_info ca_cis; 281 }; 282 283 284 #define CARDBUS_ENABLE 1 /* enable the channel */ 285 #define CARDBUS_DISABLE 2 /* disable the channel */ 286 #define CARDBUS_RESET 4 287 #define CARDBUS_CD 7 288 # define CARDBUS_NOCARD 0 289 # define CARDBUS_5V_CARD 0x01 /* XXX: It must not exist */ 290 # define CARDBUS_3V_CARD 0x02 291 # define CARDBUS_XV_CARD 0x04 292 # define CARDBUS_YV_CARD 0x08 293 #define CARDBUS_IO_ENABLE 100 294 #define CARDBUS_IO_DISABLE 101 295 #define CARDBUS_MEM_ENABLE 102 296 #define CARDBUS_MEM_DISABLE 103 297 #define CARDBUS_BM_ENABLE 104 /* bus master */ 298 #define CARDBUS_BM_DISABLE 105 299 300 #define CARDBUS_VCC_UC 0x0000 301 #define CARDBUS_VCC_3V 0x0001 302 #define CARDBUS_VCC_XV 0x0002 303 #define CARDBUS_VCC_YV 0x0003 304 #define CARDBUS_VCC_0V 0x0004 305 #define CARDBUS_VCC_5V 0x0005 /* ??? */ 306 #define CARDBUS_VCCMASK 0x000f 307 #define CARDBUS_VPP_UC 0x0000 308 #define CARDBUS_VPP_VCC 0x0010 309 #define CARDBUS_VPP_12V 0x0030 310 #define CARDBUS_VPP_0V 0x0040 311 #define CARDBUS_VPPMASK 0x00f0 312 313 314 int cardbus_attach_card(struct cardbus_softc *); 315 void cardbus_detach_card(struct cardbus_softc *); 316 void *cardbus_intr_establish(cardbus_chipset_tag_t, cardbus_function_tag_t, 317 cardbus_intr_handle_t, int, int (*) (void *), void *arg); 318 void cardbus_intr_disestablish(cardbus_chipset_tag_t, 319 cardbus_function_tag_t, void *); 320 321 int cardbus_mapreg_map(struct cardbus_softc *, int, int, cardbusreg_t, 322 int, bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *, bus_size_t *); 323 int cardbus_mapreg_unmap(struct cardbus_softc *, int, int, 324 bus_space_tag_t, bus_space_handle_t, bus_size_t); 325 326 int cardbus_save_bar(cardbus_devfunc_t); 327 int cardbus_restore_bar(cardbus_devfunc_t); 328 329 int cardbus_function_enable(struct cardbus_softc *, int); 330 int cardbus_function_disable(struct cardbus_softc *, int); 331 332 void cardbus_disable_retry(cardbus_chipset_tag_t, cardbus_function_tag_t, 333 cardbustag_t); 334 335 int cardbus_get_capability(cardbus_chipset_tag_t, cardbus_function_tag_t, 336 cardbustag_t, int, int *, cardbusreg_t *); 337 int cardbus_get_powerstate(cardbus_devfunc_t, cardbustag_t, cardbusreg_t *); 338 int cardbus_set_powerstate(cardbus_devfunc_t, cardbustag_t, cardbusreg_t); 339 340 void cardbus_conf_capture(cardbus_chipset_tag_t, cardbus_function_tag_t, 341 cardbustag_t, struct cardbus_conf_state *); 342 void cardbus_conf_restore(cardbus_chipset_tag_t, cardbus_function_tag_t, 343 cardbustag_t, struct cardbus_conf_state *); 344 345 #define Cardbus_function_enable(ct) cardbus_function_enable((ct)->ct_sc, (ct)->ct_func) 346 #define Cardbus_function_disable(ct) cardbus_function_disable((ct)->ct_sc, (ct)->ct_func) 347 348 349 350 #define Cardbus_mapreg_map(ct, reg, type, busflags, tagp, handlep, basep, sizep) \ 351 cardbus_mapreg_map((ct)->ct_sc, (ct->ct_func), (reg), (type),\ 352 (busflags), (tagp), (handlep), (basep), (sizep)) 353 #define Cardbus_mapreg_unmap(ct, reg, tag, handle, size) \ 354 cardbus_mapreg_unmap((ct)->ct_sc, (ct->ct_func), (reg), (tag), (handle), (size)) 355 356 #define Cardbus_make_tag(ct) (*(ct)->ct_cf->cardbus_make_tag)((ct)->ct_cc, (ct)->ct_bus, (ct)->ct_func) 357 #define cardbus_make_tag(cc, cf, bus, function) ((cf)->cardbus_make_tag)((cc), (bus), (function)) 358 359 #define Cardbus_free_tag(ct, tag) (*(ct)->ct_cf->cardbus_free_tag)((ct)->ct_cc, (tag)) 360 #define cardbus_free_tag(cc, cf, tag) (*(cf)->cardbus_free_tag)(cc, (tag)) 361 362 #define Cardbus_conf_read(ct, tag, offs) (*(ct)->ct_cf->cardbus_conf_read)((ct)->ct_cf, (tag), (offs)) 363 #define cardbus_conf_read(cc, cf, tag, offs) ((cf)->cardbus_conf_read)((cc), (tag), (offs)) 364 #define Cardbus_conf_write(ct, tag, offs, val) (*(ct)->ct_cf->cardbus_conf_write)((ct)->ct_cf, (tag), (offs), (val)) 365 #define cardbus_conf_write(cc, cf, tag, offs, val) ((cf)->cardbus_conf_write)((cc), (tag), (offs), (val)) 366 367 #endif /* !_DEV_CARDBUS_CARDBUSVAR_H_ */ 368
Indexes created Tue Sep 30 20:09:53 GMT 2025