blob: 32896a77391054babaeb60482ad121a4864329af [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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110/* Maximum number of IO windows per socket */
111#define MAX_IO_WIN 2
112
113/* Maximum number of memory windows per socket */
114#define MAX_WIN 4
115
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200116
117/*
118 * Socket operations.
119 */
120struct pcmcia_socket;
121struct pccard_resource_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122struct config_t;
123struct pcmcia_callback;
Dominik Brodowskidc109492005-06-27 16:28:50 -0700124struct user_info_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200126struct pccard_operations {
127 int (*init)(struct pcmcia_socket *s);
128 int (*suspend)(struct pcmcia_socket *s);
129 int (*get_status)(struct pcmcia_socket *s, u_int *value);
130 int (*set_socket)(struct pcmcia_socket *s, socket_state_t *state);
131 int (*set_io_map)(struct pcmcia_socket *s, struct pccard_io_map *io);
132 int (*set_mem_map)(struct pcmcia_socket *s, struct pccard_mem_map *mem);
133};
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135struct pcmcia_socket {
136 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 socket_state_t socket;
138 u_int state;
Dominik Brodowski88b060d2010-01-02 14:14:23 +0100139 u_int suspended_state; /* state before suspend */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 u_short functions;
141 u_short lock_count;
142 pccard_mem_map cis_mem;
143 void __iomem *cis_virt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 struct {
145 u_int AssignedIRQ;
146 u_int Config;
147 } irq;
148 io_window_t io[MAX_IO_WIN];
Dominik Brodowski82f88e32009-11-03 01:16:12 +0100149 pccard_mem_map win[MAX_WIN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 struct list_head cis_cache;
Dominik Brodowski53efec92008-07-28 19:44:05 +0200151 size_t fake_cis_len;
152 u8 *fake_cis;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
154 struct list_head socket_list;
155 struct completion socket_released;
156
Dominik Brodowski9fea84f2009-12-07 22:11:45 +0100157 /* deprecated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 unsigned int sock; /* socket number */
159
160
161 /* socket capabilities */
162 u_int features;
163 u_int irq_mask;
164 u_int map_size;
Olof Johansson906da802008-02-04 22:27:35 -0800165 u_int io_offset;
Russell King - ARM Linux16891642009-03-29 22:43:43 +0100166 u_int pci_irq;
Dominik Brodowski9fea84f2009-12-07 22:11:45 +0100167 struct pci_dev *cb_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200170 /* socket setup is done so resources should be able to be allocated.
171 * Only if set to 1, calls to find_{io,mem}_region are handled, and
172 * insertio events are actually managed by the PCMCIA layer.*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 u8 resource_setup_done:1;
174
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200175 /* It's old if resource setup is done using adjust_resource_info() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 u8 resource_setup_old:1;
Dominik Brodowski3c299762005-06-27 16:28:46 -0700177 u8 resource_setup_new:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Dominik Brodowski3c299762005-06-27 16:28:46 -0700179 u8 reserved:5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181 /* socket operations */
Dominik Brodowski9fea84f2009-12-07 22:11:45 +0100182 struct pccard_operations *ops;
183 struct pccard_resource_ops *resource_ops;
184 void *resource_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 /* Zoom video behaviour is so chip specific its not worth adding
187 this to _ops */
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200188 void (*zoom_video)(struct pcmcia_socket *,
189 int);
Daniel Ritzfa912bc2005-06-23 00:10:12 -0700190
191 /* so is power hook */
192 int (*power_hook)(struct pcmcia_socket *sock, int operation);
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200193
Daniel Ritz8c3520d2005-08-21 22:29:26 -0700194 /* allows tuning the CB bridge before loading driver for the CB card */
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200195#ifdef CONFIG_CARDBUS
Daniel Ritz8c3520d2005-08-21 22:29:26 -0700196 void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);
197#endif
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 /* state thread */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 struct task_struct *thread;
201 struct completion thread_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 unsigned int thread_events;
Dominik Brodowskif971dbd2010-01-17 18:13:31 +0100203 unsigned int sysfs_events;
Dominik Brodowski00ce99f2010-01-16 09:14:11 +0100204
205 /* For the non-trivial interaction between these locks,
206 * see Documentation/pcmcia/locking.txt */
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200207 struct mutex skt_mutex;
Dominik Brodowski6b8e0872010-01-12 21:42:51 +0100208 struct mutex ops_mutex;
Dominik Brodowski00ce99f2010-01-16 09:14:11 +0100209
Dominik Brodowskif971dbd2010-01-17 18:13:31 +0100210 /* protects thread_events and sysfs_events */
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200211 spinlock_t thread_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213 /* pcmcia (16-bit) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 struct pcmcia_callback *callback;
215
Dominik Brodowskidc109492005-06-27 16:28:50 -0700216#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200217 /* The following elements refer to 16-bit PCMCIA devices inserted
218 * into the socket */
219 struct list_head devices_list;
Dominik Brodowskidc109492005-06-27 16:28:50 -0700220
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200221 /* the number of devices, used only internally and subject to
222 * incorrectness and change */
223 u8 device_count;
224
225 /* 16-bit state: */
Dominik Brodowskidc109492005-06-27 16:28:50 -0700226 struct {
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200227 /* PCMCIA card is present in socket */
228 u8 present:1;
229 /* "master" ioctl is used */
230 u8 busy:1;
231 /* pcmcia module is being unloaded */
232 u8 dead:1;
Dominik Brodowskiaa584ca2010-01-24 14:36:59 +0100233 /* the PCMCIA card consists of two pseudo devices */
234 u8 has_pfc:1;
Dominik Brodowskidc109492005-06-27 16:28:50 -0700235
Dominik Brodowskiaa584ca2010-01-24 14:36:59 +0100236 u8 reserved:4;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200237 } pcmcia_state;
238
239
Dominik Brodowskidc109492005-06-27 16:28:50 -0700240#ifdef CONFIG_PCMCIA_IOCTL
241 struct user_info_t *user;
242 wait_queue_head_t queue;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200243#endif /* CONFIG_PCMCIA_IOCTL */
244#endif /* CONFIG_PCMCIA */
Dominik Brodowskidc109492005-06-27 16:28:50 -0700245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 /* socket device */
Greg Kroah-Hartman87373312006-09-12 17:00:10 +0200247 struct device dev;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200248 /* data internal to the socket driver */
249 void *driver_data;
Rafael J. Wysocki9905d1b2009-11-03 10:54:58 +0100250 /* status of the card during resume from a system sleep state */
251 int resume_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252};
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200255/* socket drivers must define the resource operations type they use. There
256 * are three options:
257 * - pccard_static_ops iomem and ioport areas are assigned statically
258 * - pccard_iodyn_ops iomem areas is assigned statically, ioport
259 * areas dynamically
Dominik Brodowski4e8804f2010-01-06 11:19:25 +0100260 * If this option is selected, use
261 * "select PCCARD_IODYN" in Kconfig.
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200262 * - pccard_nonstatic_ops iomem and ioport areas are assigned dynamically.
263 * If this option is selected, use
264 * "select PCCARD_NONSTATIC" in Kconfig.
Dominik Brodowski3a86e182010-01-06 14:33:15 +0100265 *
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200266 */
267extern struct pccard_resource_ops pccard_static_ops;
Dominik Brodowski3a86e182010-01-06 14:33:15 +0100268#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200269extern struct pccard_resource_ops pccard_iodyn_ops;
270extern struct pccard_resource_ops pccard_nonstatic_ops;
Dominik Brodowski3a86e182010-01-06 14:33:15 +0100271#else
272/* If PCMCIA is not used, but only CARDBUS, these functions are not used
273 * at all. Therefore, do not use the large (240K!) rsrc_nonstatic module
274 */
275#define pccard_iodyn_ops pccard_static_ops
276#define pccard_nonstatic_ops pccard_static_ops
277#endif
278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280/* socket drivers are expected to use these callbacks in their .drv struct */
Rafael J. Wysocki827b4642009-09-29 00:10:41 +0200281extern int pcmcia_socket_dev_suspend(struct device *dev);
Rafael J. Wysocki9905d1b2009-11-03 10:54:58 +0100282extern void pcmcia_socket_dev_early_resume(struct device *dev);
283extern void pcmcia_socket_dev_late_resume(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284extern int pcmcia_socket_dev_resume(struct device *dev);
285
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200286/* socket drivers use this callback in their IRQ handler */
287extern void pcmcia_parse_events(struct pcmcia_socket *socket,
288 unsigned int events);
289
290/* to register and unregister a socket */
291extern int pcmcia_register_socket(struct pcmcia_socket *socket);
292extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);
293
294
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295#endif /* _LINUX_SS_H */