pccardvar.h revision 66200 
1/*	$NetBSD: pcmciavar.h,v 1.12 2000/02/08 12:51:31 enami Exp $	*/
2/* $FreeBSD: head/sys/dev/pccard/pccardvar.h 66200 2000-09-22 01:15:26Z imp $ */
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#include <sys/types.h>
34#include <sys/queue.h>
35
36#include <machine/bus.h>
37
38extern int	pccard_verbose;
39
40/*
41 * Contains information about mapped/allocated i/o spaces.
42 */
43struct pccard_io_handle {
44	bus_space_tag_t iot;		/* bus space tag (from chipset) */
45	bus_space_handle_t ioh;		/* mapped space handle */
46	bus_addr_t      addr;		/* resulting address in bus space */
47	bus_size_t      size;		/* size of i/o space */
48	int             flags;		/* misc. information */
49	int		width;
50};
51
52#define	PCCARD_IO_ALLOCATED	0x01	/* i/o space was allocated */
53
54/*
55 * Contains information about allocated memory space.
56 */
57struct pccard_mem_handle {
58	bus_space_tag_t memt;		/* bus space tag (from chipset) */
59	bus_space_handle_t memh;	/* mapped space handle */
60	bus_addr_t      addr;		/* resulting address in bus space */
61	bus_size_t      size;		/* size of mem space */
62	bus_size_t      realsize;	/* how much we really allocated */
63	long		offset;
64	int		kind;
65};
66
67/* pccard itself */
68
69#define PCCARD_CFE_MWAIT_REQUIRED	0x0001
70#define PCCARD_CFE_RDYBSY_ACTIVE	0x0002
71#define PCCARD_CFE_WP_ACTIVE		0x0004
72#define PCCARD_CFE_BVD_ACTIVE		0x0008
73#define PCCARD_CFE_IO8			0x0010
74#define PCCARD_CFE_IO16			0x0020
75#define PCCARD_CFE_IRQSHARE		0x0040
76#define PCCARD_CFE_IRQPULSE		0x0080
77#define PCCARD_CFE_IRQLEVEL		0x0100
78#define PCCARD_CFE_POWERDOWN		0x0200
79#define PCCARD_CFE_READONLY		0x0400
80#define PCCARD_CFE_AUDIO		0x0800
81
82struct pccard_config_entry {
83	int		number;
84	u_int32_t	flags;
85	int		iftype;
86	int		num_iospace;
87
88	/*
89	 * The card will only decode this mask in any case, so we can
90	 * do dynamic allocation with this in mind, in case the suggestions
91	 * below are no good.
92	 */
93	u_long		iomask;
94	struct {
95		u_long	length;
96		u_long	start;
97	} iospace[4];		/* XXX this could be as high as 16 */
98	u_int16_t	irqmask;
99	int		num_memspace;
100	struct {
101		u_long	length;
102		u_long	cardaddr;
103		u_long	hostaddr;
104	} memspace[2];		/* XXX this could be as high as 8 */
105	int		maxtwins;
106	STAILQ_ENTRY(pccard_config_entry) cfe_list;
107};
108
109struct pccard_function {
110	/* read off the card */
111	int		number;
112	int		function;
113	int		last_config_index;
114	u_long		ccr_base;
115	u_long		ccr_mask;
116	struct resource *ccr_res;
117	int		ccr_rid;
118	STAILQ_HEAD(, pccard_config_entry) cfe_head;
119	STAILQ_ENTRY(pccard_function) pf_list;
120	/* run-time state */
121	struct pccard_softc *sc;
122	struct pccard_config_entry *cfe;
123	struct pccard_mem_handle pf_pcmh;
124	device_t	dev;
125#define	pf_ccrt		pf_pcmh.memt
126#define	pf_ccrh		pf_pcmh.memh
127#define	pf_ccr_realsize	pf_pcmh.realsize
128	bus_addr_t	pf_ccr_offset;
129	int		pf_ccr_window;
130	long		pf_mfc_iobase;
131	long		pf_mfc_iomax;
132	int		(*ih_fct)(void *);
133	void		*ih_arg;
134	int		ih_ipl;
135	int		pf_flags;
136};
137
138/* pf_flags */
139#define	PFF_ENABLED	0x0001		/* function is enabled */
140
141struct pccard_card {
142	int		cis1_major;
143	int		cis1_minor;
144	/* XXX waste of space? */
145	char		cis1_info_buf[256];
146	char		*cis1_info[4];
147	/*
148	 * Use int32_t for manufacturer and product so that they can
149	 * hold the id value found in card CIS and special value that
150	 * indicates no id was found.
151	 */
152	int32_t		manufacturer;
153#define	PCCARD_VENDOR_INVALID	-1
154	int32_t		product;
155#define	PCCARD_PRODUCT_INVALID		-1
156	u_int16_t	error;
157#define	PCCARD_CIS_INVALID		{ NULL, NULL, NULL, NULL }
158	STAILQ_HEAD(, pccard_function) pf_head;
159};
160
161#define	PCCARD_MEM_ATTR		1
162#define	PCCARD_MEM_COMMON	2
163
164#define	PCCARD_WIDTH_AUTO	0
165#define	PCCARD_WIDTH_IO8	1
166#define	PCCARD_WIDTH_IO16	2
167
168/* More later? */
169struct pccard_ivar {
170	struct resource_list resources;
171	struct pccard_function *fcn;
172};
173
174struct pccard_softc {
175	device_t		dev;
176	/* this stuff is for the socket */
177
178	/* this stuff is for the card */
179	struct pccard_card card;
180	int		sc_enabled_count;	/* num functions enabled */
181};
182
183void
184pccardbus_if_setup(struct pccard_softc*);
185
186struct pccard_cis_quirk {
187	int32_t manufacturer;
188	int32_t product;
189	char *cis1_info[4];
190	struct pccard_function *pf;
191	struct pccard_config_entry *cfe;
192};
193
194struct pccard_tuple {
195	unsigned int	code;
196	unsigned int	length;
197	u_long		mult;
198	bus_addr_t	ptr;
199	bus_space_tag_t	memt;
200	bus_space_handle_t memh;
201};
202
203struct pccard_product {
204	const char	*pp_name;		/* NULL if end of table */
205#define PCCARD_VENDOR_ANY ((u_int32_t) -1)
206	u_int32_t	pp_vendor;
207#define PCCARD_PRODUCT_ANY ((u_int32_t) -1)
208	u_int32_t	pp_product;
209	int		pp_expfunc;
210	const char	*pp_vendor_str;		/* NULL to not match */
211	const char	*pp_product_str;	/* NULL to not match */
212};
213
214typedef int (*pccard_product_match_fn) (device_t dev,
215    const struct pccard_product *ent, int vpfmatch);
216
217const struct pccard_product
218	*pccard_product_lookup(device_t dev, const struct pccard_product *tab,
219	    size_t ent_size, pccard_product_match_fn matchfn);
220
221void	pccard_read_cis(struct pccard_softc *);
222void	pccard_check_cis_quirks(device_t);
223void	pccard_print_cis(device_t);
224int	pccard_scan_cis(device_t,
225		int (*) (struct pccard_tuple *, void *), void *);
226
227#define	pccard_cis_read_1(tuple, idx0)					\
228	(bus_space_read_1((tuple)->memt, (tuple)->memh, (tuple)->mult*(idx0)))
229
230#define	pccard_tuple_read_1(tuple, idx1)				\
231	(pccard_cis_read_1((tuple), ((tuple)->ptr+(2+(idx1)))))
232
233#define	pccard_tuple_read_2(tuple, idx2)				\
234	(pccard_tuple_read_1((tuple), (idx2)) | 			\
235	 (pccard_tuple_read_1((tuple), (idx2)+1)<<8))
236
237#define	pccard_tuple_read_3(tuple, idx3)				\
238	(pccard_tuple_read_1((tuple), (idx3)) |				\
239	 (pccard_tuple_read_1((tuple), (idx3)+1)<<8) |			\
240	 (pccard_tuple_read_1((tuple), (idx3)+2)<<16))
241
242#define	pccard_tuple_read_4(tuple, idx4)				\
243	(pccard_tuple_read_1((tuple), (idx4)) |				\
244	 (pccard_tuple_read_1((tuple), (idx4)+1)<<8) |			\
245	 (pccard_tuple_read_1((tuple), (idx4)+2)<<16) |			\
246	 (pccard_tuple_read_1((tuple), (idx4)+3)<<24))
247
248#define	pccard_tuple_read_n(tuple, n, idxn)				\
249	(((n)==1)?pccard_tuple_read_1((tuple), (idxn)) :		\
250	 (((n)==2)?pccard_tuple_read_2((tuple), (idxn)) :		\
251	  (((n)==3)?pccard_tuple_read_3((tuple), (idxn)) :		\
252	   /* n == 4 */ pccard_tuple_read_4((tuple), (idxn)))))
253
254#define	PCCARD_SPACE_MEMORY	1
255#define	PCCARD_SPACE_IO		2
256
257int	pccard_ccr_read(struct pccard_function *, int);
258void	pccard_ccr_write(struct pccard_function *, int, int);
259
260#define	pccard_mfc(sc)	(STAILQ_FIRST(&(sc)->card.pf_head) &&		\
261		 STAILQ_NEXT(STAILQ_FIRST(&(sc)->card.pf_head),pf_list))
262
263/* The following is the vestages of the NetBSD driver api */
264
265void	pccard_function_init(struct pccard_function *);
266int	pccard_function_enable(struct pccard_function *);
267void	pccard_function_disable(struct pccard_function *);
268
269#define	pccard_io_alloc(pf, start, size, align, pciop)			\
270	(pccard_chip_io_alloc((pf)->sc->pct, pf->sc->pch, (start),	\
271	 (size), (align), (pciop)))
272
273#define	pccard_io_free(pf, pciohp)					\
274	(pccard_chip_io_free((pf)->sc->pct, (pf)->sc->pch, (pciohp)))
275
276int	pccard_io_map(struct pccard_function *, int, bus_addr_t,
277	    bus_size_t, struct pccard_io_handle *, int *);
278void	pccard_io_unmap(struct pccard_function *, int);
279
280#define pccard_mem_alloc(pf, size, pcmhp)				\
281	(pccard_chip_mem_alloc((pf)->sc->pct, (pf)->sc->pch, (size), (pcmhp)))
282#define pccard_mem_free(pf, pcmhp)					\
283	(pccard_chip_mem_free((pf)->sc->pct, (pf)->sc->pch, (pcmhp)))
284#define pccard_mem_map(pf, kind, card_addr, size, pcmhp, offsetp, windowp) \
285	(pccard_chip_mem_map((pf)->sc->pct, (pf)->sc->pch, (kind),	\
286	 (card_addr), (size), (pcmhp), (offsetp), (windowp)))
287#define	pccard_mem_unmap(pf, window)					\
288	(pccard_chip_mem_unmap((pf)->sc->pct, (pf)->sc->pch, (window)))
289
290/* compat layer */
291int pccard_compat_probe(device_t dev);
292int pccard_compat_attach(device_t dev);
293
294/* ivar interface */
295enum {
296	PCCARD_IVAR_ETHADDR,	/* read ethernet address from CIS tupple */
297	PCCARD_IVAR_VENDOR,
298	PCCARD_IVAR_PRODUCT,
299	PCCARD_IVAR_FUNCTION_NUMBER,
300	PCCARD_IVAR_VENDOR_STR,	/* CIS string for "Manufacturer" */
301	PCCARD_IVAR_PRODUCT_STR,/* CIS strnig for "Product" */
302	PCCARD_IVAR_CIS3_STR	/* Some cards need this */
303};
304
305#define PCCARD_ACCESSOR(A, B, T)					\
306__inline static int							\
307pccard_get_ ## A(device_t dev, T *t)					\
308{									\
309	return BUS_READ_IVAR(device_get_parent(dev), dev, 		\
310	    PCCARD_IVAR_ ## B, (uintptr_t *) t);			\
311}
312
313PCCARD_ACCESSOR(ether,		ETHADDR,		u_int8_t)
314PCCARD_ACCESSOR(vendor,		VENDOR,			u_int32_t)
315PCCARD_ACCESSOR(product,	PRODUCT,		u_int32_t)
316PCCARD_ACCESSOR(function_number,FUNCTION_NUMBER,	u_int32_t)
317PCCARD_ACCESSOR(vendor_str,	VENDOR_STR,		char *)
318PCCARD_ACCESSOR(product_str,	PRODUCT_STR,		char *)
319PCCARD_ACCESSOR(cis3_str,	CIS3_STR,		char *)
320
321enum {
322	PCCARD_A_MEM_ATTR = 0x1
323};
324
325#define PCCARD_SOFTC(d) (struct pccard_softc *) device_get_softc(d)
326