Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * ss.h | |
3 | * | |
4 | * This program is free software; you can redistribute it and/or modify | |
5 | * it under the terms of the GNU General Public License version 2 as | |
6 | * published by the Free Software Foundation. | |
7 | * | |
8 | * The initial developer of the original code is David A. Hinds | |
9 | * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds | |
10 | * are Copyright (C) 1999 David A. Hinds. All Rights Reserved. | |
11 | * | |
12 | * (C) 1999 David A. Hinds | |
13 | */ | |
14 | ||
15 | #ifndef _LINUX_SS_H | |
16 | #define _LINUX_SS_H | |
17 | ||
dc109497 | 18 | #include <linux/device.h> |
4e57b681 | 19 | #include <linux/sched.h> /* task_struct, completion */ |
7fe908dd | 20 | #include <linux/mutex.h> |
dc109497 | 21 | |
1da177e4 LT |
22 | #include <pcmcia/cs_types.h> |
23 | #include <pcmcia/cs.h> | |
8c3520d4 DR |
24 | #ifdef CONFIG_CARDBUS |
25 | #include <linux/pci.h> | |
26 | #endif | |
1da177e4 LT |
27 | |
28 | /* Definitions for card status flags for GetStatus */ | |
29 | #define SS_WRPROT 0x0001 | |
30 | #define SS_CARDLOCK 0x0002 | |
31 | #define SS_EJECTION 0x0004 | |
32 | #define SS_INSERTION 0x0008 | |
33 | #define SS_BATDEAD 0x0010 | |
34 | #define SS_BATWARN 0x0020 | |
35 | #define SS_READY 0x0040 | |
36 | #define SS_DETECT 0x0080 | |
37 | #define SS_POWERON 0x0100 | |
38 | #define SS_GPI 0x0200 | |
39 | #define SS_STSCHG 0x0400 | |
40 | #define SS_CARDBUS 0x0800 | |
41 | #define SS_3VCARD 0x1000 | |
42 | #define SS_XVCARD 0x2000 | |
43 | #define SS_PENDING 0x4000 | |
44 | #define SS_ZVCARD 0x8000 | |
45 | ||
46 | /* InquireSocket capabilities */ | |
47 | #define SS_CAP_PAGE_REGS 0x0001 | |
48 | #define SS_CAP_VIRTUAL_BUS 0x0002 | |
49 | #define SS_CAP_MEM_ALIGN 0x0004 | |
50 | #define SS_CAP_STATIC_MAP 0x0008 | |
51 | #define SS_CAP_PCCARD 0x4000 | |
52 | #define SS_CAP_CARDBUS 0x8000 | |
53 | ||
54 | /* for GetSocket, SetSocket */ | |
55 | typedef struct socket_state_t { | |
c23889ca DB |
56 | u_int flags; |
57 | u_int csc_mask; | |
58 | u_char Vcc, Vpp; | |
59 | u_char io_irq; | |
1da177e4 LT |
60 | } socket_state_t; |
61 | ||
62 | extern socket_state_t dead_socket; | |
63 | ||
64 | /* Socket configuration flags */ | |
65 | #define SS_PWR_AUTO 0x0010 | |
66 | #define SS_IOCARD 0x0020 | |
67 | #define SS_RESET 0x0040 | |
68 | #define SS_DMA_MODE 0x0080 | |
69 | #define SS_SPKR_ENA 0x0100 | |
70 | #define SS_OUTPUT_ENA 0x0200 | |
71 | ||
72 | /* Flags for I/O port and memory windows */ | |
73 | #define MAP_ACTIVE 0x01 | |
74 | #define MAP_16BIT 0x02 | |
75 | #define MAP_AUTOSZ 0x04 | |
76 | #define MAP_0WS 0x08 | |
77 | #define MAP_WRPROT 0x10 | |
78 | #define MAP_ATTRIB 0x20 | |
79 | #define MAP_USE_WAIT 0x40 | |
80 | #define MAP_PREFETCH 0x80 | |
81 | ||
82 | /* Use this just for bridge windows */ | |
83 | #define MAP_IOSPACE 0x20 | |
84 | ||
fa912bcb DR |
85 | /* power hook operations */ |
86 | #define HOOK_POWER_PRE 0x01 | |
87 | #define HOOK_POWER_POST 0x02 | |
88 | ||
1da177e4 | 89 | typedef struct pccard_io_map { |
c23889ca DB |
90 | u_char map; |
91 | u_char flags; | |
92 | u_short speed; | |
93 | u_int start, stop; | |
1da177e4 LT |
94 | } pccard_io_map; |
95 | ||
96 | typedef struct pccard_mem_map { | |
c23889ca DB |
97 | u_char map; |
98 | u_char flags; | |
99 | u_short speed; | |
100 | u_long static_start; | |
101 | u_int card_start; | |
102 | struct resource *res; | |
1da177e4 LT |
103 | } pccard_mem_map; |
104 | ||
1da177e4 | 105 | typedef struct io_window_t { |
906da809 | 106 | u_int InUse, Config; |
1da177e4 LT |
107 | struct resource *res; |
108 | } io_window_t; | |
109 | ||
110 | #define WINDOW_MAGIC 0xB35C | |
111 | typedef struct window_t { | |
112 | u_short magic; | |
113 | u_short index; | |
fba395ee | 114 | struct pcmcia_device *handle; |
1da177e4 LT |
115 | struct pcmcia_socket *sock; |
116 | pccard_mem_map ctl; | |
117 | } window_t; | |
118 | ||
119 | /* Maximum number of IO windows per socket */ | |
120 | #define MAX_IO_WIN 2 | |
121 | ||
122 | /* Maximum number of memory windows per socket */ | |
123 | #define MAX_WIN 4 | |
124 | ||
c23889ca DB |
125 | |
126 | /* | |
127 | * Socket operations. | |
128 | */ | |
129 | struct pcmcia_socket; | |
130 | struct pccard_resource_ops; | |
1da177e4 LT |
131 | struct config_t; |
132 | struct pcmcia_callback; | |
dc109497 | 133 | struct user_info_t; |
1da177e4 | 134 | |
c23889ca DB |
135 | struct pccard_operations { |
136 | int (*init)(struct pcmcia_socket *s); | |
137 | int (*suspend)(struct pcmcia_socket *s); | |
138 | int (*get_status)(struct pcmcia_socket *s, u_int *value); | |
139 | int (*set_socket)(struct pcmcia_socket *s, socket_state_t *state); | |
140 | int (*set_io_map)(struct pcmcia_socket *s, struct pccard_io_map *io); | |
141 | int (*set_mem_map)(struct pcmcia_socket *s, struct pccard_mem_map *mem); | |
142 | }; | |
143 | ||
1da177e4 LT |
144 | struct pcmcia_socket { |
145 | struct module *owner; | |
146 | spinlock_t lock; | |
147 | socket_state_t socket; | |
148 | u_int state; | |
149 | u_short functions; | |
150 | u_short lock_count; | |
151 | pccard_mem_map cis_mem; | |
152 | void __iomem *cis_virt; | |
1da177e4 LT |
153 | struct { |
154 | u_int AssignedIRQ; | |
155 | u_int Config; | |
156 | } irq; | |
157 | io_window_t io[MAX_IO_WIN]; | |
158 | window_t win[MAX_WIN]; | |
159 | struct list_head cis_cache; | |
53efec95 DB |
160 | size_t fake_cis_len; |
161 | u8 *fake_cis; | |
1da177e4 LT |
162 | |
163 | struct list_head socket_list; | |
164 | struct completion socket_released; | |
165 | ||
166 | /* deprecated */ | |
167 | unsigned int sock; /* socket number */ | |
168 | ||
169 | ||
170 | /* socket capabilities */ | |
171 | u_int features; | |
172 | u_int irq_mask; | |
173 | u_int map_size; | |
906da809 | 174 | u_int io_offset; |
1da177e4 LT |
175 | u_char pci_irq; |
176 | struct pci_dev * cb_dev; | |
177 | ||
178 | ||
c23889ca DB |
179 | /* socket setup is done so resources should be able to be allocated. |
180 | * Only if set to 1, calls to find_{io,mem}_region are handled, and | |
181 | * insertio events are actually managed by the PCMCIA layer.*/ | |
1da177e4 LT |
182 | u8 resource_setup_done:1; |
183 | ||
c23889ca | 184 | /* It's old if resource setup is done using adjust_resource_info() */ |
1da177e4 | 185 | u8 resource_setup_old:1; |
3c29976a | 186 | u8 resource_setup_new:1; |
1da177e4 | 187 | |
3c29976a | 188 | u8 reserved:5; |
1da177e4 LT |
189 | |
190 | /* socket operations */ | |
191 | struct pccard_operations * ops; | |
192 | struct pccard_resource_ops * resource_ops; | |
193 | void * resource_data; | |
194 | ||
195 | /* Zoom video behaviour is so chip specific its not worth adding | |
196 | this to _ops */ | |
c23889ca DB |
197 | void (*zoom_video)(struct pcmcia_socket *, |
198 | int); | |
fa912bcb DR |
199 | |
200 | /* so is power hook */ | |
201 | int (*power_hook)(struct pcmcia_socket *sock, int operation); | |
c23889ca | 202 | |
8c3520d4 | 203 | /* allows tuning the CB bridge before loading driver for the CB card */ |
c23889ca | 204 | #ifdef CONFIG_CARDBUS |
8c3520d4 DR |
205 | void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus); |
206 | #endif | |
207 | ||
1da177e4 | 208 | /* state thread */ |
1da177e4 LT |
209 | struct task_struct *thread; |
210 | struct completion thread_done; | |
1da177e4 | 211 | unsigned int thread_events; |
c23889ca DB |
212 | /* protects socket h/w state */ |
213 | struct mutex skt_mutex; | |
214 | /* protects thread_events */ | |
215 | spinlock_t thread_lock; | |
1da177e4 LT |
216 | |
217 | /* pcmcia (16-bit) */ | |
1da177e4 LT |
218 | struct pcmcia_callback *callback; |
219 | ||
dc109497 | 220 | #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE) |
c23889ca DB |
221 | /* The following elements refer to 16-bit PCMCIA devices inserted |
222 | * into the socket */ | |
223 | struct list_head devices_list; | |
224 | ||
225 | /* the number of devices, used only internally and subject to | |
226 | * incorrectness and change */ | |
227 | u8 device_count; | |
dc109497 | 228 | |
c23889ca | 229 | /* 16-bit state: */ |
dc109497 | 230 | struct { |
c23889ca DB |
231 | /* PCMCIA card is present in socket */ |
232 | u8 present:1; | |
233 | /* "master" ioctl is used */ | |
234 | u8 busy:1; | |
235 | /* pcmcia module is being unloaded */ | |
236 | u8 dead:1; | |
237 | /* a multifunction-device add event is pending */ | |
238 | u8 device_add_pending:1; | |
239 | /* the pending event adds a mfc (1) or pfc (0) */ | |
240 | u8 mfc_pfc:1; | |
241 | ||
242 | u8 reserved:3; | |
243 | } pcmcia_state; | |
244 | ||
245 | ||
246 | /* for adding further pseudo-multifunction devices */ | |
247 | struct work_struct device_add; | |
dc109497 DB |
248 | |
249 | #ifdef CONFIG_PCMCIA_IOCTL | |
250 | struct user_info_t *user; | |
251 | wait_queue_head_t queue; | |
c23889ca DB |
252 | #endif /* CONFIG_PCMCIA_IOCTL */ |
253 | #endif /* CONFIG_PCMCIA */ | |
dc109497 | 254 | |
1da177e4 LT |
255 | /* cardbus (32-bit) */ |
256 | #ifdef CONFIG_CARDBUS | |
257 | struct resource * cb_cis_res; | |
258 | void __iomem *cb_cis_virt; | |
c23889ca | 259 | #endif /* CONFIG_CARDBUS */ |
1da177e4 LT |
260 | |
261 | /* socket device */ | |
87373318 | 262 | struct device dev; |
c23889ca DB |
263 | /* data internal to the socket driver */ |
264 | void *driver_data; | |
1da177e4 LT |
265 | }; |
266 | ||
1da177e4 | 267 | |
c23889ca DB |
268 | /* socket drivers must define the resource operations type they use. There |
269 | * are three options: | |
270 | * - pccard_static_ops iomem and ioport areas are assigned statically | |
271 | * - pccard_iodyn_ops iomem areas is assigned statically, ioport | |
272 | * areas dynamically | |
273 | * - pccard_nonstatic_ops iomem and ioport areas are assigned dynamically. | |
274 | * If this option is selected, use | |
275 | * "select PCCARD_NONSTATIC" in Kconfig. | |
276 | */ | |
277 | extern struct pccard_resource_ops pccard_static_ops; | |
278 | extern struct pccard_resource_ops pccard_iodyn_ops; | |
279 | extern struct pccard_resource_ops pccard_nonstatic_ops; | |
1da177e4 | 280 | |
c23889ca DB |
281 | /* socket drivers are expected to use these callbacks in their .drv struct */ |
282 | extern int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state); | |
283 | extern int pcmcia_socket_dev_resume(struct device *dev); | |
284 | ||
285 | /* socket drivers use this callback in their IRQ handler */ | |
286 | extern void pcmcia_parse_events(struct pcmcia_socket *socket, | |
287 | unsigned int events); | |
1da177e4 | 288 | |
c23889ca | 289 | /* to register and unregister a socket */ |
1da177e4 LT |
290 | extern int pcmcia_register_socket(struct pcmcia_socket *socket); |
291 | extern void pcmcia_unregister_socket(struct pcmcia_socket *socket); | |
292 | ||
1da177e4 LT |
293 | |
294 | #endif /* _LINUX_SS_H */ |