blob: e0f6feb8588c0e062161431b31681542bb58450b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Dominik Brodowskidc109492005-06-27 16:28:50 -070018#include <linux/device.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080019#include <linux/sched.h> /* task_struct, completion */
Dominik Brodowski7fe908d2006-01-10 21:20:36 +010020#include <linux/mutex.h>
Dominik Brodowskidc109492005-06-27 16:28:50 -070021
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <pcmcia/cs_types.h>
23#include <pcmcia/cs.h>
Daniel Ritz8c3520d2005-08-21 22:29:26 -070024#ifdef CONFIG_CARDBUS
25#include <linux/pci.h>
26#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
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 */
55typedef struct socket_state_t {
Dominik Brodowskic23889c2008-08-26 00:09:56 +020056 u_int flags;
57 u_int csc_mask;
58 u_char Vcc, Vpp;
59 u_char io_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060} socket_state_t;
61
62extern 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
Daniel Ritzfa912bc2005-06-23 00:10:12 -070085/* power hook operations */
86#define HOOK_POWER_PRE 0x01
87#define HOOK_POWER_POST 0x02
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089typedef struct pccard_io_map {
Dominik Brodowskic23889c2008-08-26 00:09:56 +020090 u_char map;
91 u_char flags;
92 u_short speed;
Steven A. Falco1d807662009-06-16 12:35:00 -040093 phys_addr_t start, stop;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094} pccard_io_map;
95
96typedef struct pccard_mem_map {
Dominik Brodowskic23889c2008-08-26 00:09:56 +020097 u_char map;
98 u_char flags;
99 u_short speed;
Steven A. Falco1d807662009-06-16 12:35:00 -0400100 phys_addr_t static_start;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200101 u_int card_start;
102 struct resource *res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103} pccard_mem_map;
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105typedef struct io_window_t {
Olof Johansson906da802008-02-04 22:27:35 -0800106 u_int InUse, Config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 struct resource *res;
108} io_window_t;
109
110#define WINDOW_MAGIC 0xB35C
111typedef struct window_t {
112 u_short magic;
113 u_short index;
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200114 struct pcmcia_device *handle;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 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
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200125
126/*
127 * Socket operations.
128 */
129struct pcmcia_socket;
130struct pccard_resource_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131struct config_t;
132struct pcmcia_callback;
Dominik Brodowskidc109492005-06-27 16:28:50 -0700133struct user_info_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200135struct 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144struct 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 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;
Dominik Brodowski53efec92008-07-28 19:44:05 +0200160 size_t fake_cis_len;
161 u8 *fake_cis;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
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;
Olof Johansson906da802008-02-04 22:27:35 -0800174 u_int io_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 u_char pci_irq;
176 struct pci_dev * cb_dev;
177
178
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200179 /* 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.*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 u8 resource_setup_done:1;
183
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200184 /* It's old if resource setup is done using adjust_resource_info() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 u8 resource_setup_old:1;
Dominik Brodowski3c299762005-06-27 16:28:46 -0700186 u8 resource_setup_new:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Dominik Brodowski3c299762005-06-27 16:28:46 -0700188 u8 reserved:5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
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 */
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200197 void (*zoom_video)(struct pcmcia_socket *,
198 int);
Daniel Ritzfa912bc2005-06-23 00:10:12 -0700199
200 /* so is power hook */
201 int (*power_hook)(struct pcmcia_socket *sock, int operation);
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200202
Daniel Ritz8c3520d2005-08-21 22:29:26 -0700203 /* allows tuning the CB bridge before loading driver for the CB card */
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200204#ifdef CONFIG_CARDBUS
Daniel Ritz8c3520d2005-08-21 22:29:26 -0700205 void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);
206#endif
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 /* state thread */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 struct task_struct *thread;
210 struct completion thread_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 unsigned int thread_events;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200212 /* protects socket h/w state */
213 struct mutex skt_mutex;
214 /* protects thread_events */
215 spinlock_t thread_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217 /* pcmcia (16-bit) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 struct pcmcia_callback *callback;
219
Dominik Brodowskidc109492005-06-27 16:28:50 -0700220#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200221 /* The following elements refer to 16-bit PCMCIA devices inserted
222 * into the socket */
223 struct list_head devices_list;
Dominik Brodowskidc109492005-06-27 16:28:50 -0700224
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200225 /* the number of devices, used only internally and subject to
226 * incorrectness and change */
227 u8 device_count;
228
229 /* 16-bit state: */
Dominik Brodowskidc109492005-06-27 16:28:50 -0700230 struct {
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200231 /* 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;
Dominik Brodowskidc109492005-06-27 16:28:50 -0700241
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200242 u8 reserved:3;
243 } pcmcia_state;
244
245
246 /* for adding further pseudo-multifunction devices */
247 struct work_struct device_add;
Dominik Brodowskidc109492005-06-27 16:28:50 -0700248
249#ifdef CONFIG_PCMCIA_IOCTL
250 struct user_info_t *user;
251 wait_queue_head_t queue;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200252#endif /* CONFIG_PCMCIA_IOCTL */
253#endif /* CONFIG_PCMCIA */
Dominik Brodowskidc109492005-06-27 16:28:50 -0700254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 /* cardbus (32-bit) */
256#ifdef CONFIG_CARDBUS
257 struct resource * cb_cis_res;
258 void __iomem *cb_cis_virt;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200259#endif /* CONFIG_CARDBUS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261 /* socket device */
Greg Kroah-Hartman87373312006-09-12 17:00:10 +0200262 struct device dev;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200263 /* data internal to the socket driver */
264 void *driver_data;
Rafael J. Wysocki9905d1b2009-11-03 10:54:58 +0100265 /* status of the card during resume from a system sleep state */
266 int resume_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267};
268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200270/* socket drivers must define the resource operations type they use. There
271 * are three options:
272 * - pccard_static_ops iomem and ioport areas are assigned statically
273 * - pccard_iodyn_ops iomem areas is assigned statically, ioport
274 * areas dynamically
275 * - pccard_nonstatic_ops iomem and ioport areas are assigned dynamically.
276 * If this option is selected, use
277 * "select PCCARD_NONSTATIC" in Kconfig.
278 */
279extern struct pccard_resource_ops pccard_static_ops;
280extern struct pccard_resource_ops pccard_iodyn_ops;
281extern struct pccard_resource_ops pccard_nonstatic_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283/* socket drivers are expected to use these callbacks in their .drv struct */
Rafael J. Wysocki827b4642009-09-29 00:10:41 +0200284extern int pcmcia_socket_dev_suspend(struct device *dev);
Rafael J. Wysocki9905d1b2009-11-03 10:54:58 +0100285extern void pcmcia_socket_dev_early_resume(struct device *dev);
286extern void pcmcia_socket_dev_late_resume(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287extern int pcmcia_socket_dev_resume(struct device *dev);
288
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200289/* socket drivers use this callback in their IRQ handler */
290extern void pcmcia_parse_events(struct pcmcia_socket *socket,
291 unsigned int events);
292
293/* to register and unregister a socket */
294extern int pcmcia_register_socket(struct pcmcia_socket *socket);
295extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);
296
297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298#endif /* _LINUX_SS_H */