xref: /netbsd-src/sys/dev/cardbus/cardslotvar.h (revision 2980e352a13e8f0b545a366830c411e7a542ada8)
1 /*	$NetBSD: cardslotvar.h,v 1.15 2008/07/03 18:57:52 drochner Exp $	*/
2 
3 /*
4  * Copyright (c) 1999
5  *       HAYAKAWA Koichi.  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 the author.
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  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
26  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef _DEV_CARDBUS_CARDSLOTVAR_H_
36 #define _DEV_CARDBUS_CARDSLOTVAR_H_
37 
38 /* require sys/device.h */
39 /* require sys/queue.h */
40 
41 struct cardslot_event;
42 
43 /*
44  * The data structure cardslot_attach_args is the attach argument for
45  * PCMCIA (including CardBus and 16-bit card) slot.
46  */
47 struct cardslot_attach_args {
48 	/* for cardbus... */
49 	struct cbslot_attach_args *caa_cb_attach;
50 
51 	/* for 16-bit pcmcia */
52 	struct pcmciabus_attach_args *caa_16_attach;
53 };
54 
55 
56 /*
57  * The data structure cardslot_attach_args is the attach argument for
58  * PCMCIA (including CardBus and 16-bit card) slot.
59  */
60 struct cardslot_softc {
61 	device_t sc_dev;
62 
63 	int sc_status;		/* the status of slot */
64 
65 	struct cardbus_softc *sc_cb_softc;
66 	device_t sc_16_softc;
67 
68 	struct lwp *sc_event_thread;
69 	int sc_th_enable;	/* true if the thread is enabled */
70 
71 	/* An event queue for the thread which processes slot state events. */
72 
73 	SIMPLEQ_HEAD(, cardslot_event) sc_events;
74 };
75 
76 #define CARDSLOT_STATUS_CARD_MASK     0x07
77 #define CARDSLOT_STATUS_CARD_NONE     0x00  /* NO card inserted */
78 #define CARDSLOT_STATUS_CARD_16	      0x01  /* 16-bit pcmcia card inserted */
79 #define CARDSLOT_STATUS_CARD_CB	      0x02  /* CardBus pcmcia card inserted */
80 #define CARDSLOT_STATUS_UNKNOWN	      0x07  /* Unknown card inserted */
81 
82 #define CARDSLOT_CARDTYPE(x) ((x) & CARDSLOT_STATUS_CARD_MASK)
83 #define CARDSLOT_SET_CARDTYPE(x, type) \
84 	do {(x) &= ~CARDSLOT_STATUS_CARD_MASK;\
85 	    (x) |= (CARDSLOT_STATUS_CARD_MASK & (type));} while(0)
86 
87 #define CARDSLOT_STATUS_WORK_MASK     0x08
88 #define CARDSLOT_STATUS_WORKING	      0x08  /* at least one function works */
89 #define CARDSLOT_STATUS_NOTWORK	      0x00  /* no functions are working */
90 
91 #define CARDSLOT_WORK(x) ((x) & CARDSLOT_STATUS_WORK_MASK)
92 #define CARDSLOT_SET_WORK(x, type) \
93 	do {(x) &= ~CARDSLOT_STATUS_WORK_MASK;\
94 	    (x) |= (CARDSLOT_STATUS_WORK_MASK & (type));} while(0)
95 
96 
97 struct cardslot_event {
98 	SIMPLEQ_ENTRY(cardslot_event) ce_q;
99 
100 	int ce_type;
101 };
102 
103 /* ce_type */
104 #define	CARDSLOT_EVENT_INSERTION_16	0
105 #define	CARDSLOT_EVENT_REMOVAL_16	1
106 
107 #define	CARDSLOT_EVENT_INSERTION_CB	2
108 #define	CARDSLOT_EVENT_REMOVAL_CB	3
109 
110 #define IS_CARDSLOT_INSERT_REMOVE_EV(x) (0 <= (x) && (x) <= 3)
111 
112 void cardslot_event_throw(struct cardslot_softc *, int);
113 
114 #endif /* !_DEV_CARDBUS_CARDSLOTVAR_H_ */
115