xref: /freebsd/sys/dev/pccard/pccardvar.h (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
1 /*	$NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $	*/
2 /* $FreeBSD$ */
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  */
48 struct 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  */
62 struct 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 /* Bits for kind */
73 #define	PCCARD_MEM_16BIT	1	/* 1 -> 16bit 0 -> 8bit */
74 #define PCCARD_MEM_ATTR		2	/* 1 -> attribute mem 0 -> common */
75 
76 #define	PCCARD_WIDTH_AUTO	0
77 #define	PCCARD_WIDTH_IO8	1
78 #define	PCCARD_WIDTH_IO16	2
79 
80 struct pccard_tuple {
81 	unsigned int	code;
82 	unsigned int	length;
83 	u_long		mult;		/* dist btn successive bytes */
84 	bus_addr_t	ptr;
85 	bus_space_tag_t	memt;
86 	bus_space_handle_t memh;
87 };
88 
89 typedef int (*pccard_scan_t)(const struct pccard_tuple *, void *);
90 
91 struct pccard_product {
92 	const char	*pp_name;
93 #define PCCARD_VENDOR_ANY (0xffffffff)
94 	uint32_t	pp_vendor;		/* 0 == end of table */
95 #define PCCARD_PRODUCT_ANY (0xffffffff)
96 	uint32_t	pp_product;
97 	const char	*pp_cis[4];
98 };
99 
100 typedef int (*pccard_product_match_fn) (device_t dev,
101     const struct pccard_product *ent, int vpfmatch);
102 
103 #include "card_if.h"
104 
105 /*
106  * make this inline so that we don't have to worry about dangling references
107  * to it in the modules or the code.
108  */
109 static __inline const struct pccard_product *
110 pccard_product_lookup(device_t dev, const struct pccard_product *tab,
111     size_t ent_size, pccard_product_match_fn matchfn)
112 {
113 	return CARD_DO_PRODUCT_LOOKUP(device_get_parent(dev), dev,
114 	    tab, ent_size, matchfn);
115 }
116 
117 #define	pccard_cis_read_1(tuple, idx0)					\
118 	(bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0)))
119 
120 #define	pccard_tuple_read_1(tuple, idx1)				\
121 	(pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1)))))
122 
123 #define	pccard_tuple_read_2(tuple, idx2)				\
124 	(pccard_tuple_read_1((tuple), (idx2)) |				\
125 	 (pccard_tuple_read_1((tuple), (idx2)+1)<<8))
126 
127 #define	pccard_tuple_read_3(tuple, idx3)				\
128 	(pccard_tuple_read_1((tuple), (idx3)) |				\
129 	 (pccard_tuple_read_1((tuple), (idx3)+1)<<8) |			\
130 	 (pccard_tuple_read_1((tuple), (idx3)+2)<<16))
131 
132 #define	pccard_tuple_read_4(tuple, idx4)				\
133 	(pccard_tuple_read_1((tuple), (idx4)) |				\
134 	 (pccard_tuple_read_1((tuple), (idx4)+1)<<8) |			\
135 	 (pccard_tuple_read_1((tuple), (idx4)+2)<<16) |			\
136 	 (pccard_tuple_read_1((tuple), (idx4)+3)<<24))
137 
138 #define	pccard_tuple_read_n(tuple, n, idxn)				\
139 	(((n)==1)?pccard_tuple_read_1((tuple), (idxn)) :		\
140 	 (((n)==2)?pccard_tuple_read_2((tuple), (idxn)) :		\
141 	  (((n)==3)?pccard_tuple_read_3((tuple), (idxn)) :		\
142 	   /* n == 4 */ pccard_tuple_read_4((tuple), (idxn)))))
143 
144 #define	PCCARD_SPACE_MEMORY	1
145 #define	PCCARD_SPACE_IO		2
146 
147 #define	pccard_mfc(sc)							\
148 		(STAILQ_FIRST(&(sc)->card.pf_head) &&			\
149 		 STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list))
150 
151 /* Convenience functions */
152 
153 static __inline int
154 pccard_cis_scan(device_t dev, pccard_scan_t fct, void *arg)
155 {
156 	return (CARD_CIS_SCAN(device_get_parent(dev), dev, fct, arg));
157 }
158 
159 static __inline int
160 pccard_attr_read_1(device_t dev, uint32_t offset, uint8_t *val)
161 {
162 	return (CARD_ATTR_READ(device_get_parent(dev), dev, offset, val));
163 }
164 
165 static __inline int
166 pccard_attr_write_1(device_t dev, uint32_t offset, uint8_t val)
167 {
168 	return (CARD_ATTR_WRITE(device_get_parent(dev), dev, offset, val));
169 }
170 
171 static __inline int
172 pccard_ccr_read_1(device_t dev, uint32_t offset, uint8_t *val)
173 {
174 	return (CARD_CCR_READ(device_get_parent(dev), dev, offset, val));
175 }
176 
177 static __inline int
178 pccard_ccr_write_1(device_t dev, uint32_t offset, uint8_t val)
179 {
180 	return (CARD_CCR_WRITE(device_get_parent(dev), dev, offset, val));
181 }
182 
183 /* Hack */
184 int pccard_select_cfe(device_t dev, int entry);
185 
186 /* ivar interface */
187 enum {
188 	PCCARD_IVAR_ETHADDR,	/* read ethernet address from CIS tupple */
189 	PCCARD_IVAR_VENDOR,
190 	PCCARD_IVAR_PRODUCT,
191 	PCCARD_IVAR_PRODEXT,
192 	PCCARD_IVAR_FUNCTION_NUMBER,
193 	PCCARD_IVAR_VENDOR_STR,	/* CIS string for "Manufacturer" */
194 	PCCARD_IVAR_PRODUCT_STR,/* CIS strnig for "Product" */
195 	PCCARD_IVAR_CIS3_STR,
196 	PCCARD_IVAR_CIS4_STR,
197 	PCCARD_IVAR_FUNCTION
198 };
199 
200 #define PCCARD_ACCESSOR(A, B, T)					\
201 __inline static int							\
202 pccard_get_ ## A(device_t dev, T *t)					\
203 {									\
204 	return BUS_READ_IVAR(device_get_parent(dev), dev,		\
205 	    PCCARD_IVAR_ ## B, (uintptr_t *) t);			\
206 }
207 
208 PCCARD_ACCESSOR(ether,		ETHADDR,		uint8_t)
209 PCCARD_ACCESSOR(vendor,		VENDOR,			uint32_t)
210 PCCARD_ACCESSOR(product,	PRODUCT,		uint32_t)
211 PCCARD_ACCESSOR(prodext,	PRODEXT,		uint16_t)
212 PCCARD_ACCESSOR(function_number,FUNCTION_NUMBER,	uint32_t)
213 PCCARD_ACCESSOR(function,	FUNCTION,		uint32_t)
214 PCCARD_ACCESSOR(vendor_str,	VENDOR_STR,		const char *)
215 PCCARD_ACCESSOR(product_str,	PRODUCT_STR,		const char *)
216 PCCARD_ACCESSOR(cis3_str,	CIS3_STR,		const char *)
217 PCCARD_ACCESSOR(cis4_str,	CIS4_STR,		const char *)
218 
219 /* shared memory flags */
220 enum {
221 	PCCARD_A_MEM_COM,       /* common */
222 	PCCARD_A_MEM_ATTR,      /* attribute */
223 	PCCARD_A_MEM_8BIT,      /* 8 bit */
224 	PCCARD_A_MEM_16BIT      /* 16 bit */
225 };
226 
227 #define PCCARD_S(a, b) PCMCIA_STR_ ## a ## _ ## b
228 #define PCCARD_P(a, b) PCMCIA_PRODUCT_ ## a ## _ ## b
229 #define PCCARD_C(a, b) PCMCIA_CIS_ ## a ## _ ## b
230 #if PCCARD_API_LEVEL >= 6
231 #define PCMCIA_CARD_D(v, p) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \
232 		PCCARD_P(v, p), PCCARD_C(v, p) }
233 #define PCMCIA_CARD2_D(v1, p1, p2) \
234 		{ PCMCIA_STR_ ## p2, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
235 		  PCMCIA_CIS_ ## p2}
236 #define PCMCIA_CARD(v, p) { NULL, PCMCIA_VENDOR_ ## v, \
237 		PCCARD_P(v, p), PCCARD_C(v, p) }
238 #define PCMCIA_CARD2(v1, p1, p2) \
239 		{ NULL, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
240 		  PCMCIA_CIS_ ## p2}
241 #else
242 #define PCMCIA_CARD_D(v, p, f) { PCCARD_S(v, p), PCMCIA_VENDOR_ ## v, \
243 		PCCARD_P(v, p), PCCARD_C(v, p) }
244 #define PCMCIA_CARD2_D(v1, p1, p2, f) \
245 		{ PCMCIA_STR_ ## p2, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
246 		  PCMCIA_CIS_ ## p2}
247 #define PCMCIA_CARD(v, p, f) { NULL, PCMCIA_VENDOR_ ## v, \
248 		PCCARD_P(v, p), PCCARD_C(v, p) }
249 #define PCMCIA_CARD2(v1, p1, p2, f) \
250 		{ NULL, PCMCIA_VENDOR_ ## v1, PCCARD_P(v1, p1), \
251 		  PCMCIA_CIS_ ## p2}
252 #endif
253