cardbusvar.h revision 1.41
1 /* $NetBSD: cardbusvar.h,v 1.41 2008/06/24 19:44:52 drochner 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 struct { 44 int dummy; 45 } cardbus_chipset_tag; 46 47 typedef struct cardbus_chipset_tag *cardbus_chipset_tag_t; 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, 93 cardbus_intr_line_t, int, 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 bus_space_tag_t cba_iot; /* cardbus i/o space tag */ 134 bus_space_tag_t cba_memt; /* cardbus mem space tag */ 135 bus_dma_tag_t cba_dmat; /* DMA tag */ 136 137 int cba_bus; /* cardbus bus number */ 138 139 cardbus_chipset_tag_t cba_cc; /* cardbus chipset */ 140 cardbus_function_tag_t cba_cf; /* cardbus functions */ 141 cardbus_intr_line_t cba_intrline; /* interrupt line */ 142 143 #if rbus 144 rbus_tag_t cba_rbus_iot; /* CardBus i/o rbus tag */ 145 rbus_tag_t cba_rbus_memt; /* CardBus mem rbus tag */ 146 #endif 147 148 int cba_cacheline; /* cache line size */ 149 int cba_max_lattimer; /* No card's latency timer may 150 * exceed this. On a PCI-Cardbus 151 * bridge, I let the latency timer on 152 * the primary bus (PCI bus) set 153 * the maximum. That is kind of an 154 * arbitrary choice. A more sensible 155 * choice may be either the 156 * latency timer on the primary bus, 157 * or the bridge's buffer size, 158 * whichever is larger. 159 */ 160 }; 161 162 163 struct cardbus_devfunc; 164 165 /* 166 * struct cardbus_softc is the softc for cardbus card. 167 */ 168 struct cardbus_softc { 169 struct device sc_dev; /* fundamental device structure */ 170 171 int sc_bus; /* cardbus bus number */ 172 cardbus_intr_line_t sc_intrline; /* CardBus intrline */ 173 174 bus_space_tag_t sc_iot; /* CardBus I/O space tag */ 175 bus_space_tag_t sc_memt; /* CardBus MEM space tag */ 176 bus_dma_tag_t sc_dmat; /* DMA tag */ 177 178 cardbus_chipset_tag_t sc_cc; /* CardBus chipset */ 179 cardbus_function_tag_t sc_cf; /* CardBus function */ 180 181 #if rbus 182 rbus_tag_t sc_rbus_iot; /* CardBus i/o rbus tag */ 183 rbus_tag_t sc_rbus_memt; /* CardBus mem rbus tag */ 184 #endif 185 186 int sc_cacheline; /* cache line size */ 187 int sc_max_lattimer; /* No card's latency timer 188 * may exceed this. On a PCI-Cardbus 189 * bridge, the latency timer on 190 * the primary bus (PCI bus) sets 191 * the maximum. 192 */ 193 int sc_volt; /* applied Vcc voltage */ 194 #define PCCARD_33V 0x02 195 #define PCCARD_XXV 0x04 196 #define PCCARD_YYV 0x08 197 int sc_poweron_func; 198 struct cardbus_devfunc *sc_funcs[8]; /* list of cardbus device functions */ 199 }; 200 201 struct cardbus_conf_state { 202 cardbusreg_t reg[16]; 203 }; 204 205 /* 206 * struct cardbus_devfunc: 207 * 208 * This is the data deposit for each function of a CardBus device. 209 * This structure is used for memory or i/o space allocation and 210 * disallocation. 211 */ 212 typedef struct cardbus_devfunc { 213 cardbus_chipset_tag_t ct_cc; 214 cardbus_function_tag_t ct_cf; 215 struct cardbus_softc *ct_sc; /* pointer to the parent */ 216 int ct_bus; /* bus number */ 217 int ct_func; /* function number */ 218 219 #if rbus 220 rbus_tag_t ct_rbus_iot; /* CardBus i/o rbus tag */ 221 rbus_tag_t ct_rbus_memt; /* CardBus mem rbus tag */ 222 #endif 223 224 cardbusreg_t ct_bar[6]; /* Base Address Regs 0 to 6 */ 225 cardbusreg_t ct_bhlc; /* Latency timer and cache line size */ 226 /* u_int32_t ct_cisreg; */ /* CIS reg: is it needed??? */ 227 228 device_t ct_device; /* pointer to the device */ 229 230 /* some data structure needed for tuple??? */ 231 } *cardbus_devfunc_t; 232 233 234 /* XXX various things extracted from CIS */ 235 struct cardbus_cis_info { 236 int32_t manufacturer; 237 int32_t product; 238 char cis1_info_buf[256]; 239 char* cis1_info[4]; 240 struct cb_bar_info { 241 unsigned int flags; 242 unsigned int size; 243 } bar[7]; 244 unsigned int funcid; 245 union { 246 struct { 247 int uart_type; 248 int uart_present; 249 } serial; 250 struct { 251 char netid[6]; 252 char netid_present; 253 char __filler; 254 } network; 255 } funce; 256 }; 257 258 struct cardbus_attach_args { 259 cardbus_devfunc_t ca_ct; 260 261 bus_space_tag_t ca_iot; /* CardBus I/O space tag */ 262 bus_space_tag_t ca_memt; /* CardBus MEM space tag */ 263 bus_dma_tag_t ca_dmat; /* DMA tag */ 264 265 u_int ca_bus; 266 u_int ca_function; 267 cardbustag_t ca_tag; 268 cardbusreg_t ca_id; 269 cardbusreg_t ca_class; 270 271 /* interrupt information */ 272 cardbus_intr_line_t ca_intrline; 273 274 #if rbus 275 rbus_tag_t ca_rbus_iot; /* CardBus i/o rbus tag */ 276 rbus_tag_t ca_rbus_memt; /* CardBus mem rbus tag */ 277 #endif 278 279 struct cardbus_cis_info ca_cis; 280 }; 281 282 283 #define CARDBUS_ENABLE 1 /* enable the channel */ 284 #define CARDBUS_DISABLE 2 /* disable the channel */ 285 #define CARDBUS_RESET 4 286 #define CARDBUS_CD 7 287 # define CARDBUS_NOCARD 0 288 # define CARDBUS_5V_CARD 0x01 /* XXX: It must not exist */ 289 # define CARDBUS_3V_CARD 0x02 290 # define CARDBUS_XV_CARD 0x04 291 # define CARDBUS_YV_CARD 0x08 292 #define CARDBUS_IO_ENABLE 100 293 #define CARDBUS_IO_DISABLE 101 294 #define CARDBUS_MEM_ENABLE 102 295 #define CARDBUS_MEM_DISABLE 103 296 #define CARDBUS_BM_ENABLE 104 /* bus master */ 297 #define CARDBUS_BM_DISABLE 105 298 299 #define CARDBUS_VCC_UC 0x0000 300 #define CARDBUS_VCC_3V 0x0001 301 #define CARDBUS_VCC_XV 0x0002 302 #define CARDBUS_VCC_YV 0x0003 303 #define CARDBUS_VCC_0V 0x0004 304 #define CARDBUS_VCC_5V 0x0005 /* ??? */ 305 #define CARDBUS_VCCMASK 0x000f 306 #define CARDBUS_VPP_UC 0x0000 307 #define CARDBUS_VPP_VCC 0x0010 308 #define CARDBUS_VPP_12V 0x0030 309 #define CARDBUS_VPP_0V 0x0040 310 #define CARDBUS_VPPMASK 0x00f0 311 312 313 int cardbus_attach_card(struct cardbus_softc *); 314 void cardbus_detach_card(struct cardbus_softc *); 315 void *cardbus_intr_establish(cardbus_chipset_tag_t, cardbus_function_tag_t, 316 cardbus_intr_line_t, int, int (*) (void *), void *arg); 317 void cardbus_intr_disestablish(cardbus_chipset_tag_t, 318 cardbus_function_tag_t, void *); 319 320 int cardbus_mapreg_map(struct cardbus_softc *, int, int, cardbusreg_t, 321 int, bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *, bus_size_t *); 322 int cardbus_mapreg_unmap(struct cardbus_softc *, int, int, 323 bus_space_tag_t, bus_space_handle_t, bus_size_t); 324 325 int cardbus_save_bar(cardbus_devfunc_t); 326 int cardbus_restore_bar(cardbus_devfunc_t); 327 328 int cardbus_function_enable(struct cardbus_softc *, int); 329 int cardbus_function_disable(struct cardbus_softc *, int); 330 331 void cardbus_disable_retry(cardbus_chipset_tag_t, cardbus_function_tag_t, 332 cardbustag_t); 333 334 int cardbus_get_capability(cardbus_chipset_tag_t, cardbus_function_tag_t, 335 cardbustag_t, int, int *, cardbusreg_t *); 336 int cardbus_get_powerstate(cardbus_devfunc_t, cardbustag_t, cardbusreg_t *); 337 int cardbus_set_powerstate(cardbus_devfunc_t, cardbustag_t, cardbusreg_t); 338 339 void cardbus_conf_capture(cardbus_chipset_tag_t, cardbus_function_tag_t, 340 cardbustag_t, struct cardbus_conf_state *); 341 void cardbus_conf_restore(cardbus_chipset_tag_t, cardbus_function_tag_t, 342 cardbustag_t, struct cardbus_conf_state *); 343 344 #define Cardbus_function_enable(ct) cardbus_function_enable((ct)->ct_sc, (ct)->ct_func) 345 #define Cardbus_function_disable(ct) cardbus_function_disable((ct)->ct_sc, (ct)->ct_func) 346 347 348 349 #define Cardbus_mapreg_map(ct, reg, type, busflags, tagp, handlep, basep, sizep) \ 350 cardbus_mapreg_map((ct)->ct_sc, (ct->ct_func), (reg), (type),\ 351 (busflags), (tagp), (handlep), (basep), (sizep)) 352 #define Cardbus_mapreg_unmap(ct, reg, tag, handle, size) \ 353 cardbus_mapreg_unmap((ct)->ct_sc, (ct->ct_func), (reg), (tag), (handle), (size)) 354 355 #define Cardbus_make_tag(ct) (*(ct)->ct_cf->cardbus_make_tag)((ct)->ct_cc, (ct)->ct_bus, (ct)->ct_func) 356 #define cardbus_make_tag(cc, cf, bus, function) ((cf)->cardbus_make_tag)((cc), (bus), (function)) 357 358 #define Cardbus_free_tag(ct, tag) (*(ct)->ct_cf->cardbus_free_tag)((ct)->ct_cc, (tag)) 359 #define cardbus_free_tag(cc, cf, tag) (*(cf)->cardbus_free_tag)(cc, (tag)) 360 361 #define Cardbus_conf_read(ct, tag, offs) (*(ct)->ct_cf->cardbus_conf_read)((ct)->ct_cc, (tag), (offs)) 362 #define cardbus_conf_read(cc, cf, tag, offs) ((cf)->cardbus_conf_read)((cc), (tag), (offs)) 363 #define Cardbus_conf_write(ct, tag, offs, val) (*(ct)->ct_cf->cardbus_conf_write)((ct)->ct_cc, (tag), (offs), (val)) 364 #define cardbus_conf_write(cc, cf, tag, offs, val) ((cf)->cardbus_conf_write)((cc), (tag), (offs), (val)) 365 366 #endif /* !_DEV_CARDBUS_CARDBUSVAR_H_ */ 367
Indexes created Tue Sep 30 11:09:46 GMT 2025