cardbusvar.h revision 1.32
1 /* $NetBSD: cardbusvar.h,v 1.32 2005/02/27 00:26:59 perry 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 devno, 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 int); 100 void (*cardbus_free_tag)(cardbus_chipset_tag_t, cardbustag_t); 101 cardbusreg_t (*cardbus_conf_read)(cardbus_chipset_tag_t, 102 cardbustag_t, int); 103 void (*cardbus_conf_write)(cardbus_chipset_tag_t, cardbustag_t, 104 int, cardbusreg_t); 105 } cardbus_function_t, *cardbus_function_tag_t; 106 107 #else 108 109 typedef struct cardbus_functions { 110 int (*cardbus_ctrl)(cardbus_chipset_tag_t, int); 111 int (*cardbus_power)(cardbus_chipset_tag_t, int); 112 int (*cardbus_mem_open)(cardbus_chipset_tag_t, int, u_int32_t, 113 u_int32_t); 114 int (*cardbus_mem_close)(cardbus_chipset_tag_t, int); 115 int (*cardbus_io_open)(cardbus_chipset_tag_t, int, u_int32_t, 116 u_int32_t); 117 int (*cardbus_io_close)(cardbus_chipset_tag_t, int); 118 void *(*cardbus_intr_establish)(cardbus_chipset_tag_t, int, int, 119 int (*)(void *), void *); 120 void (*cardbus_intr_disestablish)(cardbus_chipset_tag_t, void *); 121 122 cardbustag_t (*cardbus_make_tag)(cardbus_chipset_tag_t, int, int, 123 int); 124 cardbusreg_t (*cardbus_conf_read)(cardbus_chipset_tag_t, 125 cardbustag_t, int); 126 void (*cardbus_conf_write)(cardbus_chipset_tag_t, cardbustag_t, 127 int, cardbusreg_t); 128 } cardbus_function_t, *cardbus_function_tag_t; 129 #endif /* rbus */ 130 131 /* 132 * struct cbslot_attach_args is the attach argument for cardbus card. 133 */ 134 struct cbslot_attach_args { 135 char *cba_busname; 136 bus_space_tag_t cba_iot; /* cardbus i/o space tag */ 137 bus_space_tag_t cba_memt; /* cardbus mem space tag */ 138 bus_dma_tag_t cba_dmat; /* DMA tag */ 139 140 int cba_bus; /* cardbus bus number */ 141 142 cardbus_chipset_tag_t cba_cc; /* cardbus chipset */ 143 cardbus_function_tag_t cba_cf; /* cardbus functions */ 144 int cba_intrline; /* interrupt line */ 145 146 #if rbus 147 rbus_tag_t cba_rbus_iot; /* CardBus i/o rbus tag */ 148 rbus_tag_t cba_rbus_memt; /* CardBus mem rbus tag */ 149 #endif 150 151 int cba_cacheline; /* cache line size */ 152 int cba_lattimer; /* latency timer */ 153 }; 154 155 156 struct cardbus_devfunc; 157 158 /* 159 * struct cardbus_softc is the softc for cardbus card. 160 */ 161 struct cardbus_softc { 162 struct device sc_dev; /* fundamental device structure */ 163 164 int sc_bus; /* cardbus bus number */ 165 int sc_device; /* cardbus device number */ 166 int sc_intrline; /* CardBus intrline */ 167 168 bus_space_tag_t sc_iot; /* CardBus I/O space tag */ 169 bus_space_tag_t sc_memt; /* CardBus MEM space tag */ 170 bus_dma_tag_t sc_dmat; /* DMA tag */ 171 172 cardbus_chipset_tag_t sc_cc; /* CardBus chipset */ 173 cardbus_function_tag_t sc_cf; /* CardBus function */ 174 175 #if rbus 176 rbus_tag_t sc_rbus_iot; /* CardBus i/o rbus tag */ 177 rbus_tag_t sc_rbus_memt; /* CardBus mem rbus tag */ 178 #endif 179 180 int sc_cacheline; /* cache line size */ 181 int sc_lattimer; /* latency timer */ 182 int sc_volt; /* applied Vcc voltage */ 183 #define PCCARD_33V 0x02 184 #define PCCARD_XXV 0x04 185 #define PCCARD_YYV 0x08 186 int sc_poweron_func; 187 struct cardbus_devfunc *sc_funcs[8]; /* list of cardbus device functions */ 188 }; 189 190 191 /* 192 * struct cardbus_devfunc: 193 * 194 * This is the data deposit for each function of a CardBus device. 195 * This structure is used for memory or i/o space allocation and 196 * disallocation. 197 */ 198 typedef struct cardbus_devfunc { 199 cardbus_chipset_tag_t ct_cc; 200 cardbus_function_tag_t ct_cf; 201 struct cardbus_softc *ct_sc; /* pointer to the parent */ 202 int ct_bus; /* bus number */ 203 int ct_dev; /* device number */ 204 int ct_func; /* function number */ 205 206 #if rbus 207 rbus_tag_t ct_rbus_iot; /* CardBus i/o rbus tag */ 208 rbus_tag_t ct_rbus_memt; /* CardBus mem rbus tag */ 209 #endif 210 211 u_int32_t ct_bar[6]; /* Base Address Regs 0 to 6 */ 212 u_int32_t ct_lc; /* Latency timer and cache line size */ 213 /* u_int32_t ct_cisreg; */ /* CIS reg: is it needed??? */ 214 215 struct device *ct_device; /* pointer to the device */ 216 217 /* some data structure needed for tuple??? */ 218 } *cardbus_devfunc_t; 219 220 221 /* XXX various things extracted from CIS */ 222 struct cardbus_cis_info { 223 int32_t manufacturer; 224 int32_t product; 225 char cis1_info_buf[256]; 226 char* cis1_info[4]; 227 struct cb_bar_info { 228 unsigned int flags; 229 unsigned int size; 230 } bar[7]; 231 unsigned int funcid; 232 union { 233 struct { 234 int uart_type; 235 int uart_present; 236 } serial; 237 struct { 238 char netid[6]; 239 char netid_present; 240 char __filler; 241 } network; 242 } funce; 243 }; 244 245 struct cardbus_attach_args { 246 cardbus_devfunc_t ca_ct; 247 248 bus_space_tag_t ca_iot; /* CardBus I/O space tag */ 249 bus_space_tag_t ca_memt; /* CardBus MEM space tag */ 250 bus_dma_tag_t ca_dmat; /* DMA tag */ 251 252 u_int ca_bus; 253 u_int ca_device; 254 u_int ca_function; 255 cardbustag_t ca_tag; 256 cardbusreg_t ca_id; 257 cardbusreg_t ca_class; 258 259 /* interrupt information */ 260 cardbus_intr_line_t ca_intrline; 261 262 #if rbus 263 rbus_tag_t ca_rbus_iot; /* CardBus i/o rbus tag */ 264 rbus_tag_t ca_rbus_memt; /* CardBus mem rbus tag */ 265 #endif 266 267 struct cardbus_cis_info ca_cis; 268 }; 269 270 271 #define CARDBUS_ENABLE 1 /* enable the channel */ 272 #define CARDBUS_DISABLE 2 /* disable the channel */ 273 #define CARDBUS_RESET 4 274 #define CARDBUS_CD 7 275 # define CARDBUS_NOCARD 0 276 # define CARDBUS_5V_CARD 0x01 /* XXX: It must not exist */ 277 # define CARDBUS_3V_CARD 0x02 278 # define CARDBUS_XV_CARD 0x04 279 # define CARDBUS_YV_CARD 0x08 280 #define CARDBUS_IO_ENABLE 100 281 #define CARDBUS_IO_DISABLE 101 282 #define CARDBUS_MEM_ENABLE 102 283 #define CARDBUS_MEM_DISABLE 103 284 #define CARDBUS_BM_ENABLE 104 /* bus master */ 285 #define CARDBUS_BM_DISABLE 105 286 287 #define CARDBUS_VCC_UC 0x0000 288 #define CARDBUS_VCC_3V 0x0001 289 #define CARDBUS_VCC_XV 0x0002 290 #define CARDBUS_VCC_YV 0x0003 291 #define CARDBUS_VCC_0V 0x0004 292 #define CARDBUS_VCC_5V 0x0005 /* ??? */ 293 #define CARDBUS_VCCMASK 0x000f 294 #define CARDBUS_VPP_UC 0x0000 295 #define CARDBUS_VPP_VCC 0x0010 296 #define CARDBUS_VPP_12V 0x0030 297 #define CARDBUS_VPP_0V 0x0040 298 #define CARDBUS_VPPMASK 0x00f0 299 300 301 int cardbus_attach_card(struct cardbus_softc *); 302 void cardbus_detach_card(struct cardbus_softc *); 303 void *cardbus_intr_establish(cardbus_chipset_tag_t, cardbus_function_tag_t, 304 cardbus_intr_handle_t, int, int (*) (void *), void *arg); 305 void cardbus_intr_disestablish(cardbus_chipset_tag_t, 306 cardbus_function_tag_t, void *); 307 308 int cardbus_mapreg_map(struct cardbus_softc *, int, int, cardbusreg_t, 309 int, bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *, bus_size_t *); 310 int cardbus_mapreg_unmap(struct cardbus_softc *, int, int, 311 bus_space_tag_t, bus_space_handle_t, bus_size_t); 312 313 int cardbus_save_bar(cardbus_devfunc_t); 314 int cardbus_restore_bar(cardbus_devfunc_t); 315 316 int cardbus_function_enable(struct cardbus_softc *, int); 317 int cardbus_function_disable(struct cardbus_softc *, int); 318 319 int cardbus_get_capability(cardbus_chipset_tag_t, cardbus_function_tag_t, 320 cardbustag_t, int, int *, cardbusreg_t *); 321 int cardbus_powerstate(cardbus_devfunc_t, pcitag_t, const int *, int *); 322 int cardbus_setpowerstate(const char *, cardbus_devfunc_t, pcitag_t, int); 323 324 #define Cardbus_function_enable(ct) cardbus_function_enable((ct)->ct_sc, (ct)->ct_func) 325 #define Cardbus_function_disable(ct) cardbus_function_disable((ct)->ct_sc, (ct)->ct_func) 326 327 328 329 #define Cardbus_mapreg_map(ct, reg, type, busflags, tagp, handlep, basep, sizep) \ 330 cardbus_mapreg_map((ct)->ct_sc, (ct->ct_func), (reg), (type),\ 331 (busflags), (tagp), (handlep), (basep), (sizep)) 332 #define Cardbus_mapreg_unmap(ct, reg, tag, handle, size) \ 333 cardbus_mapreg_unmap((ct)->ct_sc, (ct->ct_func), (reg), (tag), (handle), (size)) 334 335 #define Cardbus_make_tag(ct) (*(ct)->ct_cf->cardbus_make_tag)((ct)->ct_cc, (ct)->ct_bus, (ct)->ct_dev, (ct)->ct_func) 336 #define cardbus_make_tag(cc, cf, bus, device, function) ((cf)->cardbus_make_tag)((cc), (bus), (device), (function)) 337 338 #define Cardbus_free_tag(ct, tag) (*(ct)->ct_cf->cardbus_free_tag)((ct)->ct_cc, (tag)) 339 #define cardbus_free_tag(cc, cf, tag) (*(cf)->cardbus_free_tag)(cc, (tag)) 340 341 #define Cardbus_conf_read(ct, tag, offs) (*(ct)->ct_cf->cardbus_conf_read)((ct)->ct_cf, (tag), (offs)) 342 #define cardbus_conf_read(cc, cf, tag, offs) ((cf)->cardbus_conf_read)((cc), (tag), (offs)) 343 #define Cardbus_conf_write(ct, tag, offs, val) (*(ct)->ct_cf->cardbus_conf_write)((ct)->ct_cf, (tag), (offs), (val)) 344 #define cardbus_conf_write(cc, cf, tag, offs, val) ((cf)->cardbus_conf_write)((cc), (tag), (offs), (val)) 345 346 #endif /* !_DEV_CARDBUS_CARDBUSVAR_H_ */ 347
Indexes created Tue Sep 30 20:09:53 GMT 2025