18456e16eSWarner Losh /* $NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $ */ 2c2380338SWarner Losh /* $FreeBSD$ */ 3c2380338SWarner Losh 4c2380338SWarner Losh /* 5c2380338SWarner Losh * Copyright (c) 1997 Marc Horowitz. All rights reserved. 6c2380338SWarner Losh * 7c2380338SWarner Losh * Redistribution and use in source and binary forms, with or without 8c2380338SWarner Losh * modification, are permitted provided that the following conditions 9c2380338SWarner Losh * are met: 10c2380338SWarner Losh * 1. Redistributions of source code must retain the above copyright 11c2380338SWarner Losh * notice, this list of conditions and the following disclaimer. 12c2380338SWarner Losh * 2. Redistributions in binary form must reproduce the above copyright 13c2380338SWarner Losh * notice, this list of conditions and the following disclaimer in the 14c2380338SWarner Losh * documentation and/or other materials provided with the distribution. 15c2380338SWarner Losh * 3. All advertising materials mentioning features or use of this software 16c2380338SWarner Losh * must display the following acknowledgement: 17c2380338SWarner Losh * This product includes software developed by Marc Horowitz. 18c2380338SWarner Losh * 4. The name of the author may not be used to endorse or promote products 19c2380338SWarner Losh * derived from this software without specific prior written permission. 20c2380338SWarner Losh * 21c2380338SWarner Losh * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22c2380338SWarner Losh * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23c2380338SWarner Losh * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24c2380338SWarner Losh * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25c2380338SWarner Losh * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26c2380338SWarner Losh * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27c2380338SWarner Losh * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28c2380338SWarner Losh * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29c2380338SWarner Losh * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30c2380338SWarner Losh * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31c2380338SWarner Losh */ 32c2380338SWarner Losh 33c2380338SWarner Losh #include <sys/types.h> 34c2380338SWarner Losh #include <sys/queue.h> 35c2380338SWarner Losh 36c2380338SWarner Losh #include <machine/bus.h> 37c33c1284SWarner Losh #include "card_if.h" 38c2380338SWarner Losh 39c2380338SWarner Losh extern int pccard_verbose; 40c2380338SWarner Losh 41c2380338SWarner Losh /* 42c2380338SWarner Losh * Contains information about mapped/allocated i/o spaces. 43c2380338SWarner Losh */ 44c2380338SWarner Losh struct pccard_io_handle { 45c2380338SWarner Losh bus_space_tag_t iot; /* bus space tag (from chipset) */ 46c2380338SWarner Losh bus_space_handle_t ioh; /* mapped space handle */ 47c2380338SWarner Losh bus_addr_t addr; /* resulting address in bus space */ 48c2380338SWarner Losh bus_size_t size; /* size of i/o space */ 49c2380338SWarner Losh int flags; /* misc. information */ 5081047394SWarner Losh int width; 51c2380338SWarner Losh }; 52c2380338SWarner Losh 53c2380338SWarner Losh #define PCCARD_IO_ALLOCATED 0x01 /* i/o space was allocated */ 54c2380338SWarner Losh 55c2380338SWarner Losh /* 56c2380338SWarner Losh * Contains information about allocated memory space. 57c2380338SWarner Losh */ 58c2380338SWarner Losh struct pccard_mem_handle { 59c2380338SWarner Losh bus_space_tag_t memt; /* bus space tag (from chipset) */ 60c2380338SWarner Losh bus_space_handle_t memh; /* mapped space handle */ 61c2380338SWarner Losh bus_addr_t addr; /* resulting address in bus space */ 62c2380338SWarner Losh bus_size_t size; /* size of mem space */ 63c2380338SWarner Losh bus_size_t realsize; /* how much we really allocated */ 6481047394SWarner Losh long offset; 6581047394SWarner Losh int kind; 66c2380338SWarner Losh }; 67c2380338SWarner Losh 68c2380338SWarner Losh /* pccard itself */ 69c2380338SWarner Losh 70c2380338SWarner Losh #define PCCARD_CFE_MWAIT_REQUIRED 0x0001 71c2380338SWarner Losh #define PCCARD_CFE_RDYBSY_ACTIVE 0x0002 72c2380338SWarner Losh #define PCCARD_CFE_WP_ACTIVE 0x0004 73c2380338SWarner Losh #define PCCARD_CFE_BVD_ACTIVE 0x0008 74c2380338SWarner Losh #define PCCARD_CFE_IO8 0x0010 75c2380338SWarner Losh #define PCCARD_CFE_IO16 0x0020 76c2380338SWarner Losh #define PCCARD_CFE_IRQSHARE 0x0040 77c2380338SWarner Losh #define PCCARD_CFE_IRQPULSE 0x0080 78c2380338SWarner Losh #define PCCARD_CFE_IRQLEVEL 0x0100 79c2380338SWarner Losh #define PCCARD_CFE_POWERDOWN 0x0200 80c2380338SWarner Losh #define PCCARD_CFE_READONLY 0x0400 81c2380338SWarner Losh #define PCCARD_CFE_AUDIO 0x0800 82c2380338SWarner Losh 83c2380338SWarner Losh struct pccard_config_entry { 84c2380338SWarner Losh int number; 85c2380338SWarner Losh u_int32_t flags; 86c2380338SWarner Losh int iftype; 87c2380338SWarner Losh int num_iospace; 88c2380338SWarner Losh 89c2380338SWarner Losh /* 90c2380338SWarner Losh * The card will only decode this mask in any case, so we can 91c2380338SWarner Losh * do dynamic allocation with this in mind, in case the suggestions 92c2380338SWarner Losh * below are no good. 93c2380338SWarner Losh */ 94c2380338SWarner Losh u_long iomask; 95c2380338SWarner Losh struct { 96c2380338SWarner Losh u_long length; 97c2380338SWarner Losh u_long start; 98c2380338SWarner Losh } iospace[4]; /* XXX this could be as high as 16 */ 99c2380338SWarner Losh u_int16_t irqmask; 100c2380338SWarner Losh int num_memspace; 101c2380338SWarner Losh struct { 102c2380338SWarner Losh u_long length; 103c2380338SWarner Losh u_long cardaddr; 104c2380338SWarner Losh u_long hostaddr; 105c2380338SWarner Losh } memspace[2]; /* XXX this could be as high as 8 */ 106c2380338SWarner Losh int maxtwins; 1079344caafSWarner Losh struct resource *iores[4]; 1089344caafSWarner Losh int iorid[4]; 1099344caafSWarner Losh struct resource *irqres; 1109344caafSWarner Losh int irqrid; 1119344caafSWarner Losh struct resource *memres[2]; 1129344caafSWarner Losh int memrid[2]; 113e3975643SJake Burkholder STAILQ_ENTRY(pccard_config_entry) cfe_list; 114c2380338SWarner Losh }; 115c2380338SWarner Losh 116c2380338SWarner Losh struct pccard_function { 117c2380338SWarner Losh /* read off the card */ 118c2380338SWarner Losh int number; 119c2380338SWarner Losh int function; 120c2380338SWarner Losh int last_config_index; 121c2380338SWarner Losh u_long ccr_base; 122c2380338SWarner Losh u_long ccr_mask; 12378ae73b5SWarner Losh struct resource *ccr_res; 12478ae73b5SWarner Losh int ccr_rid; 125e3975643SJake Burkholder STAILQ_HEAD(, pccard_config_entry) cfe_head; 126e3975643SJake Burkholder STAILQ_ENTRY(pccard_function) pf_list; 127c2380338SWarner Losh /* run-time state */ 128c2380338SWarner Losh struct pccard_softc *sc; 129c2380338SWarner Losh struct pccard_config_entry *cfe; 130c2380338SWarner Losh struct pccard_mem_handle pf_pcmh; 131bd6dd21eSWarner Losh device_t dev; 132c2380338SWarner Losh #define pf_ccrt pf_pcmh.memt 133c2380338SWarner Losh #define pf_ccrh pf_pcmh.memh 134c2380338SWarner Losh #define pf_ccr_realsize pf_pcmh.realsize 135c2380338SWarner Losh bus_addr_t pf_ccr_offset; 136c2380338SWarner Losh int pf_ccr_window; 137c2380338SWarner Losh long pf_mfc_iobase; 138c2380338SWarner Losh long pf_mfc_iomax; 139c2380338SWarner Losh int pf_flags; 1400c95c705SJonathan Chen driver_intr_t *intr_handler; 1410c95c705SJonathan Chen void *intr_handler_arg; 1420c95c705SJonathan Chen void *intr_handler_cookie; 143c2380338SWarner Losh }; 144c2380338SWarner Losh 145c2380338SWarner Losh /* pf_flags */ 146c2380338SWarner Losh #define PFF_ENABLED 0x0001 /* function is enabled */ 147c2380338SWarner Losh 148c2380338SWarner Losh struct pccard_card { 149c2380338SWarner Losh int cis1_major; 150c2380338SWarner Losh int cis1_minor; 151c2380338SWarner Losh /* XXX waste of space? */ 152c2380338SWarner Losh char cis1_info_buf[256]; 153c2380338SWarner Losh char *cis1_info[4]; 154c2380338SWarner Losh /* 155c2380338SWarner Losh * Use int32_t for manufacturer and product so that they can 156c2380338SWarner Losh * hold the id value found in card CIS and special value that 157c2380338SWarner Losh * indicates no id was found. 158c2380338SWarner Losh */ 159c2380338SWarner Losh int32_t manufacturer; 160c2380338SWarner Losh #define PCCARD_VENDOR_INVALID -1 161c2380338SWarner Losh int32_t product; 162c2380338SWarner Losh #define PCCARD_PRODUCT_INVALID -1 163c2380338SWarner Losh u_int16_t error; 164c2380338SWarner Losh #define PCCARD_CIS_INVALID { NULL, NULL, NULL, NULL } 165e3975643SJake Burkholder STAILQ_HEAD(, pccard_function) pf_head; 166c2380338SWarner Losh }; 167c2380338SWarner Losh 168d3d805e6SWarner Losh #define PCCARD_MEM_ATTR 1 169d3d805e6SWarner Losh #define PCCARD_MEM_COMMON 2 170d3d805e6SWarner Losh 171d3d805e6SWarner Losh #define PCCARD_WIDTH_AUTO 0 172d3d805e6SWarner Losh #define PCCARD_WIDTH_IO8 1 173d3d805e6SWarner Losh #define PCCARD_WIDTH_IO16 2 174d3d805e6SWarner Losh 17512bba6c2SWarner Losh /* More later? */ 17612bba6c2SWarner Losh struct pccard_ivar { 17712bba6c2SWarner Losh struct resource_list resources; 17845713b37SWarner Losh struct pccard_function *fcn; 179c2380338SWarner Losh }; 180c2380338SWarner Losh 181c2380338SWarner Losh struct pccard_softc { 182deae2aafSWarner Losh device_t dev; 18378ae73b5SWarner Losh /* this stuff is for the socket */ 184deae2aafSWarner Losh 185c2380338SWarner Losh /* this stuff is for the card */ 186c2380338SWarner Losh struct pccard_card card; 187deae2aafSWarner Losh int sc_enabled_count; /* num functions enabled */ 1880c95c705SJonathan Chen int intr_handler_count; 189c2380338SWarner Losh }; 190c2380338SWarner Losh 191c2380338SWarner Losh void 19281047394SWarner Losh pccardbus_if_setup(struct pccard_softc*); 193c2380338SWarner Losh 194c2380338SWarner Losh struct pccard_cis_quirk { 195c2380338SWarner Losh int32_t manufacturer; 196c2380338SWarner Losh int32_t product; 197c2380338SWarner Losh char *cis1_info[4]; 198c2380338SWarner Losh struct pccard_function *pf; 199c2380338SWarner Losh struct pccard_config_entry *cfe; 200c2380338SWarner Losh }; 201c2380338SWarner Losh 202c2380338SWarner Losh struct pccard_tuple { 203c2380338SWarner Losh unsigned int code; 204c2380338SWarner Losh unsigned int length; 205c2380338SWarner Losh u_long mult; 206c2380338SWarner Losh bus_addr_t ptr; 207c2380338SWarner Losh bus_space_tag_t memt; 208c2380338SWarner Losh bus_space_handle_t memh; 209c2380338SWarner Losh }; 210c2380338SWarner Losh 2118456e16eSWarner Losh struct pccard_product { 2128456e16eSWarner Losh const char *pp_name; /* NULL if end of table */ 2138456e16eSWarner Losh #define PCCARD_VENDOR_ANY ((u_int32_t) -1) 2148456e16eSWarner Losh u_int32_t pp_vendor; 2158456e16eSWarner Losh #define PCCARD_PRODUCT_ANY ((u_int32_t) -1) 2168456e16eSWarner Losh u_int32_t pp_product; 2178456e16eSWarner Losh int pp_expfunc; 218da15fcf1SWarner Losh const char *pp_cis[4]; 2198456e16eSWarner Losh }; 2208456e16eSWarner Losh 2218456e16eSWarner Losh typedef int (*pccard_product_match_fn) (device_t dev, 2228456e16eSWarner Losh const struct pccard_product *ent, int vpfmatch); 2238456e16eSWarner Losh 2248456e16eSWarner Losh const struct pccard_product 2258456e16eSWarner Losh *pccard_product_lookup(device_t dev, const struct pccard_product *tab, 2268456e16eSWarner Losh size_t ent_size, pccard_product_match_fn matchfn); 2278456e16eSWarner Losh 22881047394SWarner Losh void pccard_read_cis(struct pccard_softc *); 229c2380338SWarner Losh void pccard_check_cis_quirks(device_t); 230c2380338SWarner Losh void pccard_print_cis(device_t); 2313a6352bdSWarner Losh int pccard_scan_cis(device_t, 23281047394SWarner Losh int (*) (struct pccard_tuple *, void *), void *); 233c2380338SWarner Losh 234c2380338SWarner Losh #define pccard_cis_read_1(tuple, idx0) \ 235c2380338SWarner Losh (bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0))) 236c2380338SWarner Losh 237c2380338SWarner Losh #define pccard_tuple_read_1(tuple, idx1) \ 238c2380338SWarner Losh (pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1))))) 239c2380338SWarner Losh 240c2380338SWarner Losh #define pccard_tuple_read_2(tuple, idx2) \ 241c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx2)) | \ 242c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx2)+1)<<8)) 243c2380338SWarner Losh 244c2380338SWarner Losh #define pccard_tuple_read_3(tuple, idx3) \ 245c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx3)) | \ 246c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx3)+1)<<8) | \ 247c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx3)+2)<<16)) 248c2380338SWarner Losh 249c2380338SWarner Losh #define pccard_tuple_read_4(tuple, idx4) \ 250c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx4)) | \ 251c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx4)+1)<<8) | \ 252c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx4)+2)<<16) | \ 253c2380338SWarner Losh (pccard_tuple_read_1((tuple), (idx4)+3)<<24)) 254c2380338SWarner Losh 255c2380338SWarner Losh #define pccard_tuple_read_n(tuple, n, idxn) \ 256c2380338SWarner Losh (((n)==1)?pccard_tuple_read_1((tuple), (idxn)) : \ 257c2380338SWarner Losh (((n)==2)?pccard_tuple_read_2((tuple), (idxn)) : \ 258c2380338SWarner Losh (((n)==3)?pccard_tuple_read_3((tuple), (idxn)) : \ 259c2380338SWarner Losh /* n == 4 */ pccard_tuple_read_4((tuple), (idxn))))) 260c2380338SWarner Losh 261c2380338SWarner Losh #define PCCARD_SPACE_MEMORY 1 262c2380338SWarner Losh #define PCCARD_SPACE_IO 2 263c2380338SWarner Losh 26481047394SWarner Losh int pccard_ccr_read(struct pccard_function *, int); 26581047394SWarner Losh void pccard_ccr_write(struct pccard_function *, int, int); 266c2380338SWarner Losh 267c2380338SWarner Losh #define pccard_mfc(sc) (STAILQ_FIRST(&(sc)->card.pf_head) && \ 268c2380338SWarner Losh STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list)) 269c2380338SWarner Losh 270c8ce264eSWarner Losh /* The following is the vestages of the NetBSD driver api */ 271c8ce264eSWarner Losh 27245713b37SWarner Losh void pccard_function_init(struct pccard_function *); 27381047394SWarner Losh int pccard_function_enable(struct pccard_function *); 27481047394SWarner Losh void pccard_function_disable(struct pccard_function *); 275c2380338SWarner Losh 276c2380338SWarner Losh #define pccard_io_alloc(pf, start, size, align, pciop) \ 277c2380338SWarner Losh (pccard_chip_io_alloc((pf)->sc->pct, pf->sc->pch, (start), \ 278c2380338SWarner Losh (size), (align), (pciop))) 279c2380338SWarner Losh 280c2380338SWarner Losh #define pccard_io_free(pf, pciohp) \ 281c2380338SWarner Losh (pccard_chip_io_free((pf)->sc->pct, (pf)->sc->pch, (pciohp))) 282c2380338SWarner Losh 28381047394SWarner Losh int pccard_io_map(struct pccard_function *, int, bus_addr_t, 28481047394SWarner Losh bus_size_t, struct pccard_io_handle *, int *); 28581047394SWarner Losh void pccard_io_unmap(struct pccard_function *, int); 286c2380338SWarner Losh 287c2380338SWarner Losh #define pccard_mem_alloc(pf, size, pcmhp) \ 288c2380338SWarner Losh (pccard_chip_mem_alloc((pf)->sc->pct, (pf)->sc->pch, (size), (pcmhp))) 289c2380338SWarner Losh #define pccard_mem_free(pf, pcmhp) \ 290c2380338SWarner Losh (pccard_chip_mem_free((pf)->sc->pct, (pf)->sc->pch, (pcmhp))) 291c2380338SWarner Losh #define pccard_mem_map(pf, kind, card_addr, size, pcmhp, offsetp, windowp) \ 292c2380338SWarner Losh (pccard_chip_mem_map((pf)->sc->pct, (pf)->sc->pch, (kind), \ 293c2380338SWarner Losh (card_addr), (size), (pcmhp), (offsetp), (windowp))) 294c2380338SWarner Losh #define pccard_mem_unmap(pf, window) \ 295c2380338SWarner Losh (pccard_chip_mem_unmap((pf)->sc->pct, (pf)->sc->pch, (window))) 29687ef0a0aSTatsumi Hosokawa 2972276cee5SWarner Losh /* compat layer */ 298c33c1284SWarner Losh static __inline int 299c33c1284SWarner Losh pccard_compat_probe(device_t dev) 300c33c1284SWarner Losh { 301c33c1284SWarner Losh return (CARD_COMPAT_DO_PROBE(device_get_parent(dev), dev)); 302c33c1284SWarner Losh } 303c33c1284SWarner Losh 304c33c1284SWarner Losh static __inline int 305c33c1284SWarner Losh pccard_compat_attach(device_t dev) 306c33c1284SWarner Losh { 307c33c1284SWarner Losh return (CARD_COMPAT_DO_ATTACH(device_get_parent(dev), dev)); 308c33c1284SWarner Losh } 3092276cee5SWarner Losh 31087ef0a0aSTatsumi Hosokawa /* ivar interface */ 31187ef0a0aSTatsumi Hosokawa enum { 31287ef0a0aSTatsumi Hosokawa PCCARD_IVAR_ETHADDR, /* read ethernet address from CIS tupple */ 3138456e16eSWarner Losh PCCARD_IVAR_VENDOR, 3148456e16eSWarner Losh PCCARD_IVAR_PRODUCT, 3158456e16eSWarner Losh PCCARD_IVAR_FUNCTION_NUMBER, 3168456e16eSWarner Losh PCCARD_IVAR_VENDOR_STR, /* CIS string for "Manufacturer" */ 3178456e16eSWarner Losh PCCARD_IVAR_PRODUCT_STR,/* CIS strnig for "Product" */ 318d62abc77SWarner Losh PCCARD_IVAR_CIS3_STR, 319dc8e185fSWarner Losh PCCARD_IVAR_CIS4_STR, 320dc8e185fSWarner Losh PCCARD_IVAR_FUNCTION 32187ef0a0aSTatsumi Hosokawa }; 32287ef0a0aSTatsumi Hosokawa 3238456e16eSWarner Losh #define PCCARD_ACCESSOR(A, B, T) \ 3248456e16eSWarner Losh __inline static int \ 3258456e16eSWarner Losh pccard_get_ ## A(device_t dev, T *t) \ 3268456e16eSWarner Losh { \ 3278456e16eSWarner Losh return BUS_READ_IVAR(device_get_parent(dev), dev, \ 3288456e16eSWarner Losh PCCARD_IVAR_ ## B, (uintptr_t *) t); \ 329e14c13daSWarner Losh } 330e14c13daSWarner Losh 3318456e16eSWarner Losh PCCARD_ACCESSOR(ether, ETHADDR, u_int8_t) 3328456e16eSWarner Losh PCCARD_ACCESSOR(vendor, VENDOR, u_int32_t) 3338456e16eSWarner Losh PCCARD_ACCESSOR(product, PRODUCT, u_int32_t) 3348456e16eSWarner Losh PCCARD_ACCESSOR(function_number,FUNCTION_NUMBER, u_int32_t) 335dc8e185fSWarner Losh PCCARD_ACCESSOR(function, FUNCTION, u_int32_t) 3368456e16eSWarner Losh PCCARD_ACCESSOR(vendor_str, VENDOR_STR, char *) 3378456e16eSWarner Losh PCCARD_ACCESSOR(product_str, PRODUCT_STR, char *) 3388456e16eSWarner Losh PCCARD_ACCESSOR(cis3_str, CIS3_STR, char *) 3398456e16eSWarner Losh 3400a177c3dSDuncan Barclay /* shared memory flags */ 341e14c13daSWarner Losh enum { 3420a177c3dSDuncan Barclay PCCARD_A_MEM_COM, /* common */ 3430a177c3dSDuncan Barclay PCCARD_A_MEM_ATTR, /* attribute */ 3440a177c3dSDuncan Barclay PCCARD_A_MEM_8BIT, /* 8 bit */ 3450a177c3dSDuncan Barclay PCCARD_A_MEM_16BIT /* 16 bit */ 346e14c13daSWarner Losh }; 347e14c13daSWarner Losh 348c8ce264eSWarner Losh #define PCCARD_SOFTC(d) (struct pccard_softc *) device_get_softc(d) 3495f7e36d1SWarner Losh #define PCCARD_IVAR(d) (struct pccard_ivar *) device_get_ivars(d) 350