pccbbvar.h revision 280970
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: stable/10/sys/dev/pccbb/pccbbvar.h 280970 2015-04-01 21:48:54Z jhb $
28 */
29
30/*
31 * Structure definitions for the Cardbus Bridge driver
32 */
33
34struct 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
42struct 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
57struct 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	struct pcib_secbus bus;
68	struct mtx	mtx;
69	int		cardok;
70	u_int32_t	flags;
71#define	CBB_16BIT_CARD		0x20000000
72#define	CBB_KTHREAD_RUNNING	0x40000000
73#define	CBB_KTHREAD_DONE	0x80000000
74	int		chipset;		/* chipset id */
75#define	CB_UNKNOWN	0		/* NOT Cardbus-PCI bridge */
76#define	CB_TI113X	1		/* TI PCI1130/1131 */
77#define	CB_TI12XX	2		/* TI PCI12xx/14xx/44xx/15xx/45xx */
78#define	CB_TI125X	3		/* TI PCI1250/1251(B)/1450 */
79#define	CB_RF5C47X	4		/* RICOH RF5C475/476/477 */
80#define	CB_RF5C46X	5		/* RICOH RF5C465/466/467 */
81#define	CB_CIRRUS	6		/* Cirrus Logic CLPD683x */
82#define	CB_TOPIC95	7		/* Toshiba ToPIC95 */
83#define	CB_TOPIC97	8		/* Toshiba ToPIC97/100 */
84#define	CB_O2MICRO	9		/* O2Micro chips */
85	SLIST_HEAD(, cbb_reslist) rl;
86	device_t	cbdev;
87	struct proc	*event_thread;
88	void (*chipinit)(struct cbb_softc *);
89	int	powerintr;
90	struct root_hold_token *sc_root_token;
91};
92
93/* result of detect_card */
94#define	CARD_UKN_CARD	0x00
95#define	CARD_5V_CARD	0x01
96#define	CARD_3V_CARD	0x02
97#define	CARD_XV_CARD	0x04
98#define	CARD_YV_CARD	0x08
99
100/* for power_socket */
101#define	CARD_VCC(X)	(X)
102#define CARD_VPP_VCC	0xf0
103#define CARD_VCCMASK	0xf
104#define CARD_VCCSHIFT	0
105#define XV		2
106#define YV		1
107
108#define CARD_OFF	(CARD_VCC(0))
109
110extern int cbb_debug;
111extern devclass_t cbb_devclass;
112
113int	cbb_activate_resource(device_t brdev, device_t child,
114	    int type, int rid, struct resource *r);
115struct resource	*cbb_alloc_resource(device_t brdev, device_t child,
116	    int type, int *rid, u_long start, u_long end, u_long count,
117	    u_int flags);
118void	cbb_child_detached(device_t brdev, device_t child);
119int	cbb_child_present(device_t parent, device_t child);
120int	cbb_deactivate_resource(device_t brdev, device_t child,
121	    int type, int rid, struct resource *r);
122int	cbb_detach(device_t brdev);
123void	cbb_disable_func_intr(struct cbb_softc *sc);
124void	cbb_driver_added(device_t brdev, driver_t *driver);
125void	cbb_event_thread(void *arg);
126int	cbb_pcic_set_memory_offset(device_t brdev, device_t child, int rid,
127	    uint32_t cardaddr, uint32_t *deltap);
128int	cbb_pcic_set_res_flags(device_t brdev, device_t child, int type,
129	    int rid, u_long flags);
130int	cbb_power(device_t brdev, int volts);
131int	cbb_power_enable_socket(device_t brdev, device_t child);
132int	cbb_power_disable_socket(device_t brdev, device_t child);
133int	cbb_read_ivar(device_t brdev, device_t child, int which,
134	    uintptr_t *result);
135int	cbb_release_resource(device_t brdev, device_t child,
136	    int type, int rid, struct resource *r);
137int	cbb_resume(device_t self);
138int	cbb_setup_intr(device_t dev, device_t child, struct resource *irq,
139	    int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg,
140	    void **cookiep);
141int	cbb_suspend(device_t self);
142int	cbb_teardown_intr(device_t dev, device_t child, struct resource *irq,
143	    void *cookie);
144int	cbb_write_ivar(device_t brdev, device_t child, int which,
145	    uintptr_t value);
146
147/*
148 */
149static __inline void
150cbb_set(struct cbb_softc *sc, uint32_t reg, uint32_t val)
151{
152	bus_space_write_4(sc->bst, sc->bsh, reg, val);
153}
154
155static __inline uint32_t
156cbb_get(struct cbb_softc *sc, uint32_t reg)
157{
158	return (bus_space_read_4(sc->bst, sc->bsh, reg));
159}
160
161static __inline void
162cbb_setb(struct cbb_softc *sc, uint32_t reg, uint32_t bits)
163{
164	cbb_set(sc, reg, cbb_get(sc, reg) | bits);
165}
166
167static __inline void
168cbb_clrb(struct cbb_softc *sc, uint32_t reg, uint32_t bits)
169{
170	cbb_set(sc, reg, cbb_get(sc, reg) & ~bits);
171}
172