Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 18 | #include <linux/device.h> |
Tim Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 19 | #include <linux/sched.h> /* task_struct, completion */ |
Dominik Brodowski | 7fe908d | 2006-01-10 21:20:36 +0100 | [diff] [blame] | 20 | #include <linux/mutex.h> |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 21 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 22 | #include <pcmcia/cs_types.h> |
| 23 | #include <pcmcia/cs.h> |
Daniel Ritz | 8c3520d | 2005-08-21 22:29:26 -0700 | [diff] [blame] | 24 | #ifdef CONFIG_CARDBUS |
| 25 | #include <linux/pci.h> |
| 26 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 { |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 56 | u_int flags; |
| 57 | u_int csc_mask; |
| 58 | u_char Vcc, Vpp; |
| 59 | u_char io_irq; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Daniel Ritz | fa912bc | 2005-06-23 00:10:12 -0700 | [diff] [blame] | 85 | /* power hook operations */ |
| 86 | #define HOOK_POWER_PRE 0x01 |
| 87 | #define HOOK_POWER_POST 0x02 |
| 88 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | typedef struct pccard_io_map { |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 90 | u_char map; |
| 91 | u_char flags; |
| 92 | u_short speed; |
Steven A. Falco | 1d80766 | 2009-06-16 12:35:00 -0400 | [diff] [blame] | 93 | phys_addr_t start, stop; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | } pccard_io_map; |
| 95 | |
| 96 | typedef struct pccard_mem_map { |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 97 | u_char map; |
| 98 | u_char flags; |
| 99 | u_short speed; |
Steven A. Falco | 1d80766 | 2009-06-16 12:35:00 -0400 | [diff] [blame] | 100 | phys_addr_t static_start; |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 101 | u_int card_start; |
| 102 | struct resource *res; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | } pccard_mem_map; |
| 104 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | typedef struct io_window_t { |
Olof Johansson | 906da80 | 2008-02-04 22:27:35 -0800 | [diff] [blame] | 106 | u_int InUse, Config; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | struct resource *res; |
| 108 | } io_window_t; |
| 109 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | /* 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 Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 116 | |
| 117 | /* |
| 118 | * Socket operations. |
| 119 | */ |
| 120 | struct pcmcia_socket; |
| 121 | struct pccard_resource_ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | struct config_t; |
| 123 | struct pcmcia_callback; |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 124 | struct user_info_t; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 126 | struct 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | struct pcmcia_socket { |
| 136 | struct module *owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 137 | socket_state_t socket; |
| 138 | u_int state; |
Dominik Brodowski | 88b060d | 2010-01-02 14:14:23 +0100 | [diff] [blame] | 139 | u_int suspended_state; /* state before suspend */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | u_short functions; |
| 141 | u_short lock_count; |
| 142 | pccard_mem_map cis_mem; |
| 143 | void __iomem *cis_virt; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | struct { |
| 145 | u_int AssignedIRQ; |
| 146 | u_int Config; |
| 147 | } irq; |
| 148 | io_window_t io[MAX_IO_WIN]; |
Dominik Brodowski | 82f88e3 | 2009-11-03 01:16:12 +0100 | [diff] [blame] | 149 | pccard_mem_map win[MAX_WIN]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | struct list_head cis_cache; |
Dominik Brodowski | 53efec9 | 2008-07-28 19:44:05 +0200 | [diff] [blame] | 151 | size_t fake_cis_len; |
| 152 | u8 *fake_cis; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | |
| 154 | struct list_head socket_list; |
| 155 | struct completion socket_released; |
| 156 | |
Dominik Brodowski | 9fea84f | 2009-12-07 22:11:45 +0100 | [diff] [blame] | 157 | /* deprecated */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | 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 Johansson | 906da80 | 2008-02-04 22:27:35 -0800 | [diff] [blame] | 165 | u_int io_offset; |
Russell King - ARM Linux | 1689164 | 2009-03-29 22:43:43 +0100 | [diff] [blame] | 166 | u_int pci_irq; |
Dominik Brodowski | 9fea84f | 2009-12-07 22:11:45 +0100 | [diff] [blame] | 167 | struct pci_dev *cb_dev; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | |
| 169 | |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 170 | /* 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | u8 resource_setup_done:1; |
| 174 | |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 175 | /* It's old if resource setup is done using adjust_resource_info() */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | u8 resource_setup_old:1; |
Dominik Brodowski | 3c29976 | 2005-06-27 16:28:46 -0700 | [diff] [blame] | 177 | u8 resource_setup_new:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 178 | |
Dominik Brodowski | 3c29976 | 2005-06-27 16:28:46 -0700 | [diff] [blame] | 179 | u8 reserved:5; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | |
| 181 | /* socket operations */ |
Dominik Brodowski | 9fea84f | 2009-12-07 22:11:45 +0100 | [diff] [blame] | 182 | struct pccard_operations *ops; |
| 183 | struct pccard_resource_ops *resource_ops; |
| 184 | void *resource_data; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 185 | |
| 186 | /* Zoom video behaviour is so chip specific its not worth adding |
| 187 | this to _ops */ |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 188 | void (*zoom_video)(struct pcmcia_socket *, |
| 189 | int); |
Daniel Ritz | fa912bc | 2005-06-23 00:10:12 -0700 | [diff] [blame] | 190 | |
| 191 | /* so is power hook */ |
| 192 | int (*power_hook)(struct pcmcia_socket *sock, int operation); |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 193 | |
Daniel Ritz | 8c3520d | 2005-08-21 22:29:26 -0700 | [diff] [blame] | 194 | /* allows tuning the CB bridge before loading driver for the CB card */ |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 195 | #ifdef CONFIG_CARDBUS |
Daniel Ritz | 8c3520d | 2005-08-21 22:29:26 -0700 | [diff] [blame] | 196 | void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus); |
| 197 | #endif |
| 198 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | /* state thread */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 200 | struct task_struct *thread; |
| 201 | struct completion thread_done; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | unsigned int thread_events; |
Dominik Brodowski | f971dbd | 2010-01-17 18:13:31 +0100 | [diff] [blame] | 203 | unsigned int sysfs_events; |
Dominik Brodowski | 00ce99f | 2010-01-16 09:14:11 +0100 | [diff] [blame] | 204 | |
| 205 | /* For the non-trivial interaction between these locks, |
| 206 | * see Documentation/pcmcia/locking.txt */ |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 207 | struct mutex skt_mutex; |
Dominik Brodowski | 6b8e087 | 2010-01-12 21:42:51 +0100 | [diff] [blame] | 208 | struct mutex ops_mutex; |
Dominik Brodowski | 00ce99f | 2010-01-16 09:14:11 +0100 | [diff] [blame] | 209 | |
Dominik Brodowski | f971dbd | 2010-01-17 18:13:31 +0100 | [diff] [blame] | 210 | /* protects thread_events and sysfs_events */ |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 211 | spinlock_t thread_lock; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | |
| 213 | /* pcmcia (16-bit) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 214 | struct pcmcia_callback *callback; |
| 215 | |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 216 | #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE) |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 217 | /* The following elements refer to 16-bit PCMCIA devices inserted |
| 218 | * into the socket */ |
| 219 | struct list_head devices_list; |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 220 | |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 221 | /* the number of devices, used only internally and subject to |
| 222 | * incorrectness and change */ |
| 223 | u8 device_count; |
| 224 | |
| 225 | /* 16-bit state: */ |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 226 | struct { |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 227 | /* "master" ioctl is used */ |
| 228 | u8 busy:1; |
Dominik Brodowski | aa584ca | 2010-01-24 14:36:59 +0100 | [diff] [blame] | 229 | /* the PCMCIA card consists of two pseudo devices */ |
| 230 | u8 has_pfc:1; |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 231 | |
Dominik Brodowski | 04de081 | 2010-04-20 14:49:01 +0200 | [diff] [blame] | 232 | u8 reserved:6; |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 233 | } pcmcia_state; |
| 234 | |
Dominik Brodowski | 04de081 | 2010-04-20 14:49:01 +0200 | [diff] [blame] | 235 | /* non-zero if PCMCIA card is present */ |
| 236 | atomic_t present; |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 237 | |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 238 | #ifdef CONFIG_PCMCIA_IOCTL |
| 239 | struct user_info_t *user; |
| 240 | wait_queue_head_t queue; |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 241 | #endif /* CONFIG_PCMCIA_IOCTL */ |
| 242 | #endif /* CONFIG_PCMCIA */ |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 243 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 244 | /* socket device */ |
Greg Kroah-Hartman | 8737331 | 2006-09-12 17:00:10 +0200 | [diff] [blame] | 245 | struct device dev; |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 246 | /* data internal to the socket driver */ |
| 247 | void *driver_data; |
Rafael J. Wysocki | 9905d1b | 2009-11-03 10:54:58 +0100 | [diff] [blame] | 248 | /* status of the card during resume from a system sleep state */ |
| 249 | int resume_status; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 250 | }; |
| 251 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 252 | |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 253 | /* socket drivers must define the resource operations type they use. There |
| 254 | * are three options: |
| 255 | * - pccard_static_ops iomem and ioport areas are assigned statically |
| 256 | * - pccard_iodyn_ops iomem areas is assigned statically, ioport |
| 257 | * areas dynamically |
Dominik Brodowski | 4e8804f | 2010-01-06 11:19:25 +0100 | [diff] [blame] | 258 | * If this option is selected, use |
| 259 | * "select PCCARD_IODYN" in Kconfig. |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 260 | * - pccard_nonstatic_ops iomem and ioport areas are assigned dynamically. |
| 261 | * If this option is selected, use |
| 262 | * "select PCCARD_NONSTATIC" in Kconfig. |
Dominik Brodowski | 3a86e18 | 2010-01-06 14:33:15 +0100 | [diff] [blame] | 263 | * |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 264 | */ |
| 265 | extern struct pccard_resource_ops pccard_static_ops; |
Dominik Brodowski | 3a86e18 | 2010-01-06 14:33:15 +0100 | [diff] [blame] | 266 | #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE) |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 267 | extern struct pccard_resource_ops pccard_iodyn_ops; |
| 268 | extern struct pccard_resource_ops pccard_nonstatic_ops; |
Dominik Brodowski | 3a86e18 | 2010-01-06 14:33:15 +0100 | [diff] [blame] | 269 | #else |
| 270 | /* If PCMCIA is not used, but only CARDBUS, these functions are not used |
| 271 | * at all. Therefore, do not use the large (240K!) rsrc_nonstatic module |
| 272 | */ |
| 273 | #define pccard_iodyn_ops pccard_static_ops |
| 274 | #define pccard_nonstatic_ops pccard_static_ops |
| 275 | #endif |
| 276 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | |
Dominik Brodowski | c23889c | 2008-08-26 00:09:56 +0200 | [diff] [blame] | 278 | /* socket drivers use this callback in their IRQ handler */ |
| 279 | extern void pcmcia_parse_events(struct pcmcia_socket *socket, |
| 280 | unsigned int events); |
| 281 | |
| 282 | /* to register and unregister a socket */ |
| 283 | extern int pcmcia_register_socket(struct pcmcia_socket *socket); |
| 284 | extern void pcmcia_unregister_socket(struct pcmcia_socket *socket); |
| 285 | |
| 286 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 287 | #endif /* _LINUX_SS_H */ |