cardbusvar.h revision 1.52
1 /* $NetBSD: cardbusvar.h,v 1.52 2010/03/15 19:43:17 dyoung 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 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef _DEV_CARDBUS_CARDBUSVAR_H_ 30 #define _DEV_CARDBUS_CARDBUSVAR_H_ 31 32 #include <dev/cardbus/cardbusreg.h> 33 #include <dev/cardbus/rbus.h> 34 35 struct { 36 int dummy; 37 } cardbus_chipset_tag; 38 39 typedef struct cardbus_chipset_tag *cardbus_chipset_tag_t; 40 41 /* 42 * struct cardbus_functions contains the pointers for basic cardbus 43 * functions. Those functions must be provided by cardbus bridge. 44 * The child devices can use those functions. The contained functions 45 * are: cardbus_space_alloc, cardbus_space_free, 46 * cardbus_intr_establish, cardbus_intr_disestablish, cardbus_ctrl, 47 * cardbus_power, cardbus_make_tag, and cardbus_conf_write. 48 * 49 * int (*cardbus_space_alloc)(cardbus_chipset_tag_t ct, rbus_tag_t rb, 50 * bus_addr_t addr, bus_size_t size, 51 * bus_addr_t mask, bus_size_t align, 52 * int flags, bus_addr_t *addrp, 53 * bus_space_handle_t *bshp); 54 * 55 * int (*cardbus_space_free)(cardbus_chipset_tag_t ct, rbus_tag_t rb, 56 * bus_space_handle_t, bus_size_t); 57 * 58 * cardbus_space_alloc and cardbus_space_free allocates and 59 * disallocate bus space for the requesters. 60 * 61 * void *(*cardbus_intr_establish)(cardbus_chipset_tag_t ct, int irq, 62 * int level, int (*ih)(void *), void *sc); 63 * 64 * void (*cardbus_intr_disestablish)(cardbus_chipset_tag_t ct, void *ih); 65 * int (*cardbus_ctrl)(cardbus_chipset_tag_t ct, int command); 66 * int (*cardbus_power)(cardbus_chipset_tag_t ct, int voltage); 67 * 68 * pcitag_t (*cardbus_make_tag)(cardbus_chipset_tag_t ct, 69 * int busno, int functionno); 70 * pcireg_t (*cardbus_conf_read)(cardbus_chipset_tag_t ct, 71 * pcitag_t tag, int offs); 72 * void (*cardbus_conf_write)(cardbus_chipset_tag_t ct, 73 * pcitag_t tag, int offs, pcireg_t val); 74 */ 75 typedef const struct cardbus_functions { 76 int (*cardbus_space_alloc)(cardbus_chipset_tag_t, rbus_tag_t, 77 bus_addr_t, bus_size_t, bus_addr_t, bus_size_t, 78 int, bus_addr_t *, bus_space_handle_t *); 79 int (*cardbus_space_free)(cardbus_chipset_tag_t, rbus_tag_t, 80 bus_space_handle_t, bus_size_t); 81 void *(*cardbus_intr_establish)(cardbus_chipset_tag_t, 82 cardbus_intr_line_t, int, int (*)(void *), void *); 83 void (*cardbus_intr_disestablish)(cardbus_chipset_tag_t, void *); 84 int (*cardbus_ctrl)(cardbus_chipset_tag_t, int); 85 int (*cardbus_power)(cardbus_chipset_tag_t, int); 86 87 pcitag_t (*cardbus_make_tag)(cardbus_chipset_tag_t, int, int); 88 pcireg_t (*cardbus_conf_read)(cardbus_chipset_tag_t, 89 pcitag_t, int); 90 void (*cardbus_conf_write)(cardbus_chipset_tag_t, pcitag_t, 91 int, pcireg_t); 92 } cardbus_function_t, *cardbus_function_tag_t; 93 94 /* 95 * struct cbslot_attach_args is the attach argument for Cardbus cardslot. 96 */ 97 struct cbslot_attach_args { 98 bus_space_tag_t cba_iot; /* cardbus i/o space tag */ 99 bus_space_tag_t cba_memt; /* cardbus mem space tag */ 100 bus_dma_tag_t cba_dmat; /* DMA tag */ 101 102 int cba_bus; /* cardbus bus number */ 103 104 cardbus_chipset_tag_t cba_cc; /* cardbus chipset */ 105 cardbus_function_tag_t cba_cf; /* cardbus functions */ 106 cardbus_intr_line_t cba_intrline; /* interrupt line */ 107 108 rbus_tag_t cba_rbus_iot; /* CardBus i/o rbus tag */ 109 rbus_tag_t cba_rbus_memt; /* CardBus mem rbus tag */ 110 111 int cba_cacheline; /* cache line size */ 112 int cba_max_lattimer; /* No card's latency timer may 113 * exceed this. On a PCI-Cardbus 114 * bridge, I let the latency timer on 115 * the primary bus (PCI bus) set 116 * the maximum. That is kind of an 117 * arbitrary choice. A more sensible 118 * choice may be either the 119 * latency timer on the primary bus, 120 * or the bridge's buffer size, 121 * whichever is larger. 122 */ 123 }; 124 125 126 struct cardbus_devfunc; 127 128 /* 129 * struct cardbus_softc is the softc for cardbus card. 130 */ 131 struct cardbus_softc { 132 device_t sc_dev; /* fundamental device structure */ 133 134 int sc_bus; /* cardbus bus number */ 135 cardbus_intr_line_t sc_intrline; /* CardBus intrline */ 136 137 bus_space_tag_t sc_iot; /* CardBus I/O space tag */ 138 bus_space_tag_t sc_memt; /* CardBus MEM space tag */ 139 bus_dma_tag_t sc_dmat; /* DMA tag */ 140 141 cardbus_chipset_tag_t sc_cc; /* CardBus chipset */ 142 cardbus_function_tag_t sc_cf; /* CardBus function */ 143 144 rbus_tag_t sc_rbus_iot; /* CardBus i/o rbus tag */ 145 rbus_tag_t sc_rbus_memt; /* CardBus mem rbus tag */ 146 147 int sc_cacheline; /* cache line size */ 148 int sc_max_lattimer; /* No card's latency timer 149 * may exceed this. On a PCI-Cardbus 150 * bridge, the latency timer on 151 * the primary bus (PCI bus) sets 152 * the maximum. 153 */ 154 int sc_volt; /* applied Vcc voltage */ 155 #define PCCARD_33V 0x02 156 #define PCCARD_XXV 0x04 157 #define PCCARD_YYV 0x08 158 int sc_poweron_func; 159 struct cardbus_devfunc *sc_funcs[8]; /* list of cardbus device functions */ 160 }; 161 162 struct cardbus_conf_state { 163 pcireg_t reg[16]; 164 }; 165 166 /* 167 * struct cardbus_devfunc: 168 * 169 * This is the data deposit for each function of a CardBus device. 170 * This structure is used for memory or i/o space allocation and 171 * disallocation. 172 */ 173 typedef struct cardbus_devfunc { 174 cardbus_chipset_tag_t ct_cc; 175 cardbus_function_tag_t ct_cf; 176 struct cardbus_softc *ct_sc; /* pointer to the parent */ 177 int ct_bus; /* bus number */ 178 int ct_func; /* function number */ 179 180 pcireg_t ct_bar[6]; /* Base Address Regs 0 to 6 */ 181 pcireg_t ct_bhlc; /* Latency timer and cache line size */ 182 /* u_int32_t ct_cisreg; */ /* CIS reg: is it needed??? */ 183 184 device_t ct_device; /* pointer to the device */ 185 186 /* some data structure needed for tuple??? */ 187 } *cardbus_devfunc_t; 188 189 190 /* XXX various things extracted from CIS */ 191 struct cardbus_cis_info { 192 int32_t manufacturer; 193 int32_t product; 194 char cis1_info_buf[256]; 195 char* cis1_info[4]; 196 struct cb_bar_info { 197 unsigned int flags; 198 unsigned int size; 199 } bar[7]; 200 unsigned int funcid; 201 union { 202 struct { 203 int uart_type; 204 int uart_present; 205 } serial; 206 struct { 207 char netid[6]; 208 char netid_present; 209 char __filler; 210 } network; 211 } funce; 212 }; 213 214 struct cardbus_attach_args { 215 cardbus_devfunc_t ca_ct; 216 217 bus_space_tag_t ca_iot; /* CardBus I/O space tag */ 218 bus_space_tag_t ca_memt; /* CardBus MEM space tag */ 219 bus_dma_tag_t ca_dmat; /* DMA tag */ 220 221 u_int ca_bus; 222 u_int ca_function; 223 pcitag_t ca_tag; 224 pcireg_t ca_id; 225 pcireg_t ca_class; 226 227 /* interrupt information */ 228 cardbus_intr_line_t ca_intrline; 229 230 rbus_tag_t ca_rbus_iot; /* CardBus i/o rbus tag */ 231 rbus_tag_t ca_rbus_memt; /* CardBus mem rbus tag */ 232 233 struct cardbus_cis_info ca_cis; 234 }; 235 236 237 #define CARDBUS_ENABLE 1 /* enable the channel */ 238 #define CARDBUS_DISABLE 2 /* disable the channel */ 239 #define CARDBUS_RESET 4 240 #define CARDBUS_CD 7 241 # define CARDBUS_NOCARD 0 242 # define CARDBUS_5V_CARD 0x01 /* XXX: It must not exist */ 243 # define CARDBUS_3V_CARD 0x02 244 # define CARDBUS_XV_CARD 0x04 245 # define CARDBUS_YV_CARD 0x08 246 #define CARDBUS_IO_ENABLE 100 247 #define CARDBUS_IO_DISABLE 101 248 #define CARDBUS_MEM_ENABLE 102 249 #define CARDBUS_MEM_DISABLE 103 250 #define CARDBUS_BM_ENABLE 104 /* bus master */ 251 #define CARDBUS_BM_DISABLE 105 252 253 #define CARDBUS_VCC_UC 0x0000 254 #define CARDBUS_VCC_3V 0x0001 255 #define CARDBUS_VCC_XV 0x0002 256 #define CARDBUS_VCC_YV 0x0003 257 #define CARDBUS_VCC_0V 0x0004 258 #define CARDBUS_VCC_5V 0x0005 /* ??? */ 259 #define CARDBUS_VCCMASK 0x000f 260 #define CARDBUS_VPP_UC 0x0000 261 #define CARDBUS_VPP_VCC 0x0010 262 #define CARDBUS_VPP_12V 0x0030 263 #define CARDBUS_VPP_0V 0x0040 264 #define CARDBUS_VPPMASK 0x00f0 265 266 267 int cardbus_attach_card(struct cardbus_softc *); 268 void cardbus_detach_card(struct cardbus_softc *); 269 void *Cardbus_intr_establish(cardbus_devfunc_t, 270 cardbus_intr_line_t, int, int (*)(void *), void *); 271 void Cardbus_intr_disestablish(cardbus_devfunc_t, void *); 272 void *cardbus_intr_establish(cardbus_chipset_tag_t, cardbus_function_tag_t, 273 cardbus_intr_line_t, int, int (*) (void *), void *arg); 274 void cardbus_intr_disestablish(cardbus_chipset_tag_t, cardbus_function_tag_t, 275 void *); 276 277 int cardbus_mapreg_map(struct cardbus_softc *, int, int, pcireg_t, 278 int, bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *, bus_size_t *); 279 int cardbus_mapreg_unmap(struct cardbus_softc *, int, int, 280 bus_space_tag_t, bus_space_handle_t, bus_size_t); 281 282 int cardbus_save_bar(cardbus_devfunc_t); 283 int cardbus_restore_bar(cardbus_devfunc_t); 284 285 int cardbus_function_enable(struct cardbus_softc *, int); 286 int cardbus_function_disable(struct cardbus_softc *, int); 287 288 int cardbus_get_capability(cardbus_chipset_tag_t, cardbus_function_tag_t, 289 pcitag_t, int, int *, pcireg_t *); 290 int cardbus_get_powerstate(cardbus_devfunc_t, pcitag_t, pcireg_t *); 291 int cardbus_set_powerstate(cardbus_devfunc_t, pcitag_t, pcireg_t); 292 293 void cardbus_conf_capture(cardbus_chipset_tag_t, cardbus_function_tag_t, 294 pcitag_t, struct cardbus_conf_state *); 295 void cardbus_conf_restore(cardbus_chipset_tag_t, cardbus_function_tag_t, 296 pcitag_t, struct cardbus_conf_state *); 297 298 #define Cardbus_function_enable(ct) cardbus_function_enable((ct)->ct_sc, (ct)->ct_func) 299 #define Cardbus_function_disable(ct) cardbus_function_disable((ct)->ct_sc, (ct)->ct_func) 300 301 302 303 #define Cardbus_mapreg_map(ct, reg, type, busflags, tagp, handlep, basep, sizep) \ 304 cardbus_mapreg_map((ct)->ct_sc, (ct->ct_func), (reg), (type),\ 305 (busflags), (tagp), (handlep), (basep), (sizep)) 306 #define Cardbus_mapreg_unmap(ct, reg, tag, handle, size) \ 307 cardbus_mapreg_unmap((ct)->ct_sc, (ct->ct_func), (reg), (tag), (handle), (size)) 308 309 #define Cardbus_make_tag(ct) (*(ct)->ct_cf->cardbus_make_tag)((ct)->ct_cc, (ct)->ct_bus, (ct)->ct_func) 310 #define cardbus_make_tag(cc, cf, bus, function) ((cf)->cardbus_make_tag)((cc), (bus), (function)) 311 312 #define Cardbus_conf_read(ct, tag, offs) (*(ct)->ct_cf->cardbus_conf_read)((ct)->ct_cc, (tag), (offs)) 313 #define cardbus_conf_read(cc, cf, tag, offs) ((cf)->cardbus_conf_read)((cc), (tag), (offs)) 314 #define Cardbus_conf_write(ct, tag, offs, val) (*(ct)->ct_cf->cardbus_conf_write)((ct)->ct_cc, (tag), (offs), (val)) 315 #define cardbus_conf_write(cc, cf, tag, offs, val) ((cf)->cardbus_conf_write)((cc), (tag), (offs), (val)) 316 317 #endif /* !_DEV_CARDBUS_CARDBUSVAR_H_ */ 318
Indexes created Mon Oct 27 02:09:54 GMT 2025