xref: /freebsd/sys/dev/pccbb/pccbbvar.h (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
1 /*-
2  * Copyright (c) 2003-2004 Warner Losh.
3  * Copyright (c) 2000,2001 Jonathan Chen.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 /*
31  * Structure definitions for the Cardbus Bridge driver
32  */
33 
34 struct cbb_intrhand {
35 	driver_filter_t	*filt;
36 	driver_intr_t	*intr;
37 	void 		*arg;
38 	struct cbb_softc *sc;
39 	void		*cookie;
40 };
41 
42 struct cbb_reslist {
43 	SLIST_ENTRY(cbb_reslist) link;
44 	struct	resource *res;
45 	int	type;
46 	int	rid;
47 		/* note: unlike the regular resource list, there can be
48 		 * duplicate rid's in the same list.  However, the
49 		 * combination of rid and res->r_dev should be unique.
50 		 */
51 	bus_addr_t cardaddr; /* for 16-bit pccard memory */
52 };
53 
54 #define	CBB_AUTO_OPEN_SMALLHOLE 0x100
55 #define CBB_NSLOTS		4
56 
57 struct cbb_softc {
58 	device_t	dev;
59 	struct exca_softc exca[CBB_NSLOTS];
60 	struct		resource *base_res;
61 	struct		resource *irq_res;
62 	void		*intrhand;
63 	bus_space_tag_t bst;
64 	bus_space_handle_t bsh;
65 	uint32_t	domain;
66 	unsigned int	pribus;
67 	unsigned int	secbus;
68 	unsigned int	subbus;
69 	struct mtx	mtx;
70 	struct cv	cv;
71 	struct cv	powercv;
72 	int		cardok;
73 	u_int32_t	flags;
74 #define	CBB_16BIT_CARD		0x20000000
75 #define	CBB_KTHREAD_RUNNING	0x40000000
76 #define	CBB_KTHREAD_DONE	0x80000000
77 	int		chipset;		/* chipset id */
78 #define	CB_UNKNOWN	0		/* NOT Cardbus-PCI bridge */
79 #define	CB_TI113X	1		/* TI PCI1130/1131 */
80 #define	CB_TI12XX	2		/* TI PCI12xx/14xx/44xx/15xx/45xx */
81 #define	CB_TI125X	3		/* TI PCI1250/1251(B)/1450 */
82 #define	CB_RF5C47X	4		/* RICOH RF5C475/476/477 */
83 #define	CB_RF5C46X	5		/* RICOH RF5C465/466/467 */
84 #define	CB_CIRRUS	6		/* Cirrus Logic CLPD683x */
85 #define	CB_TOPIC95	7		/* Toshiba ToPIC95 */
86 #define	CB_TOPIC97	8		/* Toshiba ToPIC97/100 */
87 #define	CB_O2MICRO	9		/* O2Micro chips */
88 	SLIST_HEAD(, cbb_reslist) rl;
89 	device_t	cbdev;
90 	struct proc	*event_thread;
91 	void (*chipinit)(struct cbb_softc *);
92 	volatile int	powerintr;
93 };
94 
95 /* result of detect_card */
96 #define	CARD_UKN_CARD	0x00
97 #define	CARD_5V_CARD	0x01
98 #define	CARD_3V_CARD	0x02
99 #define	CARD_XV_CARD	0x04
100 #define	CARD_YV_CARD	0x08
101 
102 /* for power_socket */
103 #define	CARD_VCC(X)	(X)
104 #define CARD_VPP_VCC	0xf0
105 #define CARD_VCCMASK	0xf
106 #define CARD_VCCSHIFT	0
107 #define XV		2
108 #define YV		1
109 
110 #define CARD_OFF	(CARD_VCC(0))
111 
112 extern int cbb_debug;
113 extern devclass_t cbb_devclass;
114 
115 int	cbb_activate_resource(device_t brdev, device_t child,
116 	    int type, int rid, struct resource *r);
117 struct resource	*cbb_alloc_resource(device_t brdev, device_t child,
118 	    int type, int *rid, u_long start, u_long end, u_long count,
119 	    u_int flags);
120 void	cbb_child_detached(device_t brdev, device_t child);
121 int	cbb_child_present(device_t self);
122 int	cbb_deactivate_resource(device_t brdev, device_t child,
123 	    int type, int rid, struct resource *r);
124 int	cbb_detach(device_t brdev);
125 void	cbb_disable_func_intr(struct cbb_softc *sc);
126 void	cbb_driver_added(device_t brdev, driver_t *driver);
127 void	cbb_event_thread(void *arg);
128 int	cbb_pcic_set_memory_offset(device_t brdev, device_t child, int rid,
129 	    uint32_t cardaddr, uint32_t *deltap);
130 int	cbb_pcic_set_res_flags(device_t brdev, device_t child, int type,
131 	    int rid, uint32_t flags);
132 int	cbb_power(device_t brdev, int volts);
133 int	cbb_power_enable_socket(device_t brdev, device_t child);
134 void	cbb_power_disable_socket(device_t brdev, device_t child);
135 int	cbb_read_ivar(device_t brdev, device_t child, int which,
136 	    uintptr_t *result);
137 int	cbb_release_resource(device_t brdev, device_t child,
138 	    int type, int rid, struct resource *r);
139 int	cbb_resume(device_t self);
140 int	cbb_setup_intr(device_t dev, device_t child, struct resource *irq,
141 	    int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg,
142 	    void **cookiep);
143 int	cbb_suspend(device_t self);
144 int	cbb_teardown_intr(device_t dev, device_t child, struct resource *irq,
145 	    void *cookie);
146 int	cbb_write_ivar(device_t brdev, device_t child, int which,
147 	    uintptr_t value);
148 
149 /*
150  */
151 static __inline void
152 cbb_set(struct cbb_softc *sc, uint32_t reg, uint32_t val)
153 {
154 	bus_space_write_4(sc->bst, sc->bsh, reg, val);
155 }
156 
157 static __inline uint32_t
158 cbb_get(struct cbb_softc *sc, uint32_t reg)
159 {
160 	return (bus_space_read_4(sc->bst, sc->bsh, reg));
161 }
162 
163 static __inline void
164 cbb_setb(struct cbb_softc *sc, uint32_t reg, uint32_t bits)
165 {
166 	cbb_set(sc, reg, cbb_get(sc, reg) | bits);
167 }
168 
169 static __inline void
170 cbb_clrb(struct cbb_softc *sc, uint32_t reg, uint32_t bits)
171 {
172 	cbb_set(sc, reg, cbb_get(sc, reg) & ~bits);
173 }
174