cardbusvar.h revision 1.55
1 /* $NetBSD: cardbusvar.h,v 1.55 2011/08/01 11:20:27 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 * 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 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 107 rbus_tag_t cba_rbus_iot; /* CardBus i/o rbus tag */ 108 rbus_tag_t cba_rbus_memt; /* CardBus mem rbus tag */ 109 110 int cba_cacheline; /* cache line size */ 111 int cba_max_lattimer; /* No card's latency timer may 112 * exceed this. On a PCI-Cardbus 113 * bridge, I let the latency timer on 114 * the primary bus (PCI bus) set 115 * the maximum. That is kind of an 116 * arbitrary choice. A more sensible 117 * choice may be either the 118 * latency timer on the primary bus, 119 * or the bridge's buffer size, 120 * whichever is larger. 121 */ 122 }; 123 124 125 struct cardbus_devfunc; 126 127 /* 128 * struct cardbus_softc is the softc for cardbus card. 129 */ 130 struct cardbus_softc { 131 device_t sc_dev; /* fundamental device structure */ 132 133 int sc_bus; /* cardbus bus number */ 134 135 bus_space_tag_t sc_iot; /* CardBus I/O space tag */ 136 bus_space_tag_t sc_memt; /* CardBus MEM space tag */ 137 bus_dma_tag_t sc_dmat; /* DMA tag */ 138 139 cardbus_chipset_tag_t sc_cc; /* CardBus chipset */ 140 cardbus_function_tag_t sc_cf; /* CardBus function */ 141 142 rbus_tag_t sc_rbus_iot; /* CardBus i/o rbus tag */ 143 rbus_tag_t sc_rbus_memt; /* CardBus mem rbus tag */ 144 145 int sc_cacheline; /* cache line size */ 146 int sc_max_lattimer; /* No card's latency timer 147 * may exceed this. On a PCI-Cardbus 148 * bridge, the latency timer on 149 * the primary bus (PCI bus) sets 150 * the maximum. 151 */ 152 int sc_poweron_func; 153 struct cardbus_devfunc *sc_funcs[8]; /* list of cardbus device functions */ 154 }; 155 156 struct cardbus_conf_state { 157 pcireg_t reg[16]; 158 }; 159 160 /* 161 * struct cardbus_devfunc: 162 * 163 * This is the data deposit for each function of a CardBus device. 164 * This structure is used for memory or i/o space allocation and 165 * disallocation. 166 */ 167 typedef struct cardbus_devfunc { 168 cardbus_chipset_tag_t ct_cc; 169 cardbus_function_tag_t ct_cf; 170 struct cardbus_softc *ct_sc; /* pointer to the parent */ 171 int ct_bus; /* bus number */ 172 int ct_func; /* function number */ 173 174 pcireg_t ct_bhlc; /* Latency timer and cache line size */ 175 /* u_int32_t ct_cisreg; */ /* CIS reg: is it needed??? */ 176 177 device_t ct_device; /* pointer to the device */ 178 179 /* some data structure needed for tuple??? */ 180 } *cardbus_devfunc_t; 181 182 183 /* XXX various things extracted from CIS */ 184 struct cardbus_cis_info { 185 int32_t manufacturer; 186 int32_t product; 187 char cis1_info_buf[256]; 188 char* cis1_info[4]; 189 struct cb_bar_info { 190 unsigned int flags; 191 unsigned int size; 192 } bar[7]; 193 unsigned int funcid; 194 union { 195 struct { 196 int uart_type; 197 int uart_present; 198 } serial; 199 struct { 200 char netid[6]; 201 char netid_present; 202 char __filler; 203 } network; 204 } funce; 205 }; 206 207 struct cardbus_attach_args { 208 cardbus_devfunc_t ca_ct; 209 210 bus_space_tag_t ca_iot; /* CardBus I/O space tag */ 211 bus_space_tag_t ca_memt; /* CardBus MEM space tag */ 212 bus_dma_tag_t ca_dmat; /* DMA tag */ 213 214 u_int ca_bus; 215 u_int ca_function; 216 pcitag_t ca_tag; 217 pcireg_t ca_id; 218 pcireg_t ca_class; 219 220 rbus_tag_t ca_rbus_iot; /* CardBus i/o rbus tag */ 221 rbus_tag_t ca_rbus_memt; /* CardBus mem rbus tag */ 222 223 struct cardbus_cis_info ca_cis; 224 }; 225 226 227 #define CARDBUS_ENABLE 1 /* enable the channel */ 228 #define CARDBUS_DISABLE 2 /* disable the channel */ 229 #define CARDBUS_RESET 4 230 #define CARDBUS_CD 7 231 # define CARDBUS_NOCARD 0 232 # define CARDBUS_5V_CARD 0x01 /* XXX: It must not exist */ 233 # define CARDBUS_3V_CARD 0x02 234 # define CARDBUS_XV_CARD 0x04 235 # define CARDBUS_YV_CARD 0x08 236 #define CARDBUS_IO_ENABLE 100 237 #define CARDBUS_IO_DISABLE 101 238 #define CARDBUS_MEM_ENABLE 102 239 #define CARDBUS_MEM_DISABLE 103 240 #define CARDBUS_BM_ENABLE 104 /* bus master */ 241 #define CARDBUS_BM_DISABLE 105 242 243 #define CARDBUS_VCC_UC 0x0000 244 #define CARDBUS_VCC_3V 0x0001 245 #define CARDBUS_VCC_XV 0x0002 246 #define CARDBUS_VCC_YV 0x0003 247 #define CARDBUS_VCC_0V 0x0004 248 #define CARDBUS_VCC_5V 0x0005 /* ??? */ 249 #define CARDBUS_VCCMASK 0x000f 250 #define CARDBUS_VPP_UC 0x0000 251 #define CARDBUS_VPP_VCC 0x0010 252 #define CARDBUS_VPP_12V 0x0030 253 #define CARDBUS_VPP_0V 0x0040 254 #define CARDBUS_VPPMASK 0x00f0 255 256 257 int cardbus_attach_card(struct cardbus_softc *); 258 void cardbus_detach_card(struct cardbus_softc *); 259 void *Cardbus_intr_establish(cardbus_devfunc_t, 260 int, int (*)(void *), void *); 261 void Cardbus_intr_disestablish(cardbus_devfunc_t, void *); 262 void *cardbus_intr_establish(cardbus_chipset_tag_t, cardbus_function_tag_t, 263 int, int (*) (void *), void *arg); 264 void cardbus_intr_disestablish(cardbus_chipset_tag_t, cardbus_function_tag_t, 265 void *); 266 267 int cardbus_mapreg_map(struct cardbus_softc *, int, int, pcireg_t, 268 int, bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *, bus_size_t *); 269 int cardbus_mapreg_unmap(struct cardbus_softc *, int, int, 270 bus_space_tag_t, bus_space_handle_t, bus_size_t); 271 272 int cardbus_function_enable(struct cardbus_softc *, int); 273 int cardbus_function_disable(struct cardbus_softc *, int); 274 275 int cardbus_get_capability(cardbus_chipset_tag_t, cardbus_function_tag_t, 276 pcitag_t, int, int *, pcireg_t *); 277 int cardbus_get_powerstate(cardbus_devfunc_t, pcitag_t, pcireg_t *); 278 int cardbus_set_powerstate(cardbus_devfunc_t, pcitag_t, pcireg_t); 279 280 void cardbus_conf_capture(cardbus_chipset_tag_t, cardbus_function_tag_t, 281 pcitag_t, struct cardbus_conf_state *); 282 void cardbus_conf_restore(cardbus_chipset_tag_t, cardbus_function_tag_t, 283 pcitag_t, struct cardbus_conf_state *); 284 285 #define Cardbus_function_enable(ct) cardbus_function_enable((ct)->ct_sc, (ct)->ct_func) 286 #define Cardbus_function_disable(ct) cardbus_function_disable((ct)->ct_sc, (ct)->ct_func) 287 288 289 290 #define Cardbus_mapreg_map(ct, reg, type, busflags, tagp, handlep, basep, sizep) \ 291 cardbus_mapreg_map((ct)->ct_sc, (ct->ct_func), (reg), (type),\ 292 (busflags), (tagp), (handlep), (basep), (sizep)) 293 #define Cardbus_mapreg_unmap(ct, reg, tag, handle, size) \ 294 cardbus_mapreg_unmap((ct)->ct_sc, (ct->ct_func), (reg), (tag), (handle), (size)) 295 296 #define Cardbus_make_tag(ct) (*(ct)->ct_cf->cardbus_make_tag)((ct)->ct_cc, (ct)->ct_bus, (ct)->ct_func) 297 #define cardbus_make_tag(cc, cf, bus, function) ((cf)->cardbus_make_tag)((cc), (bus), (function)) 298 299 #define Cardbus_conf_read(ct, tag, offs) (*(ct)->ct_cf->cardbus_conf_read)((ct)->ct_cc, (tag), (offs)) 300 #define cardbus_conf_read(cc, cf, tag, offs) ((cf)->cardbus_conf_read)((cc), (tag), (offs)) 301 #define Cardbus_conf_write(ct, tag, offs, val) (*(ct)->ct_cf->cardbus_conf_write)((ct)->ct_cc, (tag), (offs), (val)) 302 #define cardbus_conf_write(cc, cf, tag, offs, val) ((cf)->cardbus_conf_write)((cc), (tag), (offs), (val)) 303 304 #endif /* !_DEV_CARDBUS_CARDBUSVAR_H_ */ 305
Indexes created Wed Oct 01 07:09:59 GMT 2025