[PATCH] pcmcia: make config_t independent, add reference counting
[linux-2.6.git] / include / pcmcia / ss.h
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
18 #include <linux/config.h>
19 #include <linux/device.h>
20 #include <linux/sched.h>        /* task_struct, completion */
21
22 #include <pcmcia/cs_types.h>
23 #include <pcmcia/cs.h>
24 #include <pcmcia/bulkmem.h>
25 #ifdef CONFIG_CARDBUS
26 #include <linux/pci.h>
27 #endif
28
29 /* Definitions for card status flags for GetStatus */
30 #define SS_WRPROT       0x0001
31 #define SS_CARDLOCK     0x0002
32 #define SS_EJECTION     0x0004
33 #define SS_INSERTION    0x0008
34 #define SS_BATDEAD      0x0010
35 #define SS_BATWARN      0x0020
36 #define SS_READY        0x0040
37 #define SS_DETECT       0x0080
38 #define SS_POWERON      0x0100
39 #define SS_GPI          0x0200
40 #define SS_STSCHG       0x0400
41 #define SS_CARDBUS      0x0800
42 #define SS_3VCARD       0x1000
43 #define SS_XVCARD       0x2000
44 #define SS_PENDING      0x4000
45 #define SS_ZVCARD       0x8000
46
47 /* InquireSocket capabilities */
48 #define SS_CAP_PAGE_REGS        0x0001
49 #define SS_CAP_VIRTUAL_BUS      0x0002
50 #define SS_CAP_MEM_ALIGN        0x0004
51 #define SS_CAP_STATIC_MAP       0x0008
52 #define SS_CAP_PCCARD           0x4000
53 #define SS_CAP_CARDBUS          0x8000
54
55 /* for GetSocket, SetSocket */
56 typedef struct socket_state_t {
57     u_int       flags;
58     u_int       csc_mask;
59     u_char      Vcc, Vpp;
60     u_char      io_irq;
61 } socket_state_t;
62
63 extern socket_state_t dead_socket;
64
65 /* Socket configuration flags */
66 #define SS_PWR_AUTO     0x0010
67 #define SS_IOCARD       0x0020
68 #define SS_RESET        0x0040
69 #define SS_DMA_MODE     0x0080
70 #define SS_SPKR_ENA     0x0100
71 #define SS_OUTPUT_ENA   0x0200
72
73 /* Flags for I/O port and memory windows */
74 #define MAP_ACTIVE      0x01
75 #define MAP_16BIT       0x02
76 #define MAP_AUTOSZ      0x04
77 #define MAP_0WS         0x08
78 #define MAP_WRPROT      0x10
79 #define MAP_ATTRIB      0x20
80 #define MAP_USE_WAIT    0x40
81 #define MAP_PREFETCH    0x80
82
83 /* Use this just for bridge windows */
84 #define MAP_IOSPACE     0x20
85
86 /* power hook operations */
87 #define HOOK_POWER_PRE  0x01
88 #define HOOK_POWER_POST 0x02
89
90
91 typedef struct pccard_io_map {
92     u_char      map;
93     u_char      flags;
94     u_short     speed;
95     kio_addr_t  start, stop;
96 } pccard_io_map;
97
98 typedef struct pccard_mem_map {
99     u_char      map;
100     u_char      flags;
101     u_short     speed;
102     u_long      static_start;
103     u_int       card_start;
104     struct resource *res;
105 } pccard_mem_map;
106
107 typedef struct cb_bridge_map {
108     u_char      map;
109     u_char      flags;
110     u_int       start, stop;
111 } cb_bridge_map;
112
113 /*
114  * Socket operations.
115  */
116 struct pcmcia_socket;
117
118 struct pccard_operations {
119         int (*init)(struct pcmcia_socket *sock);
120         int (*suspend)(struct pcmcia_socket *sock);
121         int (*get_status)(struct pcmcia_socket *sock, u_int *value);
122         int (*set_socket)(struct pcmcia_socket *sock, socket_state_t *state);
123         int (*set_io_map)(struct pcmcia_socket *sock, struct pccard_io_map *io);
124         int (*set_mem_map)(struct pcmcia_socket *sock, struct pccard_mem_map *mem);
125 };
126
127 struct pccard_resource_ops {
128         int     (*validate_mem)         (struct pcmcia_socket *s);
129         int     (*adjust_io_region)     (struct resource *res,
130                                          unsigned long r_start,
131                                          unsigned long r_end,
132                                          struct pcmcia_socket *s);
133         struct resource* (*find_io)     (unsigned long base, int num,
134                                          unsigned long align,
135                                          struct pcmcia_socket *s);
136         struct resource* (*find_mem)    (unsigned long base, unsigned long num,
137                                          unsigned long align, int low,
138                                          struct pcmcia_socket *s);
139         int     (*adjust_resource)      (struct pcmcia_socket *s,
140                                          adjust_t *adj);
141         int     (*init)                 (struct pcmcia_socket *s);
142         void    (*exit)                 (struct pcmcia_socket *s);
143 };
144 /* SS_CAP_STATIC_MAP */
145 extern struct pccard_resource_ops pccard_static_ops;
146 /* !SS_CAP_STATIC_MAP */
147 extern struct pccard_resource_ops pccard_nonstatic_ops;
148
149 /*
150  *  Calls to set up low-level "Socket Services" drivers
151  */
152 struct pcmcia_socket;
153
154 typedef struct io_window_t {
155         u_int                   Attributes;
156         kio_addr_t              BasePort, NumPorts;
157         kio_addr_t              InUse, Config;
158         struct resource         *res;
159 } io_window_t;
160
161 #define WINDOW_MAGIC    0xB35C
162 typedef struct window_t {
163         u_short                 magic;
164         u_short                 index;
165         client_handle_t         handle;
166         struct pcmcia_socket    *sock;
167         pccard_mem_map          ctl;
168 } window_t;
169
170 /* Maximum number of IO windows per socket */
171 #define MAX_IO_WIN 2
172
173 /* Maximum number of memory windows per socket */
174 #define MAX_WIN 4
175
176 struct config_t;
177 struct pcmcia_callback;
178 struct user_info_t;
179
180 struct pcmcia_socket {
181         struct module                   *owner;
182         spinlock_t                      lock;
183         socket_state_t                  socket;
184         u_int                           state;
185         u_short                         functions;
186         u_short                         lock_count;
187         pccard_mem_map                  cis_mem;
188         void __iomem                    *cis_virt;
189         struct {
190                 u_int                   AssignedIRQ;
191                 u_int                   Config;
192         } irq;
193         io_window_t                     io[MAX_IO_WIN];
194         window_t                        win[MAX_WIN];
195         struct list_head                cis_cache;
196         u_int                           fake_cis_len;
197         char                            *fake_cis;
198
199         struct list_head                socket_list;
200         struct completion               socket_released;
201
202         /* deprecated */
203         unsigned int                    sock;           /* socket number */
204
205
206         /* socket capabilities */
207         u_int                           features;
208         u_int                           irq_mask;
209         u_int                           map_size;
210         kio_addr_t                      io_offset;
211         u_char                          pci_irq;
212         struct pci_dev *                cb_dev;
213
214
215         /* socket setup is done so resources should be able to be allocated. Only
216          * if set to 1, calls to find_{io,mem}_region are handled, and insertion
217          * events are actually managed by the PCMCIA layer.*/
218         u8                              resource_setup_done:1;
219
220         /* is set to one if resource setup is done using adjust_resource_info() */
221         u8                              resource_setup_old:1;
222         u8                              resource_setup_new:1;
223
224         u8                              reserved:5;
225
226         /* socket operations */
227         struct pccard_operations *      ops;
228         struct pccard_resource_ops *    resource_ops;
229         void *                          resource_data;
230
231         /* Zoom video behaviour is so chip specific its not worth adding
232            this to _ops */
233         void                            (*zoom_video)(struct pcmcia_socket *, int);
234
235         /* so is power hook */
236         int (*power_hook)(struct pcmcia_socket *sock, int operation);
237 #ifdef CONFIG_CARDBUS
238         /* allows tuning the CB bridge before loading driver for the CB card */
239         void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);
240 #endif
241
242         /* state thread */
243         struct semaphore                skt_sem;        /* protects socket h/w state */
244
245         struct task_struct              *thread;
246         struct completion               thread_done;
247         wait_queue_head_t               thread_wait;
248         spinlock_t                      thread_lock;    /* protects thread_events */
249         unsigned int                    thread_events;
250
251         /* pcmcia (16-bit) */
252         struct pcmcia_callback          *callback;
253
254 #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
255         struct list_head                devices_list;   /*  PCMCIA devices */
256         u8                              device_count;   /* the number of devices, used
257                                                          * only internally and subject
258                                                          * to incorrectness and change */
259
260         struct {
261                 u8                      present:1,      /* PCMCIA card is present in socket */
262                                         busy:1,         /* "master" ioctl is used */
263                                         dead:1,         /* pcmcia module is being unloaded */
264                                         device_add_pending:1, /* a pseudo-multifunction-device
265                                                                * add event is pending */
266                                         reserved:4;
267         }                               pcmcia_state;
268
269         struct work_struct              device_add;     /* for adding further pseudo-multifunction
270                                                          * devices */
271
272 #ifdef CONFIG_PCMCIA_IOCTL
273         struct user_info_t              *user;
274         wait_queue_head_t               queue;
275 #endif
276 #endif
277
278         /* cardbus (32-bit) */
279 #ifdef CONFIG_CARDBUS
280         struct resource *               cb_cis_res;
281         void __iomem                    *cb_cis_virt;
282 #endif
283
284         /* socket device */
285         struct class_device             dev;
286         void                            *driver_data;   /* data internal to the socket driver */
287
288 };
289
290 struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr);
291
292
293
294 extern void pcmcia_parse_events(struct pcmcia_socket *socket, unsigned int events);
295 extern int pcmcia_register_socket(struct pcmcia_socket *socket);
296 extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);
297
298 extern struct class pcmcia_socket_class;
299
300 /* socket drivers are expected to use these callbacks in their .drv struct */
301 extern int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state);
302 extern int pcmcia_socket_dev_resume(struct device *dev);
303
304 #endif /* _LINUX_SS_H */