pccardvar.h revision 121905
1126261Smlaier/* $NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $ */ 2126258Smlaier/* $FreeBSD: head/sys/dev/pccard/pccardvar.h 121905 2003-11-02 20:18:19Z imp $ */ 3126258Smlaier 4126258Smlaier/* 5126258Smlaier * Copyright (c) 1997 Marc Horowitz. All rights reserved. 6126258Smlaier * 7126258Smlaier * Redistribution and use in source and binary forms, with or without 8126258Smlaier * modification, are permitted provided that the following conditions 9126258Smlaier * are met: 10126258Smlaier * 1. Redistributions of source code must retain the above copyright 11126258Smlaier * notice, this list of conditions and the following disclaimer. 12126258Smlaier * 2. Redistributions in binary form must reproduce the above copyright 13126258Smlaier * notice, this list of conditions and the following disclaimer in the 14126258Smlaier * documentation and/or other materials provided with the distribution. 15126258Smlaier * 3. All advertising materials mentioning features or use of this software 16126258Smlaier * must display the following acknowledgement: 17126258Smlaier * This product includes software developed by Marc Horowitz. 18126258Smlaier * 4. The name of the author may not be used to endorse or promote products 19126258Smlaier * derived from this software without specific prior written permission. 20126258Smlaier * 21126258Smlaier * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22126258Smlaier * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23126258Smlaier * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24126258Smlaier * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25126258Smlaier * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26126258Smlaier * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27126258Smlaier * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28126258Smlaier * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29126258Smlaier * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30126258Smlaier * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31126258Smlaier */ 32126258Smlaier 33126258Smlaier#include <sys/types.h> 34126258Smlaier#include <sys/queue.h> 35126258Smlaier 36126258Smlaier#include <machine/bus.h> 37126258Smlaier 38126261Smlaierextern int pccard_verbose; 39126261Smlaier 40126261Smlaier/* 41126261Smlaier * Contains information about mapped/allocated i/o spaces. 42126261Smlaier */ 43126261Smlaierstruct pccard_io_handle { 44126261Smlaier bus_space_tag_t iot; /* bus space tag (from chipset) */ 45126261Smlaier bus_space_handle_t ioh; /* mapped space handle */ 46126261Smlaier bus_addr_t addr; /* resulting address in bus space */ 47126261Smlaier bus_size_t size; /* size of i/o space */ 48126261Smlaier int flags; /* misc. information */ 49126261Smlaier int width; 50126258Smlaier}; 51126258Smlaier 52126258Smlaier#define PCCARD_IO_ALLOCATED 0x01 /* i/o space was allocated */ 53126261Smlaier 54126258Smlaier/* 55126258Smlaier * Contains information about allocated memory space. 56126258Smlaier */ 57126258Smlaierstruct pccard_mem_handle { 58126258Smlaier bus_space_tag_t memt; /* bus space tag (from chipset) */ 59126258Smlaier bus_space_handle_t memh; /* mapped space handle */ 60126258Smlaier bus_addr_t addr; /* resulting address in bus space */ 61126258Smlaier bus_size_t size; /* size of mem space */ 62126258Smlaier bus_size_t realsize; /* how much we really allocated */ 63126261Smlaier bus_addr_t cardaddr; /* Absolute address on card */ 64126261Smlaier int kind; 65126261Smlaier}; 66126258Smlaier 67126261Smlaier/* pccard itself */ 68126258Smlaier 69126258Smlaier#define PCCARD_CFE_MWAIT_REQUIRED 0x0001 70126258Smlaier#define PCCARD_CFE_RDYBSY_ACTIVE 0x0002 71126258Smlaier#define PCCARD_CFE_WP_ACTIVE 0x0004 72126258Smlaier#define PCCARD_CFE_BVD_ACTIVE 0x0008 73126258Smlaier#define PCCARD_CFE_IO8 0x0010 74126258Smlaier#define PCCARD_CFE_IO16 0x0020 75126258Smlaier#define PCCARD_CFE_IRQSHARE 0x0040 76126258Smlaier#define PCCARD_CFE_IRQPULSE 0x0080 77126258Smlaier#define PCCARD_CFE_IRQLEVEL 0x0100 78126258Smlaier#define PCCARD_CFE_POWERDOWN 0x0200 79126258Smlaier#define PCCARD_CFE_READONLY 0x0400 80126258Smlaier#define PCCARD_CFE_AUDIO 0x0800 81126258Smlaier 82126258Smlaierstruct pccard_config_entry { 83126258Smlaier int number; 84126258Smlaier uint32_t flags; 85126258Smlaier int iftype; 86126258Smlaier int num_iospace; 87126258Smlaier 88126258Smlaier /* 89126261Smlaier * The card will only decode this mask in any case, so we can 90126258Smlaier * do dynamic allocation with this in mind, in case the suggestions 91126261Smlaier * below are no good. 92126258Smlaier */ 93126258Smlaier u_long iomask; 94126258Smlaier struct { 95126258Smlaier u_long length; 96126258Smlaier u_long start; 97126258Smlaier } iospace[4]; /* XXX this could be as high as 16 */ 98126258Smlaier uint16_t irqmask; 99126258Smlaier int num_memspace; 100126258Smlaier struct { 101126261Smlaier u_long length; 102126261Smlaier u_long cardaddr; 103126261Smlaier u_long hostaddr; 104126261Smlaier } memspace[2]; /* XXX this could be as high as 8 */ 105126258Smlaier int maxtwins; 106126258Smlaier struct resource *iores[4]; 107126258Smlaier int iorid[4]; 108126258Smlaier struct resource *irqres; 109126258Smlaier int irqrid; 110126258Smlaier struct resource *memres[2]; 111126261Smlaier int memrid[2]; 112126261Smlaier STAILQ_ENTRY(pccard_config_entry) cfe_list; 113126261Smlaier}; 114126261Smlaier 115126261Smlaierstruct pccard_funce_disk { 116126261Smlaier int pfd_interface; 117126261Smlaier}; 118126261Smlaier 119126261Smlaierstruct pccard_funce_lan { 120126258Smlaier int pfl_nidlen; 121126261Smlaier uint8_t pfl_nid[8]; 122126261Smlaier}; 123126261Smlaier 124126261Smlaierunion pccard_funce { 125126261Smlaier struct pccard_funce_disk pfv_disk; 126126261Smlaier struct pccard_funce_lan pfv_lan; 127126261Smlaier}; 128126261Smlaier 129126258Smlaierstruct pccard_function { 130126258Smlaier /* read off the card */ 131126258Smlaier int number; 132126258Smlaier int function; 133126258Smlaier int last_config_index; 134126258Smlaier uint32_t ccr_base; /* Offset with card's memory */ 135126258Smlaier uint32_t ccr_mask; 136126258Smlaier struct resource *ccr_res; 137126258Smlaier int ccr_rid; 138126258Smlaier STAILQ_HEAD(, pccard_config_entry) cfe_head; 139126258Smlaier STAILQ_ENTRY(pccard_function) pf_list; 140126258Smlaier /* run-time state */ 141126258Smlaier struct pccard_softc *sc; 142126258Smlaier struct pccard_config_entry *cfe; 143126258Smlaier struct pccard_mem_handle pf_pcmh; 144126258Smlaier device_t dev; 145126258Smlaier#define pf_ccrt pf_pcmh.memt 146126258Smlaier#define pf_ccrh pf_pcmh.memh 147126258Smlaier#define pf_ccr_realsize pf_pcmh.realsize 148126258Smlaier uint32_t pf_ccr_offset; /* Offset from ccr_base of CIS */ 149126261Smlaier int pf_ccr_window; 150126261Smlaier bus_addr_t pf_mfc_iobase; 151126261Smlaier bus_addr_t pf_mfc_iomax; 152126258Smlaier int pf_flags; 153126261Smlaier driver_intr_t *intr_handler; 154126258Smlaier void *intr_handler_arg; 155126261Smlaier void *intr_handler_cookie; 156126261Smlaier 157126261Smlaier union pccard_funce pf_funce; /* CISTPL_FUNCE */ 158126261Smlaier#define pf_funce_disk_interface pf_funce.pfv_disk.pfd_interface 159126261Smlaier#define pf_funce_lan_nid pf_funce.pfv_lan.pfl_nid 160126258Smlaier#define pf_funce_lan_nidlen pf_funce.pfv_lan.pfl_nidlen 161126258Smlaier}; 162126261Smlaier 163126258Smlaier/* pf_flags */ 164126258Smlaier#define PFF_ENABLED 0x0001 /* function is enabled */ 165126261Smlaier 166126261Smlaierstruct pccard_card { 167126261Smlaier int cis1_major; 168126258Smlaier int cis1_minor; 169126258Smlaier /* XXX waste of space? */ 170126258Smlaier char cis1_info_buf[256]; 171126258Smlaier char *cis1_info[4]; 172126258Smlaier /* 173126258Smlaier * Use int32_t for manufacturer and product so that they can 174126258Smlaier * hold the id value found in card CIS and special value that 175126258Smlaier * indicates no id was found. 176126258Smlaier */ 177126258Smlaier int32_t manufacturer; 178126258Smlaier#define PCMCIA_VENDOR_INVALID -1 179126258Smlaier int32_t product; 180126258Smlaier#define PCMCIA_PRODUCT_INVALID -1 181126258Smlaier int16_t prodext; 182126258Smlaier uint16_t error; 183126258Smlaier#define PCMCIA_CIS_INVALID { NULL, NULL, NULL, NULL } 184126258Smlaier STAILQ_HEAD(, pccard_function) pf_head; 185126258Smlaier}; 186126258Smlaier 187126258Smlaier#define PCCARD_WIDTH_AUTO 0 188126258Smlaier#define PCCARD_WIDTH_IO8 1 189126258Smlaier#define PCCARD_WIDTH_IO16 2 190126258Smlaier 191126258Smlaier/* More later? */ 192126258Smlaierstruct pccard_ivar { 193126258Smlaier struct resource_list resources; 194126258Smlaier struct pccard_function *fcn; 195126258Smlaier}; 196126258Smlaier 197126258Smlaierstruct pccard_softc { 198126258Smlaier device_t dev; 199126258Smlaier /* this stuff is for the socket */ 200126258Smlaier 201126258Smlaier /* this stuff is for the card */ 202126258Smlaier struct pccard_card card; 203126258Smlaier int sc_enabled_count; /* num functions enabled */ 204126258Smlaier}; 205126258Smlaier 206126258Smlaierstruct pccard_cis_quirk { 207126258Smlaier int32_t manufacturer; 208126258Smlaier int32_t product; 209126258Smlaier char *cis1_info[4]; 210126258Smlaier struct pccard_function *pf; 211126258Smlaier struct pccard_config_entry *cfe; 212126258Smlaier}; 213126258Smlaier 214126258Smlaierstruct pccard_tuple { 215126258Smlaier unsigned int code; 216126258Smlaier unsigned int length; 217126258Smlaier u_long mult; 218126258Smlaier bus_addr_t ptr; 219126258Smlaier bus_space_tag_t memt; 220126258Smlaier bus_space_handle_t memh; 221126258Smlaier}; 222126258Smlaier 223126258Smlaierstruct pccard_product { 224126258Smlaier const char *pp_name; /* NULL if end of table */ 225126258Smlaier#define PCCARD_VENDOR_ANY (0xffffffff) 226126258Smlaier uint32_t pp_vendor; 227126258Smlaier#define PCCARD_PRODUCT_ANY (0xffffffff) 228126258Smlaier uint32_t pp_product; 229126258Smlaier int pp_expfunc; 230126258Smlaier const char *pp_cis[4]; 231126258Smlaier}; 232126258Smlaier 233126258Smlaiertypedef int (*pccard_product_match_fn) (device_t dev, 234126258Smlaier const struct pccard_product *ent, int vpfmatch); 235126258Smlaier 236126258Smlaier#include "card_if.h" 237126258Smlaier 238126258Smlaier/* 239126258Smlaier * make this inline so that we don't have to worry about dangling references 240126258Smlaier * to it in the modules or the code. 241126258Smlaier */ 242126258Smlaierstatic __inline const struct pccard_product * 243126258Smlaierpccard_product_lookup(device_t dev, const struct pccard_product *tab, 244126258Smlaier size_t ent_size, pccard_product_match_fn matchfn) 245126258Smlaier{ 246126258Smlaier return CARD_DO_PRODUCT_LOOKUP(device_get_parent(dev), dev, 247126258Smlaier tab, ent_size, matchfn); 248126258Smlaier} 249126258Smlaier 250126258Smlaiervoid pccard_read_cis(struct pccard_softc *); 251126258Smlaiervoid pccard_check_cis_quirks(device_t); 252126258Smlaiervoid pccard_print_cis(device_t); 253126258Smlaierint pccard_scan_cis(device_t, 254126258Smlaier int (*) (struct pccard_tuple *, void *), void *); 255126258Smlaier 256126258Smlaier#define pccard_cis_read_1(tuple, idx0) \ 257126258Smlaier (bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0))) 258126258Smlaier 259126258Smlaier#define pccard_tuple_read_1(tuple, idx1) \ 260126258Smlaier (pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1))))) 261126258Smlaier 262126261Smlaier#define pccard_tuple_read_2(tuple, idx2) \ 263126261Smlaier (pccard_tuple_read_1((tuple), (idx2)) | \ 264126261Smlaier (pccard_tuple_read_1((tuple), (idx2)+1)<<8)) 265126258Smlaier 266126261Smlaier#define pccard_tuple_read_3(tuple, idx3) \ 267126261Smlaier (pccard_tuple_read_1((tuple), (idx3)) | \ 268126261Smlaier (pccard_tuple_read_1((tuple), (idx3)+1)<<8) | \ 269126258Smlaier (pccard_tuple_read_1((tuple), (idx3)+2)<<16)) 270126258Smlaier 271126261Smlaier#define pccard_tuple_read_4(tuple, idx4) \ 272126258Smlaier (pccard_tuple_read_1((tuple), (idx4)) | \ 273126258Smlaier (pccard_tuple_read_1((tuple), (idx4)+1)<<8) | \ 274126258Smlaier (pccard_tuple_read_1((tuple), (idx4)+2)<<16) | \ 275126258Smlaier (pccard_tuple_read_1((tuple), (idx4)+3)<<24)) 276126258Smlaier 277126258Smlaier#define pccard_tuple_read_n(tuple, n, idxn) \ 278126258Smlaier (((n)==1)?pccard_tuple_read_1((tuple), (idxn)) : \ 279126258Smlaier (((n)==2)?pccard_tuple_read_2((tuple), (idxn)) : \ 280126258Smlaier (((n)==3)?pccard_tuple_read_3((tuple), (idxn)) : \ 281126258Smlaier /* n == 4 */ pccard_tuple_read_4((tuple), (idxn))))) 282126258Smlaier 283126258Smlaier#define PCCARD_SPACE_MEMORY 1 284126258Smlaier#define PCCARD_SPACE_IO 2 285126258Smlaier 286126258Smlaier#define pccard_mfc(sc) \ 287126258Smlaier (STAILQ_FIRST(&(sc)->card.pf_head) && \ 288126258Smlaier STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list)) 289126258Smlaier 290126258Smlaier#define pccard_io_alloc(pf, start, size, align, pciop) \ 291126258Smlaier (pccard_chip_io_alloc((pf)->sc->pct, pf->sc->pch, (start), \ 292126258Smlaier (size), (align), (pciop))) 293126258Smlaier 294126258Smlaier#define pccard_io_free(pf, pciohp) \ 295126258Smlaier (pccard_chip_io_free((pf)->sc->pct, (pf)->sc->pch, (pciohp))) 296126258Smlaier 297126258Smlaierint pccard_io_map(struct pccard_function *, int, bus_addr_t, 298126258Smlaier bus_size_t, struct pccard_io_handle *, int *); 299126258Smlaiervoid pccard_io_unmap(struct pccard_function *, int); 300126258Smlaier 301126258Smlaier#define pccard_mem_alloc(pf, size, pcmhp) \ 302126258Smlaier (pccard_chip_mem_alloc((pf)->sc->pct, (pf)->sc->pch, (size), (pcmhp))) 303126258Smlaier#define pccard_mem_free(pf, pcmhp) \ 304126258Smlaier (pccard_chip_mem_free((pf)->sc->pct, (pf)->sc->pch, (pcmhp))) 305126258Smlaier#define pccard_mem_map(pf, kind, card_addr, size, pcmhp, offsetp, windowp) \ 306126258Smlaier (pccard_chip_mem_map((pf)->sc->pct, (pf)->sc->pch, (kind), \ 307126258Smlaier (card_addr), (size), (pcmhp), (offsetp), (windowp))) 308126258Smlaier#define pccard_mem_unmap(pf, window) \ 309126258Smlaier (pccard_chip_mem_unmap((pf)->sc->pct, (pf)->sc->pch, (window))) 310126258Smlaier 311126258Smlaier/* compat layer */ 312126258Smlaierstatic __inline int 313126258Smlaierpccard_compat_probe(device_t dev) 314126258Smlaier{ 315126258Smlaier return (CARD_COMPAT_DO_PROBE(device_get_parent(dev), dev)); 316126258Smlaier} 317126258Smlaier 318126258Smlaierstatic __inline int 319126258Smlaierpccard_compat_attach(device_t dev) 320126258Smlaier{ 321126258Smlaier return (CARD_COMPAT_DO_ATTACH(device_get_parent(dev), dev)); 322126258Smlaier} 323126258Smlaier 324126258Smlaier/* ivar interface */ 325126258Smlaierenum { 326126258Smlaier PCCARD_IVAR_ETHADDR, /* read ethernet address from CIS tupple */ 327126258Smlaier PCCARD_IVAR_VENDOR, 328126258Smlaier PCCARD_IVAR_PRODUCT, 329126258Smlaier PCCARD_IVAR_PRODEXT, 330126258Smlaier PCCARD_IVAR_FUNCTION_NUMBER, 331126258Smlaier PCCARD_IVAR_VENDOR_STR, /* CIS string for "Manufacturer" */ 332126258Smlaier PCCARD_IVAR_PRODUCT_STR,/* CIS strnig for "Product" */ 333126258Smlaier PCCARD_IVAR_CIS3_STR, 334126258Smlaier PCCARD_IVAR_CIS4_STR, 335126258Smlaier PCCARD_IVAR_FUNCTION 336126258Smlaier}; 337126258Smlaier 338126258Smlaier#define PCCARD_ACCESSOR(A, B, T) \ 339126258Smlaier__inline static int \ 340126258Smlaierpccard_get_ ## A(device_t dev, T *t) \ 341126258Smlaier{ \ 342126258Smlaier return BUS_READ_IVAR(device_get_parent(dev), dev, \ 343126258Smlaier PCCARD_IVAR_ ## B, (uintptr_t *) t); \ 344126258Smlaier} 345126258Smlaier 346126258SmlaierPCCARD_ACCESSOR(ether, ETHADDR, uint8_t) 347126258SmlaierPCCARD_ACCESSOR(vendor, VENDOR, uint32_t) 348126258SmlaierPCCARD_ACCESSOR(product, PRODUCT, uint32_t) 349126258SmlaierPCCARD_ACCESSOR(prodext, PRODEXT, uint16_t) 350126258SmlaierPCCARD_ACCESSOR(function_number,FUNCTION_NUMBER, uint32_t) 351126258SmlaierPCCARD_ACCESSOR(function, FUNCTION, uint32_t) 352126258SmlaierPCCARD_ACCESSOR(vendor_str, VENDOR_STR, const char *) 353126258SmlaierPCCARD_ACCESSOR(product_str, PRODUCT_STR, const char *) 354126258SmlaierPCCARD_ACCESSOR(cis3_str, CIS3_STR, const char *) 355126258SmlaierPCCARD_ACCESSOR(cis4_str, CIS4_STR, const char *) 356126258Smlaier 357126258Smlaier/* shared memory flags */ 358126258Smlaierenum { 359126258Smlaier PCCARD_A_MEM_COM, /* common */ 360126258Smlaier PCCARD_A_MEM_ATTR, /* attribute */ 361126258Smlaier PCCARD_A_MEM_8BIT, /* 8 bit */ 362126258Smlaier PCCARD_A_MEM_16BIT /* 16 bit */ 363126258Smlaier}; 364126258Smlaier 365126258Smlaier#define PCCARD_SOFTC(d) (struct pccard_softc *) device_get_softc(d) 366126258Smlaier#define PCCARD_IVAR(d) (struct pccard_ivar *) device_get_ivars(d) 367126258Smlaier 368126258Smlaier#define PCCARD_S(a, b) PCMCIA_STR_ ## a ## _ ## b 369126258Smlaier#define PCCARD_P(a, b) PCMCIA_PRODUCT_ ## a ## _ ## b 370126258Smlaier#define PCCARD_C(a, b) PCMCIA_CIS_ ## a ## _ ## b 371126258Smlaier#define PCMCIA_CARD_D(v, p, f) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \ 372126258Smlaier PCCARD_P(v, p), f, PCCARD_C(v, p) } 373126258Smlaier#define PCMCIA_CARD2_D(v1, p1, p2, f) \ 374126258Smlaier { PCMCIA_STR_ ## p2, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \ 375126258Smlaier f, PCMCIA_CIS_ ## p2} 376126258Smlaier#define PCMCIA_CARD(v, p, f) { NULL, PCMCIA_VENDOR_ ## v, \ 377126258Smlaier PCCARD_P(v, p), f, PCCARD_C(v, p) } 378126258Smlaier#define PCMCIA_CARD2(v1, p1, p2, f) \ 379126258Smlaier { NULL, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \ 380126258Smlaier f, PCMCIA_CIS_ ## p2} 381126258Smlaier