376 lines
12 KiB
C
376 lines
12 KiB
C
/* $NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $ */
|
|
/* $FreeBSD$ */
|
|
|
|
/*
|
|
* Copyright (c) 1997 Marc Horowitz. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by Marc Horowitz.
|
|
* 4. The name of the author may not be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
extern int pccard_verbose;
|
|
|
|
/*
|
|
* Contains information about mapped/allocated i/o spaces.
|
|
*/
|
|
struct pccard_io_handle {
|
|
bus_space_tag_t iot; /* bus space tag (from chipset) */
|
|
bus_space_handle_t ioh; /* mapped space handle */
|
|
bus_addr_t addr; /* resulting address in bus space */
|
|
bus_size_t size; /* size of i/o space */
|
|
int flags; /* misc. information */
|
|
int width;
|
|
};
|
|
|
|
#define PCCARD_IO_ALLOCATED 0x01 /* i/o space was allocated */
|
|
|
|
/*
|
|
* Contains information about allocated memory space.
|
|
*/
|
|
struct pccard_mem_handle {
|
|
bus_space_tag_t memt; /* bus space tag (from chipset) */
|
|
bus_space_handle_t memh; /* mapped space handle */
|
|
bus_addr_t addr; /* resulting address in bus space */
|
|
bus_size_t size; /* size of mem space */
|
|
bus_size_t realsize; /* how much we really allocated */
|
|
bus_addr_t cardaddr; /* Absolute address on card */
|
|
int kind;
|
|
};
|
|
|
|
/* pccard itself */
|
|
|
|
#define PCCARD_CFE_MWAIT_REQUIRED 0x0001
|
|
#define PCCARD_CFE_RDYBSY_ACTIVE 0x0002
|
|
#define PCCARD_CFE_WP_ACTIVE 0x0004
|
|
#define PCCARD_CFE_BVD_ACTIVE 0x0008
|
|
#define PCCARD_CFE_IO8 0x0010
|
|
#define PCCARD_CFE_IO16 0x0020
|
|
#define PCCARD_CFE_IRQSHARE 0x0040
|
|
#define PCCARD_CFE_IRQPULSE 0x0080
|
|
#define PCCARD_CFE_IRQLEVEL 0x0100
|
|
#define PCCARD_CFE_POWERDOWN 0x0200
|
|
#define PCCARD_CFE_READONLY 0x0400
|
|
#define PCCARD_CFE_AUDIO 0x0800
|
|
|
|
struct pccard_config_entry {
|
|
int number;
|
|
uint32_t flags;
|
|
int iftype;
|
|
int num_iospace;
|
|
|
|
/*
|
|
* The card will only decode this mask in any case, so we can
|
|
* do dynamic allocation with this in mind, in case the suggestions
|
|
* below are no good.
|
|
*/
|
|
u_long iomask;
|
|
struct {
|
|
u_long length;
|
|
u_long start;
|
|
} iospace[4]; /* XXX this could be as high as 16 */
|
|
uint16_t irqmask;
|
|
int num_memspace;
|
|
struct {
|
|
u_long length;
|
|
u_long cardaddr;
|
|
u_long hostaddr;
|
|
} memspace[2]; /* XXX this could be as high as 8 */
|
|
int maxtwins;
|
|
struct resource *iores[4];
|
|
int iorid[4];
|
|
struct resource *irqres;
|
|
int irqrid;
|
|
struct resource *memres[2];
|
|
int memrid[2];
|
|
STAILQ_ENTRY(pccard_config_entry) cfe_list;
|
|
};
|
|
|
|
struct pccard_funce_disk {
|
|
int pfd_interface;
|
|
};
|
|
|
|
struct pccard_funce_lan {
|
|
int pfl_nidlen;
|
|
uint8_t pfl_nid[8];
|
|
};
|
|
|
|
union pccard_funce {
|
|
struct pccard_funce_disk pfv_disk;
|
|
struct pccard_funce_lan pfv_lan;
|
|
};
|
|
|
|
struct pccard_function {
|
|
/* read off the card */
|
|
int number;
|
|
int function;
|
|
int last_config_index;
|
|
uint32_t ccr_base; /* Offset with card's memory */
|
|
uint32_t ccr_mask;
|
|
struct resource *ccr_res;
|
|
int ccr_rid;
|
|
STAILQ_HEAD(, pccard_config_entry) cfe_head;
|
|
STAILQ_ENTRY(pccard_function) pf_list;
|
|
/* run-time state */
|
|
struct pccard_softc *sc;
|
|
struct pccard_config_entry *cfe;
|
|
struct pccard_mem_handle pf_pcmh;
|
|
device_t dev;
|
|
#define pf_ccrt pf_pcmh.memt
|
|
#define pf_ccrh pf_pcmh.memh
|
|
#define pf_ccr_realsize pf_pcmh.realsize
|
|
uint32_t pf_ccr_offset; /* Offset from ccr_base of CIS */
|
|
int pf_ccr_window;
|
|
bus_addr_t pf_mfc_iobase;
|
|
bus_addr_t pf_mfc_iomax;
|
|
int pf_flags;
|
|
driver_intr_t *intr_handler;
|
|
void *intr_handler_arg;
|
|
void *intr_handler_cookie;
|
|
|
|
union pccard_funce pf_funce; /* CISTPL_FUNCE */
|
|
#define pf_funce_disk_interface pf_funce.pfv_disk.pfd_interface
|
|
#define pf_funce_lan_nid pf_funce.pfv_lan.pfl_nid
|
|
#define pf_funce_lan_nidlen pf_funce.pfv_lan.pfl_nidlen
|
|
};
|
|
|
|
/* pf_flags */
|
|
#define PFF_ENABLED 0x0001 /* function is enabled */
|
|
|
|
struct pccard_card {
|
|
int cis1_major;
|
|
int cis1_minor;
|
|
/* XXX waste of space? */
|
|
char cis1_info_buf[256];
|
|
char *cis1_info[4];
|
|
/*
|
|
* Use int32_t for manufacturer and product so that they can
|
|
* hold the id value found in card CIS and special value that
|
|
* indicates no id was found.
|
|
*/
|
|
int32_t manufacturer;
|
|
#define PCMCIA_VENDOR_INVALID -1
|
|
int32_t product;
|
|
#define PCMCIA_PRODUCT_INVALID -1
|
|
int16_t prodext;
|
|
uint16_t error;
|
|
#define PCMCIA_CIS_INVALID { NULL, NULL, NULL, NULL }
|
|
STAILQ_HEAD(, pccard_function) pf_head;
|
|
};
|
|
|
|
#define PCCARD_WIDTH_AUTO 0
|
|
#define PCCARD_WIDTH_IO8 1
|
|
#define PCCARD_WIDTH_IO16 2
|
|
|
|
/* More later? */
|
|
struct pccard_ivar {
|
|
struct resource_list resources;
|
|
struct pccard_function *fcn;
|
|
};
|
|
|
|
struct pccard_softc {
|
|
device_t dev;
|
|
/* this stuff is for the socket */
|
|
|
|
/* this stuff is for the card */
|
|
struct pccard_card card;
|
|
int sc_enabled_count; /* num functions enabled */
|
|
};
|
|
|
|
struct pccard_cis_quirk {
|
|
int32_t manufacturer;
|
|
int32_t product;
|
|
char *cis1_info[4];
|
|
struct pccard_function *pf;
|
|
struct pccard_config_entry *cfe;
|
|
};
|
|
|
|
struct pccard_tuple {
|
|
unsigned int code;
|
|
unsigned int length;
|
|
u_long mult;
|
|
bus_addr_t ptr;
|
|
bus_space_tag_t memt;
|
|
bus_space_handle_t memh;
|
|
};
|
|
|
|
struct pccard_product {
|
|
const char *pp_name; /* NULL if end of table */
|
|
#define PCCARD_VENDOR_ANY (0xffffffff)
|
|
uint32_t pp_vendor;
|
|
#define PCCARD_PRODUCT_ANY (0xffffffff)
|
|
uint32_t pp_product;
|
|
int pp_expfunc;
|
|
const char *pp_cis[4];
|
|
};
|
|
|
|
typedef int (*pccard_product_match_fn) (device_t dev,
|
|
const struct pccard_product *ent, int vpfmatch);
|
|
|
|
#include "card_if.h"
|
|
|
|
/*
|
|
* make this inline so that we don't have to worry about dangling references
|
|
* to it in the modules or the code.
|
|
*/
|
|
static __inline const struct pccard_product *
|
|
pccard_product_lookup(device_t dev, const struct pccard_product *tab,
|
|
size_t ent_size, pccard_product_match_fn matchfn)
|
|
{
|
|
return CARD_DO_PRODUCT_LOOKUP(device_get_parent(dev), dev,
|
|
tab, ent_size, matchfn);
|
|
}
|
|
|
|
void pccard_read_cis(struct pccard_softc *);
|
|
void pccard_check_cis_quirks(device_t);
|
|
void pccard_print_cis(device_t);
|
|
int pccard_scan_cis(device_t,
|
|
int (*) (struct pccard_tuple *, void *), void *);
|
|
|
|
#define pccard_cis_read_1(tuple, idx0) \
|
|
(bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0)))
|
|
|
|
#define pccard_tuple_read_1(tuple, idx1) \
|
|
(pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1)))))
|
|
|
|
#define pccard_tuple_read_2(tuple, idx2) \
|
|
(pccard_tuple_read_1((tuple), (idx2)) | \
|
|
(pccard_tuple_read_1((tuple), (idx2)+1)<<8))
|
|
|
|
#define pccard_tuple_read_3(tuple, idx3) \
|
|
(pccard_tuple_read_1((tuple), (idx3)) | \
|
|
(pccard_tuple_read_1((tuple), (idx3)+1)<<8) | \
|
|
(pccard_tuple_read_1((tuple), (idx3)+2)<<16))
|
|
|
|
#define pccard_tuple_read_4(tuple, idx4) \
|
|
(pccard_tuple_read_1((tuple), (idx4)) | \
|
|
(pccard_tuple_read_1((tuple), (idx4)+1)<<8) | \
|
|
(pccard_tuple_read_1((tuple), (idx4)+2)<<16) | \
|
|
(pccard_tuple_read_1((tuple), (idx4)+3)<<24))
|
|
|
|
#define pccard_tuple_read_n(tuple, n, idxn) \
|
|
(((n)==1)?pccard_tuple_read_1((tuple), (idxn)) : \
|
|
(((n)==2)?pccard_tuple_read_2((tuple), (idxn)) : \
|
|
(((n)==3)?pccard_tuple_read_3((tuple), (idxn)) : \
|
|
/* n == 4 */ pccard_tuple_read_4((tuple), (idxn)))))
|
|
|
|
#define PCCARD_SPACE_MEMORY 1
|
|
#define PCCARD_SPACE_IO 2
|
|
|
|
#define pccard_mfc(sc) \
|
|
(STAILQ_FIRST(&(sc)->card.pf_head) && \
|
|
STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list))
|
|
|
|
#define pccard_io_alloc(pf, start, size, align, pciop) \
|
|
(pccard_chip_io_alloc((pf)->sc->pct, pf->sc->pch, (start), \
|
|
(size), (align), (pciop)))
|
|
|
|
#define pccard_io_free(pf, pciohp) \
|
|
(pccard_chip_io_free((pf)->sc->pct, (pf)->sc->pch, (pciohp)))
|
|
|
|
int pccard_io_map(struct pccard_function *, int, bus_addr_t,
|
|
bus_size_t, struct pccard_io_handle *, int *);
|
|
void pccard_io_unmap(struct pccard_function *, int);
|
|
|
|
#define pccard_mem_alloc(pf, size, pcmhp) \
|
|
(pccard_chip_mem_alloc((pf)->sc->pct, (pf)->sc->pch, (size), (pcmhp)))
|
|
#define pccard_mem_free(pf, pcmhp) \
|
|
(pccard_chip_mem_free((pf)->sc->pct, (pf)->sc->pch, (pcmhp)))
|
|
#define pccard_mem_map(pf, kind, card_addr, size, pcmhp, offsetp, windowp) \
|
|
(pccard_chip_mem_map((pf)->sc->pct, (pf)->sc->pch, (kind), \
|
|
(card_addr), (size), (pcmhp), (offsetp), (windowp)))
|
|
#define pccard_mem_unmap(pf, window) \
|
|
(pccard_chip_mem_unmap((pf)->sc->pct, (pf)->sc->pch, (window)))
|
|
|
|
/* compat layer */
|
|
static __inline int
|
|
pccard_compat_probe(device_t dev)
|
|
{
|
|
return (CARD_COMPAT_DO_PROBE(device_get_parent(dev), dev));
|
|
}
|
|
|
|
static __inline int
|
|
pccard_compat_attach(device_t dev)
|
|
{
|
|
return (CARD_COMPAT_DO_ATTACH(device_get_parent(dev), dev));
|
|
}
|
|
|
|
/* ivar interface */
|
|
enum {
|
|
PCCARD_IVAR_ETHADDR, /* read ethernet address from CIS tupple */
|
|
PCCARD_IVAR_VENDOR,
|
|
PCCARD_IVAR_PRODUCT,
|
|
PCCARD_IVAR_PRODEXT,
|
|
PCCARD_IVAR_FUNCTION_NUMBER,
|
|
PCCARD_IVAR_VENDOR_STR, /* CIS string for "Manufacturer" */
|
|
PCCARD_IVAR_PRODUCT_STR,/* CIS strnig for "Product" */
|
|
PCCARD_IVAR_CIS3_STR,
|
|
PCCARD_IVAR_CIS4_STR,
|
|
PCCARD_IVAR_FUNCTION
|
|
};
|
|
|
|
#define PCCARD_ACCESSOR(A, B, T) \
|
|
__inline static int \
|
|
pccard_get_ ## A(device_t dev, T *t) \
|
|
{ \
|
|
return BUS_READ_IVAR(device_get_parent(dev), dev, \
|
|
PCCARD_IVAR_ ## B, (uintptr_t *) t); \
|
|
}
|
|
|
|
PCCARD_ACCESSOR(ether, ETHADDR, uint8_t)
|
|
PCCARD_ACCESSOR(vendor, VENDOR, uint32_t)
|
|
PCCARD_ACCESSOR(product, PRODUCT, uint32_t)
|
|
PCCARD_ACCESSOR(prodext, PRODEXT, uint16_t)
|
|
PCCARD_ACCESSOR(function_number,FUNCTION_NUMBER, uint32_t)
|
|
PCCARD_ACCESSOR(function, FUNCTION, uint32_t)
|
|
PCCARD_ACCESSOR(vendor_str, VENDOR_STR, const char *)
|
|
PCCARD_ACCESSOR(product_str, PRODUCT_STR, const char *)
|
|
PCCARD_ACCESSOR(cis3_str, CIS3_STR, const char *)
|
|
PCCARD_ACCESSOR(cis4_str, CIS4_STR, const char *)
|
|
|
|
/* shared memory flags */
|
|
enum {
|
|
PCCARD_A_MEM_COM, /* common */
|
|
PCCARD_A_MEM_ATTR, /* attribute */
|
|
PCCARD_A_MEM_8BIT, /* 8 bit */
|
|
PCCARD_A_MEM_16BIT /* 16 bit */
|
|
};
|
|
|
|
#define PCCARD_SOFTC(d) (struct pccard_softc *) device_get_softc(d)
|
|
#define PCCARD_IVAR(d) (struct pccard_ivar *) device_get_ivars(d)
|
|
|
|
#define PCCARD_S(a, b) PCMCIA_STR_ ## a ## _ ## b
|
|
#define PCCARD_P(a, b) PCMCIA_PRODUCT_ ## a ## _ ## b
|
|
#define PCCARD_C(a, b) PCMCIA_CIS_ ## a ## _ ## b
|
|
#define PCMCIA_CARD_D(v, p, f) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \
|
|
PCCARD_P(v, p), f, PCCARD_C(v, p) }
|
|
#define PCMCIA_CARD2_D(v1, p1, p2, f) \
|
|
{ PCMCIA_STR_ ## p2, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
|
|
f, PCMCIA_CIS_ ## p2}
|
|
#define PCMCIA_CARD(v, p, f) { NULL, PCMCIA_VENDOR_ ## v, \
|
|
PCCARD_P(v, p), f, PCCARD_C(v, p) }
|
|
#define PCMCIA_CARD2(v1, p1, p2, f) \
|
|
{ NULL, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
|
|
f, PCMCIA_CIS_ ## p2}
|