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