1 /* $NetBSD: pcmciavar.h,v 1.15 2001/12/15 13:23:23 soren Exp $ */ 2 3 /* 4 * Copyright (c) 1997 Marc Horowitz. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Marc Horowitz. 17 * 4. The name of the author may not be used to endorse or promote products 18 * derived from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #include <sys/types.h> 33 #include <sys/queue.h> 34 35 #include <dev/pcmcia/pcmciachip.h> 36 37 extern int pcmcia_verbose; 38 39 /* 40 * Contains information about mapped/allocated i/o spaces. 41 */ 42 struct pcmcia_io_handle { 43 bus_space_tag_t iot; /* bus space tag (from chipset) */ 44 bus_space_handle_t ioh; /* mapped space handle */ 45 bus_addr_t addr; /* resulting address in bus space */ 46 bus_size_t size; /* size of i/o space */ 47 int flags; /* misc. information */ 48 }; 49 50 #define PCMCIA_IO_ALLOCATED 0x01 /* i/o space was allocated */ 51 52 /* 53 * Contains information about allocated memory space. 54 */ 55 struct pcmcia_mem_handle { 56 bus_space_tag_t memt; /* bus space tag (from chipset) */ 57 bus_space_handle_t memh; /* mapped space handle */ 58 bus_addr_t addr; /* resulting address in bus space */ 59 bus_size_t size; /* size of mem space */ 60 pcmcia_mem_handle_t mhandle; /* opaque memory handle */ 61 bus_size_t realsize; /* how much we really allocated */ 62 }; 63 64 /* pcmcia itself */ 65 66 #define PCMCIA_CFE_MWAIT_REQUIRED 0x0001 67 #define PCMCIA_CFE_RDYBSY_ACTIVE 0x0002 68 #define PCMCIA_CFE_WP_ACTIVE 0x0004 69 #define PCMCIA_CFE_BVD_ACTIVE 0x0008 70 #define PCMCIA_CFE_IO8 0x0010 71 #define PCMCIA_CFE_IO16 0x0020 72 #define PCMCIA_CFE_IRQSHARE 0x0040 73 #define PCMCIA_CFE_IRQPULSE 0x0080 74 #define PCMCIA_CFE_IRQLEVEL 0x0100 75 #define PCMCIA_CFE_POWERDOWN 0x0200 76 #define PCMCIA_CFE_READONLY 0x0400 77 #define PCMCIA_CFE_AUDIO 0x0800 78 79 struct pcmcia_config_entry { 80 int number; 81 u_int32_t flags; 82 int iftype; 83 int num_iospace; 84 85 /* 86 * The card will only decode this mask in any case, so we can 87 * do dynamic allocation with this in mind, in case the suggestions 88 * below are no good. 89 */ 90 u_long iomask; 91 struct { 92 u_long length; 93 u_long start; 94 } iospace[4]; /* XXX this could be as high as 16 */ 95 u_int16_t irqmask; 96 int num_memspace; 97 struct { 98 u_long length; 99 u_long cardaddr; 100 u_long hostaddr; 101 } memspace[2]; /* XXX this could be as high as 8 */ 102 int maxtwins; 103 SIMPLEQ_ENTRY(pcmcia_config_entry) cfe_list; 104 }; 105 106 107 struct pcmcia_funce_disk { 108 int pfd_interface; 109 }; 110 111 struct pcmcia_funce_lan { 112 int pfl_nidlen; 113 u_int8_t pfl_nid[8]; 114 }; 115 116 union pcmcia_funce { 117 struct pcmcia_funce_disk pfv_disk; 118 struct pcmcia_funce_lan pfv_lan; 119 }; 120 121 122 struct pcmcia_function { 123 /* read off the card */ 124 int number; 125 int function; 126 int last_config_index; 127 u_long ccr_base; 128 u_long ccr_mask; 129 SIMPLEQ_HEAD(, pcmcia_config_entry) cfe_head; 130 SIMPLEQ_ENTRY(pcmcia_function) pf_list; 131 /* run-time state */ 132 struct pcmcia_softc *sc; 133 struct device *child; 134 struct pcmcia_config_entry *cfe; 135 struct pcmcia_mem_handle pf_pcmh; 136 #define pf_ccrt pf_pcmh.memt 137 #define pf_ccrh pf_pcmh.memh 138 #define pf_ccr_mhandle pf_pcmh.mhandle 139 #define pf_ccr_realsize pf_pcmh.realsize 140 bus_size_t pf_ccr_offset; 141 int pf_ccr_window; 142 long pf_mfc_iobase; 143 long pf_mfc_iomax; 144 int (*ih_fct) __P((void *)); 145 void *ih_arg; 146 int ih_ipl; 147 int pf_flags; 148 149 union pcmcia_funce pf_funce; /* CISTPL_FUNCE */ 150 #define pf_funce_disk_interface pf_funce.pfv_disk.pfd_interface 151 #define pf_funce_lan_nid pf_funce.pfv_lan.pfl_nid 152 #define pf_funce_lan_nidlen pf_funce.pfv_lan.pfl_nidlen 153 }; 154 155 /* pf_flags */ 156 #define PFF_ENABLED 0x0001 /* function is enabled */ 157 158 struct pcmcia_card { 159 int cis1_major; 160 int cis1_minor; 161 /* XXX waste of space? */ 162 char cis1_info_buf[256]; 163 char *cis1_info[4]; 164 /* 165 * Use int32_t for manufacturer and product so that they can 166 * hold the id value found in card CIS and special value that 167 * indicates no id was found. 168 */ 169 int32_t manufacturer; 170 #define PCMCIA_VENDOR_INVALID -1 171 int32_t product; 172 #define PCMCIA_PRODUCT_INVALID -1 173 u_int16_t error; 174 #define PCMCIA_CIS_INVALID { NULL, NULL, NULL, NULL } 175 SIMPLEQ_HEAD(, pcmcia_function) pf_head; 176 }; 177 178 struct pcmcia_softc { 179 struct device dev; 180 181 /* this stuff is for the socket */ 182 pcmcia_chipset_tag_t pct; 183 pcmcia_chipset_handle_t pch; 184 185 /* this stuff is for the card */ 186 struct pcmcia_card card; 187 void *ih; 188 int sc_enabled_count; /* how many functions are 189 enabled */ 190 191 /* 192 * These are passed down from the PCMCIA chip, and exist only 193 * so that cards with Very Special address allocation needs 194 * know what range they should be dealing with. 195 */ 196 bus_addr_t iobase; /* start i/o space allocation here */ 197 bus_size_t iosize; /* size of the i/o space range */ 198 }; 199 200 struct pcmcia_cis_quirk { 201 int32_t manufacturer; 202 int32_t product; 203 const char *cis1_info[4]; 204 const struct pcmcia_function *pf; 205 const struct pcmcia_config_entry *cfe; 206 }; 207 208 struct pcmcia_attach_args { 209 int32_t manufacturer; 210 int32_t product; 211 struct pcmcia_card *card; 212 struct pcmcia_function *pf; 213 }; 214 215 struct pcmcia_tuple { 216 unsigned int code; 217 unsigned int length; 218 u_long mult; 219 bus_size_t ptr; 220 bus_space_tag_t memt; 221 bus_space_handle_t memh; 222 }; 223 224 struct pcmcia_product { 225 const char *pp_name; /* NULL if end of table */ 226 u_int32_t pp_vendor; 227 u_int32_t pp_product; 228 int pp_expfunc; 229 }; 230 231 typedef int (*pcmcia_product_match_fn) __P((struct pcmcia_attach_args *pa, 232 const struct pcmcia_product *ent, int vpfmatch)); 233 234 const struct pcmcia_product 235 *pcmcia_product_lookup __P((struct pcmcia_attach_args *pa, 236 const struct pcmcia_product *tab, size_t ent_size, 237 pcmcia_product_match_fn matchfn)); 238 239 void pcmcia_devinfo __P((struct pcmcia_card *card, int showhex, char *cp, 240 int cplen)); 241 242 void pcmcia_read_cis __P((struct pcmcia_softc *)); 243 void pcmcia_check_cis_quirks __P((struct pcmcia_softc *)); 244 void pcmcia_print_cis __P((struct pcmcia_softc *)); 245 int pcmcia_scan_cis __P((struct device * dev, 246 int (*) (struct pcmcia_tuple *, void *), void *)); 247 248 #define pcmcia_cis_read_1(tuple, idx0) \ 249 (bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0))) 250 251 #define pcmcia_tuple_read_1(tuple, idx1) \ 252 (pcmcia_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1))))) 253 254 #define pcmcia_tuple_read_2(tuple, idx2) \ 255 (pcmcia_tuple_read_1((tuple), (idx2)) | \ 256 (pcmcia_tuple_read_1((tuple), (idx2)+1)<<8)) 257 258 #define pcmcia_tuple_read_3(tuple, idx3) \ 259 (pcmcia_tuple_read_1((tuple), (idx3)) | \ 260 (pcmcia_tuple_read_1((tuple), (idx3)+1)<<8) | \ 261 (pcmcia_tuple_read_1((tuple), (idx3)+2)<<16)) 262 263 #define pcmcia_tuple_read_4(tuple, idx4) \ 264 (pcmcia_tuple_read_1((tuple), (idx4)) | \ 265 (pcmcia_tuple_read_1((tuple), (idx4)+1)<<8) | \ 266 (pcmcia_tuple_read_1((tuple), (idx4)+2)<<16) | \ 267 (pcmcia_tuple_read_1((tuple), (idx4)+3)<<24)) 268 269 #define pcmcia_tuple_read_n(tuple, n, idxn) \ 270 (((n)==1)?pcmcia_tuple_read_1((tuple), (idxn)) : \ 271 (((n)==2)?pcmcia_tuple_read_2((tuple), (idxn)) : \ 272 (((n)==3)?pcmcia_tuple_read_3((tuple), (idxn)) : \ 273 /* n == 4 */ pcmcia_tuple_read_4((tuple), (idxn))))) 274 275 #define PCMCIA_SPACE_MEMORY 1 276 #define PCMCIA_SPACE_IO 2 277 278 int pcmcia_ccr_read __P((struct pcmcia_function *, int)); 279 void pcmcia_ccr_write __P((struct pcmcia_function *, int, int)); 280 281 #define pcmcia_mfc(sc) ((sc)->card.pf_head.sqh_first && \ 282 (sc)->card.pf_head.sqh_first->pf_list.sqe_next) 283 284 void pcmcia_function_init __P((struct pcmcia_function *, 285 struct pcmcia_config_entry *)); 286 int pcmcia_function_enable __P((struct pcmcia_function *)); 287 void pcmcia_function_disable __P((struct pcmcia_function *)); 288 289 #define pcmcia_io_alloc(pf, start, size, align, pciop) \ 290 (pcmcia_chip_io_alloc((pf)->sc->pct, pf->sc->pch, (start), \ 291 (size), (align), (pciop))) 292 293 #define pcmcia_io_free(pf, pciohp) \ 294 (pcmcia_chip_io_free((pf)->sc->pct, (pf)->sc->pch, (pciohp))) 295 296 int pcmcia_io_map __P((struct pcmcia_function *, int, bus_addr_t, 297 bus_size_t, struct pcmcia_io_handle *, int *)); 298 void pcmcia_io_unmap __P((struct pcmcia_function *, int)); 299 300 #define pcmcia_mem_alloc(pf, size, pcmhp) \ 301 (pcmcia_chip_mem_alloc((pf)->sc->pct, (pf)->sc->pch, (size), (pcmhp))) 302 303 #define pcmcia_mem_free(pf, pcmhp) \ 304 (pcmcia_chip_mem_free((pf)->sc->pct, (pf)->sc->pch, (pcmhp))) 305 306 #define pcmcia_mem_map(pf, kind, card_addr, size, pcmhp, offsetp, windowp) \ 307 (pcmcia_chip_mem_map((pf)->sc->pct, (pf)->sc->pch, (kind), \ 308 (card_addr), (size), (pcmhp), (offsetp), (windowp))) 309 310 #define pcmcia_mem_unmap(pf, window) \ 311 (pcmcia_chip_mem_unmap((pf)->sc->pct, (pf)->sc->pch, (window))) 312 313 void *pcmcia_intr_establish __P((struct pcmcia_function *, int, 314 int (*) (void *), void *)); 315 void pcmcia_intr_disestablish __P((struct pcmcia_function *, void *)); 316