pccardvar.h revision 150371 
1/*	$NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $	*/
2/* $FreeBSD: head/sys/dev/pccard/pccardvar.h 150371 2005-09-20 10:25:51Z glebius $ */
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/*
34 * PCCARD_API_LEVEL.  When set to 5, we provide a 5.x compatable API
35 * for driver writers that have to share their code between 5.x and 6.x.
36 * The 5.x compatibility interfaces will be unsupported in 7.0, at which
37 * point we'll only support 6 and newer, etc.
38 */
39#ifndef PCCARD_API_LEVEL
40#define PCCARD_API_LEVEL 6
41#elif PCCARD_API_LEVEL < 5
42#error "pccard API less than 5 unsupported"
43#endif
44
45/*
46 * Contains information about mapped/allocated i/o spaces.
47 */
48struct pccard_io_handle {
49	bus_space_tag_t iot;		/* bus space tag (from chipset) */
50	bus_space_handle_t ioh;		/* mapped space handle */
51	bus_addr_t      addr;		/* resulting address in bus space */
52	bus_size_t      size;		/* size of i/o space */
53	int             flags;		/* misc. information */
54	int		width;
55};
56
57#define	PCCARD_IO_ALLOCATED	0x01	/* i/o space was allocated */
58
59/*
60 * Contains information about allocated memory space.
61 */
62struct pccard_mem_handle {
63	bus_space_tag_t memt;		/* bus space tag (from chipset) */
64	bus_space_handle_t memh;	/* mapped space handle */
65	bus_addr_t      addr;		/* resulting address in bus space */
66	bus_size_t      size;		/* size of mem space */
67	bus_size_t      realsize;	/* how much we really allocated */
68	bus_addr_t	cardaddr;	/* Absolute address on card */
69	int		kind;
70};
71
72#define	PCCARD_WIDTH_AUTO	0
73#define	PCCARD_WIDTH_IO8	1
74#define	PCCARD_WIDTH_IO16	2
75
76struct pccard_tuple {
77	unsigned int	code;
78	unsigned int	length;
79	u_long		mult;		/* dist btn successive bytes */
80	bus_addr_t	ptr;
81	bus_space_tag_t	memt;
82	bus_space_handle_t memh;
83};
84
85typedef int (*pccard_scan_t)(const struct pccard_tuple *, void *);
86
87struct pccard_product {
88	const char	*pp_name;		/* NULL if end of table */
89#define PCCARD_VENDOR_ANY (0xffffffff)
90	uint32_t	pp_vendor;
91#define PCCARD_PRODUCT_ANY (0xffffffff)
92	uint32_t	pp_product;
93	const char	*pp_cis[4];
94};
95
96typedef int (*pccard_product_match_fn) (device_t dev,
97    const struct pccard_product *ent, int vpfmatch);
98
99#include "card_if.h"
100
101/*
102 * make this inline so that we don't have to worry about dangling references
103 * to it in the modules or the code.
104 */
105static __inline const struct pccard_product *
106pccard_product_lookup(device_t dev, const struct pccard_product *tab,
107    size_t ent_size, pccard_product_match_fn matchfn)
108{
109	return CARD_DO_PRODUCT_LOOKUP(device_get_parent(dev), dev,
110	    tab, ent_size, matchfn);
111}
112
113#define	pccard_cis_read_1(tuple, idx0)					\
114	(bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0)))
115
116#define	pccard_tuple_read_1(tuple, idx1)				\
117	(pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1)))))
118
119#define	pccard_tuple_read_2(tuple, idx2)				\
120	(pccard_tuple_read_1((tuple), (idx2)) |				\
121	 (pccard_tuple_read_1((tuple), (idx2)+1)<<8))
122
123#define	pccard_tuple_read_3(tuple, idx3)				\
124	(pccard_tuple_read_1((tuple), (idx3)) |				\
125	 (pccard_tuple_read_1((tuple), (idx3)+1)<<8) |			\
126	 (pccard_tuple_read_1((tuple), (idx3)+2)<<16))
127
128#define	pccard_tuple_read_4(tuple, idx4)				\
129	(pccard_tuple_read_1((tuple), (idx4)) |				\
130	 (pccard_tuple_read_1((tuple), (idx4)+1)<<8) |			\
131	 (pccard_tuple_read_1((tuple), (idx4)+2)<<16) |			\
132	 (pccard_tuple_read_1((tuple), (idx4)+3)<<24))
133
134#define	pccard_tuple_read_n(tuple, n, idxn)				\
135	(((n)==1)?pccard_tuple_read_1((tuple), (idxn)) :		\
136	 (((n)==2)?pccard_tuple_read_2((tuple), (idxn)) :		\
137	  (((n)==3)?pccard_tuple_read_3((tuple), (idxn)) :		\
138	   /* n == 4 */ pccard_tuple_read_4((tuple), (idxn)))))
139
140#define	PCCARD_SPACE_MEMORY	1
141#define	PCCARD_SPACE_IO		2
142
143#define	pccard_mfc(sc)							\
144		(STAILQ_FIRST(&(sc)->card.pf_head) &&			\
145		 STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list))
146
147/* compat layer */
148static __inline int
149pccard_compat_probe(device_t dev)
150{
151	return (CARD_COMPAT_DO_PROBE(device_get_parent(dev), dev));
152}
153
154static __inline int
155pccard_compat_attach(device_t dev)
156{
157	return (CARD_COMPAT_DO_ATTACH(device_get_parent(dev), dev));
158}
159
160/* Convenience functions */
161
162static __inline int
163pccard_cis_scan(device_t dev, pccard_scan_t fct, void *arg)
164{
165	return (CARD_CIS_SCAN(device_get_parent(dev), dev, fct, arg));
166}
167
168static __inline int
169pccard_attr_read_1(device_t dev, uint32_t offset, uint8_t *val)
170{
171	return (CARD_ATTR_READ(device_get_parent(dev), dev, offset, val));
172}
173
174static __inline int
175pccard_attr_write_1(device_t dev, uint32_t offset, uint8_t val)
176{
177	return (CARD_ATTR_WRITE(device_get_parent(dev), dev, offset, val));
178}
179
180static __inline int
181pccard_ccr_read_1(device_t dev, uint32_t offset, uint8_t *val)
182{
183	return (CARD_CCR_READ(device_get_parent(dev), dev, offset, val));
184}
185
186static __inline int
187pccard_ccr_write_1(device_t dev, uint32_t offset, uint8_t val)
188{
189	return (CARD_CCR_WRITE(device_get_parent(dev), dev, offset, val));
190}
191
192/* ivar interface */
193enum {
194	PCCARD_IVAR_ETHADDR,	/* read ethernet address from CIS tupple */
195	PCCARD_IVAR_VENDOR,
196	PCCARD_IVAR_PRODUCT,
197	PCCARD_IVAR_PRODEXT,
198	PCCARD_IVAR_FUNCTION_NUMBER,
199	PCCARD_IVAR_VENDOR_STR,	/* CIS string for "Manufacturer" */
200	PCCARD_IVAR_PRODUCT_STR,/* CIS strnig for "Product" */
201	PCCARD_IVAR_CIS3_STR,
202	PCCARD_IVAR_CIS4_STR,
203	PCCARD_IVAR_FUNCTION
204};
205
206#define PCCARD_ACCESSOR(A, B, T)					\
207__inline static int							\
208pccard_get_ ## A(device_t dev, T *t)					\
209{									\
210	return BUS_READ_IVAR(device_get_parent(dev), dev,		\
211	    PCCARD_IVAR_ ## B, (uintptr_t *) t);			\
212}
213
214PCCARD_ACCESSOR(ether,		ETHADDR,		uint8_t)
215PCCARD_ACCESSOR(vendor,		VENDOR,			uint32_t)
216PCCARD_ACCESSOR(product,	PRODUCT,		uint32_t)
217PCCARD_ACCESSOR(prodext,	PRODEXT,		uint16_t)
218PCCARD_ACCESSOR(function_number,FUNCTION_NUMBER,	uint32_t)
219PCCARD_ACCESSOR(function,	FUNCTION,		uint32_t)
220PCCARD_ACCESSOR(vendor_str,	VENDOR_STR,		const char *)
221PCCARD_ACCESSOR(product_str,	PRODUCT_STR,		const char *)
222PCCARD_ACCESSOR(cis3_str,	CIS3_STR,		const char *)
223PCCARD_ACCESSOR(cis4_str,	CIS4_STR,		const char *)
224
225/* shared memory flags */
226enum {
227	PCCARD_A_MEM_COM,       /* common */
228	PCCARD_A_MEM_ATTR,      /* attribute */
229	PCCARD_A_MEM_8BIT,      /* 8 bit */
230	PCCARD_A_MEM_16BIT      /* 16 bit */
231};
232
233#define PCCARD_S(a, b) PCMCIA_STR_ ## a ## _ ## b
234#define PCCARD_P(a, b) PCMCIA_PRODUCT_ ## a ## _ ## b
235#define PCCARD_C(a, b) PCMCIA_CIS_ ## a ## _ ## b
236#if PCCARD_API_LEVEL >= 6
237#define PCMCIA_CARD_D(v, p) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \
238		PCCARD_P(v, p), PCCARD_C(v, p) }
239#define PCMCIA_CARD2_D(v1, p1, p2) \
240		{ PCMCIA_STR_ ## p2, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
241		  PCMCIA_CIS_ ## p2}
242#define PCMCIA_CARD(v, p) { NULL, PCMCIA_VENDOR_ ## v, \
243		PCCARD_P(v, p), PCCARD_C(v, p) }
244#define PCMCIA_CARD2(v1, p1, p2) \
245		{ NULL, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
246		  PCMCIA_CIS_ ## p2}
247#else
248#define PCMCIA_CARD_D(v, p, f) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \
249		PCCARD_P(v, p), PCCARD_C(v, p) }
250#define PCMCIA_CARD2_D(v1, p1, p2, f) \
251		{ PCMCIA_STR_ ## p2, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
252		  PCMCIA_CIS_ ## p2}
253#define PCMCIA_CARD(v, p, f) { NULL, PCMCIA_VENDOR_ ## v, \
254		PCCARD_P(v, p), PCCARD_C(v, p) }
255#define PCMCIA_CARD2(v1, p1, p2, f) \
256		{ NULL, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
257		  PCMCIA_CIS_ ## p2}
258#endif
259