pccardvar.h revision 82378
1/* $NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $ */ 2/* $FreeBSD: head/sys/dev/pccard/pccardvar.h 82378 2001-08-27 00:09:42Z jon $ */ 3 4/* 5 * Copyright (c) 1997 Marc Horowitz. 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 Marc Horowitz. 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 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33#include <sys/types.h> 34#include <sys/queue.h> 35 36#include <machine/bus.h> 37#include "card_if.h" 38 39extern int pccard_verbose; 40 41/* 42 * Contains information about mapped/allocated i/o spaces. 43 */ 44struct pccard_io_handle { 45 bus_space_tag_t iot; /* bus space tag (from chipset) */ 46 bus_space_handle_t ioh; /* mapped space handle */ 47 bus_addr_t addr; /* resulting address in bus space */ 48 bus_size_t size; /* size of i/o space */ 49 int flags; /* misc. information */ 50 int width; 51}; 52 53#define PCCARD_IO_ALLOCATED 0x01 /* i/o space was allocated */ 54 55/* 56 * Contains information about allocated memory space. 57 */ 58struct pccard_mem_handle { 59 bus_space_tag_t memt; /* bus space tag (from chipset) */ 60 bus_space_handle_t memh; /* mapped space handle */ 61 bus_addr_t addr; /* resulting address in bus space */ 62 bus_size_t size; /* size of mem space */ 63 bus_size_t realsize; /* how much we really allocated */ 64 long offset; 65 int kind; 66}; 67 68/* pccard itself */ 69 70#define PCCARD_CFE_MWAIT_REQUIRED 0x0001 71#define PCCARD_CFE_RDYBSY_ACTIVE 0x0002 72#define PCCARD_CFE_WP_ACTIVE 0x0004 73#define PCCARD_CFE_BVD_ACTIVE 0x0008 74#define PCCARD_CFE_IO8 0x0010 75#define PCCARD_CFE_IO16 0x0020 76#define PCCARD_CFE_IRQSHARE 0x0040 77#define PCCARD_CFE_IRQPULSE 0x0080 78#define PCCARD_CFE_IRQLEVEL 0x0100 79#define PCCARD_CFE_POWERDOWN 0x0200 80#define PCCARD_CFE_READONLY 0x0400 81#define PCCARD_CFE_AUDIO 0x0800 82 83struct pccard_config_entry { 84 int number; 85 u_int32_t flags; 86 int iftype; 87 int num_iospace; 88 89 /* 90 * The card will only decode this mask in any case, so we can 91 * do dynamic allocation with this in mind, in case the suggestions 92 * below are no good. 93 */ 94 u_long iomask; 95 struct { 96 u_long length; 97 u_long start; 98 } iospace[4]; /* XXX this could be as high as 16 */ 99 u_int16_t irqmask; 100 int num_memspace; 101 struct { 102 u_long length; 103 u_long cardaddr; 104 u_long hostaddr; 105 } memspace[2]; /* XXX this could be as high as 8 */ 106 int maxtwins; 107 struct resource *iores[4]; 108 int iorid[4]; 109 struct resource *irqres; 110 int irqrid; 111 struct resource *memres[2]; 112 int memrid[2]; 113 STAILQ_ENTRY(pccard_config_entry) cfe_list; 114}; 115 116struct pccard_function { 117 /* read off the card */ 118 int number; 119 int function; 120 int last_config_index; 121 u_long ccr_base; 122 u_long ccr_mask; 123 struct resource *ccr_res; 124 int ccr_rid; 125 STAILQ_HEAD(, pccard_config_entry) cfe_head; 126 STAILQ_ENTRY(pccard_function) pf_list; 127 /* run-time state */ 128 struct pccard_softc *sc; 129 struct pccard_config_entry *cfe; 130 struct pccard_mem_handle pf_pcmh; 131 device_t dev; 132#define pf_ccrt pf_pcmh.memt 133#define pf_ccrh pf_pcmh.memh 134#define pf_ccr_realsize pf_pcmh.realsize 135 bus_addr_t pf_ccr_offset; 136 int pf_ccr_window; 137 long pf_mfc_iobase; 138 long pf_mfc_iomax; 139 int pf_flags; 140 driver_intr_t *intr_handler; 141 void *intr_handler_arg; 142 void *intr_handler_cookie; 143}; 144 145/* pf_flags */ 146#define PFF_ENABLED 0x0001 /* function is enabled */ 147 148struct pccard_card { 149 int cis1_major; 150 int cis1_minor; 151 /* XXX waste of space? */ 152 char cis1_info_buf[256]; 153 char *cis1_info[4]; 154 /* 155 * Use int32_t for manufacturer and product so that they can 156 * hold the id value found in card CIS and special value that 157 * indicates no id was found. 158 */ 159 int32_t manufacturer; 160#define PCCARD_VENDOR_INVALID -1 161 int32_t product; 162#define PCCARD_PRODUCT_INVALID -1 163 u_int16_t error; 164#define PCCARD_CIS_INVALID { NULL, NULL, NULL, NULL } 165 STAILQ_HEAD(, pccard_function) pf_head; 166}; 167 168#define PCCARD_MEM_ATTR 1 169#define PCCARD_MEM_COMMON 2 170 171#define PCCARD_WIDTH_AUTO 0 172#define PCCARD_WIDTH_IO8 1 173#define PCCARD_WIDTH_IO16 2 174 175/* More later? */ 176struct pccard_ivar { 177 struct resource_list resources; 178 struct pccard_function *fcn; 179}; 180 181struct pccard_softc { 182 device_t dev; 183 /* this stuff is for the socket */ 184 185 /* this stuff is for the card */ 186 struct pccard_card card; 187 int sc_enabled_count; /* num functions enabled */ 188}; 189 190void 191pccardbus_if_setup(struct pccard_softc*); 192 193struct pccard_cis_quirk { 194 int32_t manufacturer; 195 int32_t product; 196 char *cis1_info[4]; 197 struct pccard_function *pf; 198 struct pccard_config_entry *cfe; 199}; 200 201struct pccard_tuple { 202 unsigned int code; 203 unsigned int length; 204 u_long mult; 205 bus_addr_t ptr; 206 bus_space_tag_t memt; 207 bus_space_handle_t memh; 208}; 209 210struct pccard_product { 211 const char *pp_name; /* NULL if end of table */ 212#define PCCARD_VENDOR_ANY ((u_int32_t) -1) 213 u_int32_t pp_vendor; 214#define PCCARD_PRODUCT_ANY ((u_int32_t) -1) 215 u_int32_t pp_product; 216 int pp_expfunc; 217 const char *pp_cis[4]; 218}; 219 220typedef int (*pccard_product_match_fn) (device_t dev, 221 const struct pccard_product *ent, int vpfmatch); 222 223const struct pccard_product 224 *pccard_product_lookup(device_t dev, const struct pccard_product *tab, 225 size_t ent_size, pccard_product_match_fn matchfn); 226 227void pccard_read_cis(struct pccard_softc *); 228void pccard_check_cis_quirks(device_t); 229void pccard_print_cis(device_t); 230int pccard_scan_cis(device_t, 231 int (*) (struct pccard_tuple *, void *), void *); 232 233#define pccard_cis_read_1(tuple, idx0) \ 234 (bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0))) 235 236#define pccard_tuple_read_1(tuple, idx1) \ 237 (pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1))))) 238 239#define pccard_tuple_read_2(tuple, idx2) \ 240 (pccard_tuple_read_1((tuple), (idx2)) | \ 241 (pccard_tuple_read_1((tuple), (idx2)+1)<<8)) 242 243#define pccard_tuple_read_3(tuple, idx3) \ 244 (pccard_tuple_read_1((tuple), (idx3)) | \ 245 (pccard_tuple_read_1((tuple), (idx3)+1)<<8) | \ 246 (pccard_tuple_read_1((tuple), (idx3)+2)<<16)) 247 248#define pccard_tuple_read_4(tuple, idx4) \ 249 (pccard_tuple_read_1((tuple), (idx4)) | \ 250 (pccard_tuple_read_1((tuple), (idx4)+1)<<8) | \ 251 (pccard_tuple_read_1((tuple), (idx4)+2)<<16) | \ 252 (pccard_tuple_read_1((tuple), (idx4)+3)<<24)) 253 254#define pccard_tuple_read_n(tuple, n, idxn) \ 255 (((n)==1)?pccard_tuple_read_1((tuple), (idxn)) : \ 256 (((n)==2)?pccard_tuple_read_2((tuple), (idxn)) : \ 257 (((n)==3)?pccard_tuple_read_3((tuple), (idxn)) : \ 258 /* n == 4 */ pccard_tuple_read_4((tuple), (idxn))))) 259 260#define PCCARD_SPACE_MEMORY 1 261#define PCCARD_SPACE_IO 2 262 263#define pccard_mfc(sc) (STAILQ_FIRST(&(sc)->card.pf_head) && \ 264 STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list)) 265 266#define pccard_io_alloc(pf, start, size, align, pciop) \ 267 (pccard_chip_io_alloc((pf)->sc->pct, pf->sc->pch, (start), \ 268 (size), (align), (pciop))) 269 270#define pccard_io_free(pf, pciohp) \ 271 (pccard_chip_io_free((pf)->sc->pct, (pf)->sc->pch, (pciohp))) 272 273int pccard_io_map(struct pccard_function *, int, bus_addr_t, 274 bus_size_t, struct pccard_io_handle *, int *); 275void pccard_io_unmap(struct pccard_function *, int); 276 277#define pccard_mem_alloc(pf, size, pcmhp) \ 278 (pccard_chip_mem_alloc((pf)->sc->pct, (pf)->sc->pch, (size), (pcmhp))) 279#define pccard_mem_free(pf, pcmhp) \ 280 (pccard_chip_mem_free((pf)->sc->pct, (pf)->sc->pch, (pcmhp))) 281#define pccard_mem_map(pf, kind, card_addr, size, pcmhp, offsetp, windowp) \ 282 (pccard_chip_mem_map((pf)->sc->pct, (pf)->sc->pch, (kind), \ 283 (card_addr), (size), (pcmhp), (offsetp), (windowp))) 284#define pccard_mem_unmap(pf, window) \ 285 (pccard_chip_mem_unmap((pf)->sc->pct, (pf)->sc->pch, (window))) 286 287/* compat layer */ 288static __inline int 289pccard_compat_probe(device_t dev) 290{ 291 return (CARD_COMPAT_DO_PROBE(device_get_parent(dev), dev)); 292} 293 294static __inline int 295pccard_compat_attach(device_t dev) 296{ 297 return (CARD_COMPAT_DO_ATTACH(device_get_parent(dev), dev)); 298} 299 300/* ivar interface */ 301enum { 302 PCCARD_IVAR_ETHADDR, /* read ethernet address from CIS tupple */ 303 PCCARD_IVAR_VENDOR, 304 PCCARD_IVAR_PRODUCT, 305 PCCARD_IVAR_FUNCTION_NUMBER, 306 PCCARD_IVAR_VENDOR_STR, /* CIS string for "Manufacturer" */ 307 PCCARD_IVAR_PRODUCT_STR,/* CIS strnig for "Product" */ 308 PCCARD_IVAR_CIS3_STR, 309 PCCARD_IVAR_CIS4_STR, 310 PCCARD_IVAR_FUNCTION 311}; 312 313#define PCCARD_ACCESSOR(A, B, T) \ 314__inline static int \ 315pccard_get_ ## A(device_t dev, T *t) \ 316{ \ 317 return BUS_READ_IVAR(device_get_parent(dev), dev, \ 318 PCCARD_IVAR_ ## B, (uintptr_t *) t); \ 319} 320 321PCCARD_ACCESSOR(ether, ETHADDR, u_int8_t) 322PCCARD_ACCESSOR(vendor, VENDOR, u_int32_t) 323PCCARD_ACCESSOR(product, PRODUCT, u_int32_t) 324PCCARD_ACCESSOR(function_number,FUNCTION_NUMBER, u_int32_t) 325PCCARD_ACCESSOR(function, FUNCTION, u_int32_t) 326PCCARD_ACCESSOR(vendor_str, VENDOR_STR, char *) 327PCCARD_ACCESSOR(product_str, PRODUCT_STR, char *) 328PCCARD_ACCESSOR(cis3_str, CIS3_STR, char *) 329 330/* shared memory flags */ 331enum { 332 PCCARD_A_MEM_COM, /* common */ 333 PCCARD_A_MEM_ATTR, /* attribute */ 334 PCCARD_A_MEM_8BIT, /* 8 bit */ 335 PCCARD_A_MEM_16BIT /* 16 bit */ 336}; 337 338#define PCCARD_SOFTC(d) (struct pccard_softc *) device_get_softc(d) 339#define PCCARD_IVAR(d) (struct pccard_ivar *) device_get_ivars(d) 340