xref: /freebsd/sys/dev/cardbus/cardbusvar.h (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1 /*-
2  * Copyright (c) 2000,2001 Jonathan Chen.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 /*
30  * Structure definitions for the Cardbus Bus driver
31  */
32 struct cardbus_devinfo
33 {
34 	struct pci_devinfo pci;
35 	uint8_t        mprefetchable; /* bit mask of prefetchable BARs */
36 	uint8_t        mbelow1mb; /* bit mask of BARs which require below 1Mb */
37 	uint8_t        ibelow1mb; /* bit mask of BARs which require below 1Mb */
38 	uint16_t	mfrid;		/* manufacturer id */
39 	uint16_t	prodid;		/* product id */
40 	u_int		funcid;		/* function id */
41 	union {
42 		struct {
43 			uint8_t	nid[6];		/* MAC address */
44 		} lan;
45 	} funce;
46 	uint32_t	fepresent;	/* bit mask of funce values present */
47 };
48 
49 struct cis_buffer
50 {
51 	size_t	len;			/* Actual length of the CIS */
52 	uint8_t buffer[2040];		/* small enough to be 2k */
53 };
54 
55 struct cardbus_softc
56 {
57 	/* XXX need mutex XXX */
58 	device_t	sc_dev;
59 	struct cdev 	*sc_cisdev;
60 	struct cis_buffer *sc_cis;
61 	int		sc_cis_open;
62 };
63 
64 struct tuple_callbacks;
65 
66 typedef int (tuple_cb) (device_t cbdev, device_t child, int id, int len,
67 		 uint8_t *tupledata, uint32_t start, uint32_t *off,
68 		 struct tuple_callbacks *info, void *);
69 
70 struct tuple_callbacks {
71 	int	id;
72 	char	*name;
73 	tuple_cb *func;
74 };
75 
76 int	cardbus_device_create(struct cardbus_softc *);
77 int	cardbus_device_destroy(struct cardbus_softc *);
78 int	cardbus_parse_cis(device_t cbdev, device_t child,
79 	    struct tuple_callbacks *callbacks, void *);
80