[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / pcmcia / ss.h
blobc8592c7e8eaa5bc2bb90411d8f7fa5e8134bb854
1 /*
2 * ss.h
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.
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.
12 * (C) 1999 David A. Hinds
15 #ifndef _LINUX_SS_H
16 #define _LINUX_SS_H
18 #include <linux/config.h>
19 #include <linux/device.h>
21 #include <pcmcia/cs_types.h>
22 #include <pcmcia/cs.h>
23 #include <pcmcia/bulkmem.h>
24 #ifdef CONFIG_CARDBUS
25 #include <linux/pci.h>
26 #endif
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
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
54 /* for GetSocket, SetSocket */
55 typedef struct socket_state_t {
56 u_int flags;
57 u_int csc_mask;
58 u_char Vcc, Vpp;
59 u_char io_irq;
60 } socket_state_t;
62 extern socket_state_t dead_socket;
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
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
82 /* Use this just for bridge windows */
83 #define MAP_IOSPACE 0x20
85 /* power hook operations */
86 #define HOOK_POWER_PRE 0x01
87 #define HOOK_POWER_POST 0x02
90 typedef struct pccard_io_map {
91 u_char map;
92 u_char flags;
93 u_short speed;
94 kio_addr_t start, stop;
95 } pccard_io_map;
97 typedef struct pccard_mem_map {
98 u_char map;
99 u_char flags;
100 u_short speed;
101 u_long static_start;
102 u_int card_start;
103 struct resource *res;
104 } pccard_mem_map;
106 typedef struct cb_bridge_map {
107 u_char map;
108 u_char flags;
109 u_int start, stop;
110 } cb_bridge_map;
113 * Socket operations.
115 struct pcmcia_socket;
117 struct pccard_operations {
118 int (*init)(struct pcmcia_socket *sock);
119 int (*suspend)(struct pcmcia_socket *sock);
120 int (*register_callback)(struct pcmcia_socket *sock, void (*handler)(void *, unsigned int), void * info);
121 int (*get_status)(struct pcmcia_socket *sock, u_int *value);
122 int (*get_socket)(struct pcmcia_socket *sock, socket_state_t *state);
123 int (*set_socket)(struct pcmcia_socket *sock, socket_state_t *state);
124 int (*set_io_map)(struct pcmcia_socket *sock, struct pccard_io_map *io);
125 int (*set_mem_map)(struct pcmcia_socket *sock, struct pccard_mem_map *mem);
128 struct pccard_resource_ops {
129 void (*validate_mem) (struct pcmcia_socket *s);
130 int (*adjust_io_region) (struct resource *res,
131 unsigned long r_start,
132 unsigned long r_end,
133 struct pcmcia_socket *s);
134 struct resource* (*find_io) (unsigned long base, int num,
135 unsigned long align,
136 struct pcmcia_socket *s);
137 struct resource* (*find_mem) (unsigned long base, unsigned long num,
138 unsigned long align, int low,
139 struct pcmcia_socket *s);
140 int (*adjust_resource) (struct pcmcia_socket *s,
141 adjust_t *adj);
142 int (*init) (struct pcmcia_socket *s);
143 void (*exit) (struct pcmcia_socket *s);
145 /* SS_CAP_STATIC_MAP */
146 extern struct pccard_resource_ops pccard_static_ops;
147 /* !SS_CAP_STATIC_MAP */
148 extern struct pccard_resource_ops pccard_nonstatic_ops;
151 * Calls to set up low-level "Socket Services" drivers
153 struct pcmcia_socket;
155 typedef struct io_window_t {
156 u_int Attributes;
157 kio_addr_t BasePort, NumPorts;
158 kio_addr_t InUse, Config;
159 struct resource *res;
160 } io_window_t;
162 #define WINDOW_MAGIC 0xB35C
163 typedef struct window_t {
164 u_short magic;
165 u_short index;
166 client_handle_t handle;
167 struct pcmcia_socket *sock;
168 pccard_mem_map ctl;
169 } window_t;
171 /* Maximum number of IO windows per socket */
172 #define MAX_IO_WIN 2
174 /* Maximum number of memory windows per socket */
175 #define MAX_WIN 4
177 struct config_t;
178 struct pcmcia_callback;
179 struct user_info_t;
181 struct pcmcia_socket {
182 struct module *owner;
183 spinlock_t lock;
184 socket_state_t socket;
185 u_int state;
186 u_short functions;
187 u_short lock_count;
188 pccard_mem_map cis_mem;
189 void __iomem *cis_virt;
190 struct config_t *config;
191 struct {
192 u_int AssignedIRQ;
193 u_int Config;
194 } irq;
195 io_window_t io[MAX_IO_WIN];
196 window_t win[MAX_WIN];
197 struct list_head cis_cache;
198 u_int fake_cis_len;
199 char *fake_cis;
201 struct list_head socket_list;
202 struct completion socket_released;
204 /* deprecated */
205 unsigned int sock; /* socket number */
208 /* socket capabilities */
209 u_int features;
210 u_int irq_mask;
211 u_int map_size;
212 kio_addr_t io_offset;
213 u_char pci_irq;
214 struct pci_dev * cb_dev;
217 /* socket setup is done so resources should be able to be allocated. Only
218 * if set to 1, calls to find_{io,mem}_region are handled, and insertion
219 * events are actually managed by the PCMCIA layer.*/
220 u8 resource_setup_done:1;
222 /* is set to one if resource setup is done using adjust_resource_info() */
223 u8 resource_setup_old:1;
224 u8 resource_setup_new:1;
226 u8 reserved:5;
228 /* socket operations */
229 struct pccard_operations * ops;
230 struct pccard_resource_ops * resource_ops;
231 void * resource_data;
233 /* Zoom video behaviour is so chip specific its not worth adding
234 this to _ops */
235 void (*zoom_video)(struct pcmcia_socket *, int);
237 /* so is power hook */
238 int (*power_hook)(struct pcmcia_socket *sock, int operation);
239 #ifdef CONFIG_CARDBUS
240 /* allows tuning the CB bridge before loading driver for the CB card */
241 void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);
242 #endif
244 /* state thread */
245 struct semaphore skt_sem; /* protects socket h/w state */
247 struct task_struct *thread;
248 struct completion thread_done;
249 wait_queue_head_t thread_wait;
250 spinlock_t thread_lock; /* protects thread_events */
251 unsigned int thread_events;
253 /* pcmcia (16-bit) */
254 struct pcmcia_callback *callback;
256 #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
257 struct list_head devices_list; /* PCMCIA devices */
258 u8 device_count; /* the number of devices, used
259 * only internally and subject
260 * to incorrectness and change */
262 struct {
263 u8 present:1, /* PCMCIA card is present in socket */
264 busy:1, /* "master" ioctl is used */
265 dead:1, /* pcmcia module is being unloaded */
266 device_add_pending:1, /* a pseudo-multifunction-device
267 * add event is pending */
268 reserved:4;
269 } pcmcia_state;
271 struct work_struct device_add; /* for adding further pseudo-multifunction
272 * devices */
274 #ifdef CONFIG_PCMCIA_IOCTL
275 struct user_info_t *user;
276 wait_queue_head_t queue;
277 #endif
278 #endif
280 /* cardbus (32-bit) */
281 #ifdef CONFIG_CARDBUS
282 struct resource * cb_cis_res;
283 void __iomem *cb_cis_virt;
284 #endif
286 /* socket device */
287 struct class_device dev;
288 void *driver_data; /* data internal to the socket driver */
292 struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr);
296 extern void pcmcia_parse_events(struct pcmcia_socket *socket, unsigned int events);
297 extern int pcmcia_register_socket(struct pcmcia_socket *socket);
298 extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);
300 extern struct class pcmcia_socket_class;
302 /* socket drivers are expected to use these callbacks in their .drv struct */
303 extern int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state);
304 extern int pcmcia_socket_dev_resume(struct device *dev);
306 #endif /* _LINUX_SS_H */