pcmciavar.h revision 1.7
1 /* $NetBSD: pcmciavar.h,v 1.7 1998/11/17 08:49:13 thorpej 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 <machine/bus.h> 36 37 #include <dev/pcmcia/pcmciachip.h> 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 struct pcmcia_function { 107 /* read off the card */ 108 int number; 109 int function; 110 int last_config_index; 111 u_long ccr_base; 112 u_long ccr_mask; 113 SIMPLEQ_HEAD(, pcmcia_config_entry) cfe_head; 114 SIMPLEQ_ENTRY(pcmcia_function) pf_list; 115 /* run-time state */ 116 struct pcmcia_softc *sc; 117 struct device *child; 118 struct pcmcia_config_entry *cfe; 119 struct pcmcia_mem_handle pf_pcmh; 120 #define pf_ccrt pf_pcmh.memt 121 #define pf_ccrh pf_pcmh.memh 122 #define pf_ccr_mhandle pf_pcmh.mhandle 123 #define pf_ccr_realsize pf_pcmh.realsize 124 bus_addr_t pf_ccr_offset; 125 int pf_ccr_window; 126 long pf_mfc_iobase; 127 long pf_mfc_iomax; 128 int (*ih_fct) __P((void *)); 129 void *ih_arg; 130 int ih_ipl; 131 int pf_flags; 132 }; 133 134 /* pf_flags */ 135 #define PFF_ENABLED 0x0001 /* function is enabled */ 136 137 struct pcmcia_card { 138 int cis1_major; 139 int cis1_minor; 140 /* XXX waste of space? */ 141 char cis1_info_buf[256]; 142 char *cis1_info[4]; 143 /* 144 * Use int32_t for manufacturer and product so that they can 145 * hold the id value found in card CIS and special value that 146 * indicates no id was found. 147 */ 148 int32_t manufacturer; 149 #define PCMCIA_VENDOR_INVALID -1 150 int32_t product; 151 #define PCMCIA_PRODUCT_INVALID -1 152 u_int16_t error; 153 #define PCMCIA_CIS_INVALID { NULL, NULL, NULL, NULL } 154 SIMPLEQ_HEAD(, pcmcia_function) pf_head; 155 }; 156 157 struct pcmcia_softc { 158 struct device dev; 159 160 /* this stuff is for the socket */ 161 pcmcia_chipset_tag_t pct; 162 pcmcia_chipset_handle_t pch; 163 164 /* this stuff is for the card */ 165 struct pcmcia_card card; 166 void *ih; 167 int sc_enabled_count; /* how many functions are 168 enabled */ 169 170 /* 171 * These are passed down from the PCMCIA chip, and exist only 172 * so that cards with Very Special address allocation needs 173 * know what range they should be dealing with. 174 */ 175 bus_addr_t iobase; /* start i/o space allocation here */ 176 bus_size_t iosize; /* size of the i/o space range */ 177 }; 178 179 struct pcmcia_attach_args { 180 int32_t manufacturer; 181 int32_t product; 182 struct pcmcia_card *card; 183 struct pcmcia_function *pf; 184 }; 185 186 struct pcmcia_tuple { 187 unsigned int code; 188 unsigned int length; 189 u_long mult; 190 bus_addr_t ptr; 191 bus_space_tag_t memt; 192 bus_space_handle_t memh; 193 }; 194 195 void pcmcia_read_cis __P((struct pcmcia_softc *)); 196 void pcmcia_print_cis __P((struct pcmcia_softc *)); 197 int pcmcia_scan_cis __P((struct device * dev, 198 int (*) (struct pcmcia_tuple *, void *), void *)); 199 200 #define pcmcia_cis_read_1(tuple, idx0) \ 201 (bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0))) 202 203 #define pcmcia_tuple_read_1(tuple, idx1) \ 204 (pcmcia_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1))))) 205 206 #define pcmcia_tuple_read_2(tuple, idx2) \ 207 (pcmcia_tuple_read_1((tuple), (idx2)) | \ 208 (pcmcia_tuple_read_1((tuple), (idx2)+1)<<8)) 209 210 #define pcmcia_tuple_read_3(tuple, idx3) \ 211 (pcmcia_tuple_read_1((tuple), (idx3)) | \ 212 (pcmcia_tuple_read_1((tuple), (idx3)+1)<<8) | \ 213 (pcmcia_tuple_read_1((tuple), (idx3)+2)<<16)) 214 215 #define pcmcia_tuple_read_4(tuple, idx4) \ 216 (pcmcia_tuple_read_1((tuple), (idx4)) | \ 217 (pcmcia_tuple_read_1((tuple), (idx4)+1)<<8) | \ 218 (pcmcia_tuple_read_1((tuple), (idx4)+2)<<16) | \ 219 (pcmcia_tuple_read_1((tuple), (idx4)+3)<<24)) 220 221 #define pcmcia_tuple_read_n(tuple, n, idxn) \ 222 (((n)==1)?pcmcia_tuple_read_1((tuple), (idxn)) : \ 223 (((n)==2)?pcmcia_tuple_read_2((tuple), (idxn)) : \ 224 (((n)==3)?pcmcia_tuple_read_3((tuple), (idxn)) : \ 225 /* n == 4 */ pcmcia_tuple_read_4((tuple), (idxn))))) 226 227 #define PCMCIA_SPACE_MEMORY 1 228 #define PCMCIA_SPACE_IO 2 229 230 int pcmcia_ccr_read __P((struct pcmcia_function *, int)); 231 void pcmcia_ccr_write __P((struct pcmcia_function *, int, int)); 232 233 #define pcmcia_mfc(sc) ((sc)->card.pf_head.sqh_first && \ 234 (sc)->card.pf_head.sqh_first->pf_list.sqe_next) 235 236 void pcmcia_function_init __P((struct pcmcia_function *, 237 struct pcmcia_config_entry *)); 238 int pcmcia_function_enable __P((struct pcmcia_function *)); 239 void pcmcia_function_disable __P((struct pcmcia_function *)); 240 241 #define pcmcia_io_alloc(pf, start, size, align, pciop) \ 242 (pcmcia_chip_io_alloc((pf)->sc->pct, pf->sc->pch, (start), \ 243 (size), (align), (pciop))) 244 245 #define pcmcia_io_free(pf, pciohp) \ 246 (pcmcia_chip_io_free((pf)->sc->pct, (pf)->sc->pch, (pciohp))) 247 248 int pcmcia_io_map __P((struct pcmcia_function *, int, bus_addr_t, 249 bus_size_t, struct pcmcia_io_handle *, int *)); 250 void pcmcia_io_unmap __P((struct pcmcia_function *, int)); 251 252 #define pcmcia_mem_alloc(pf, size, pcmhp) \ 253 (pcmcia_chip_mem_alloc((pf)->sc->pct, (pf)->sc->pch, (size), (pcmhp))) 254 255 #define pcmcia_mem_free(pf, pcmhp) \ 256 (pcmcia_chip_mem_free((pf)->sc->pct, (pf)->sc->pch, (pcmhp))) 257 258 #define pcmcia_mem_map(pf, kind, card_addr, size, pcmhp, offsetp, windowp) \ 259 (pcmcia_chip_mem_map((pf)->sc->pct, (pf)->sc->pch, (kind), \ 260 (card_addr), (size), (pcmhp), (offsetp), (windowp))) 261 262 #define pcmcia_mem_unmap(pf, window) \ 263 (pcmcia_chip_mem_unmap((pf)->sc->pct, (pf)->sc->pch, (window))) 264 265 void *pcmcia_intr_establish __P((struct pcmcia_function *, int, 266 int (*) (void *), void *)); 267 void pcmcia_intr_disestablish __P((struct pcmcia_function *, void *)); 268
Indexes created Mon Sep 29 21:09:56 GMT 2025