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/config.h> |
| 19 | #include <linux/device.h> |
Tim Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 20 | #include <linux/sched.h> /* task_struct, completion */ |
Dominik Brodowski | 7fe908d | 2006-01-10 21:20:36 +0100 | [diff] [blame] | 21 | #include <linux/mutex.h> |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 22 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | #include <pcmcia/cs_types.h> |
| 24 | #include <pcmcia/cs.h> |
| 25 | #include <pcmcia/bulkmem.h> |
Daniel Ritz | 8c3520d | 2005-08-21 22:29:26 -0700 | [diff] [blame] | 26 | #ifdef CONFIG_CARDBUS |
| 27 | #include <linux/pci.h> |
| 28 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | |
| 30 | /* Definitions for card status flags for GetStatus */ |
| 31 | #define SS_WRPROT 0x0001 |
| 32 | #define SS_CARDLOCK 0x0002 |
| 33 | #define SS_EJECTION 0x0004 |
| 34 | #define SS_INSERTION 0x0008 |
| 35 | #define SS_BATDEAD 0x0010 |
| 36 | #define SS_BATWARN 0x0020 |
| 37 | #define SS_READY 0x0040 |
| 38 | #define SS_DETECT 0x0080 |
| 39 | #define SS_POWERON 0x0100 |
| 40 | #define SS_GPI 0x0200 |
| 41 | #define SS_STSCHG 0x0400 |
| 42 | #define SS_CARDBUS 0x0800 |
| 43 | #define SS_3VCARD 0x1000 |
| 44 | #define SS_XVCARD 0x2000 |
| 45 | #define SS_PENDING 0x4000 |
| 46 | #define SS_ZVCARD 0x8000 |
| 47 | |
| 48 | /* InquireSocket capabilities */ |
| 49 | #define SS_CAP_PAGE_REGS 0x0001 |
| 50 | #define SS_CAP_VIRTUAL_BUS 0x0002 |
| 51 | #define SS_CAP_MEM_ALIGN 0x0004 |
| 52 | #define SS_CAP_STATIC_MAP 0x0008 |
| 53 | #define SS_CAP_PCCARD 0x4000 |
| 54 | #define SS_CAP_CARDBUS 0x8000 |
| 55 | |
| 56 | /* for GetSocket, SetSocket */ |
| 57 | typedef struct socket_state_t { |
| 58 | u_int flags; |
| 59 | u_int csc_mask; |
| 60 | u_char Vcc, Vpp; |
| 61 | u_char io_irq; |
| 62 | } socket_state_t; |
| 63 | |
| 64 | extern socket_state_t dead_socket; |
| 65 | |
| 66 | /* Socket configuration flags */ |
| 67 | #define SS_PWR_AUTO 0x0010 |
| 68 | #define SS_IOCARD 0x0020 |
| 69 | #define SS_RESET 0x0040 |
| 70 | #define SS_DMA_MODE 0x0080 |
| 71 | #define SS_SPKR_ENA 0x0100 |
| 72 | #define SS_OUTPUT_ENA 0x0200 |
| 73 | |
| 74 | /* Flags for I/O port and memory windows */ |
| 75 | #define MAP_ACTIVE 0x01 |
| 76 | #define MAP_16BIT 0x02 |
| 77 | #define MAP_AUTOSZ 0x04 |
| 78 | #define MAP_0WS 0x08 |
| 79 | #define MAP_WRPROT 0x10 |
| 80 | #define MAP_ATTRIB 0x20 |
| 81 | #define MAP_USE_WAIT 0x40 |
| 82 | #define MAP_PREFETCH 0x80 |
| 83 | |
| 84 | /* Use this just for bridge windows */ |
| 85 | #define MAP_IOSPACE 0x20 |
| 86 | |
Daniel Ritz | fa912bc | 2005-06-23 00:10:12 -0700 | [diff] [blame] | 87 | /* power hook operations */ |
| 88 | #define HOOK_POWER_PRE 0x01 |
| 89 | #define HOOK_POWER_POST 0x02 |
| 90 | |
| 91 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 92 | typedef struct pccard_io_map { |
| 93 | u_char map; |
| 94 | u_char flags; |
| 95 | u_short speed; |
| 96 | kio_addr_t start, stop; |
| 97 | } pccard_io_map; |
| 98 | |
| 99 | typedef struct pccard_mem_map { |
| 100 | u_char map; |
| 101 | u_char flags; |
| 102 | u_short speed; |
| 103 | u_long static_start; |
| 104 | u_int card_start; |
| 105 | struct resource *res; |
| 106 | } pccard_mem_map; |
| 107 | |
| 108 | typedef struct cb_bridge_map { |
| 109 | u_char map; |
| 110 | u_char flags; |
| 111 | u_int start, stop; |
| 112 | } cb_bridge_map; |
| 113 | |
| 114 | /* |
| 115 | * Socket operations. |
| 116 | */ |
| 117 | struct pcmcia_socket; |
| 118 | |
| 119 | struct pccard_operations { |
| 120 | int (*init)(struct pcmcia_socket *sock); |
| 121 | int (*suspend)(struct pcmcia_socket *sock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | int (*get_status)(struct pcmcia_socket *sock, u_int *value); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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); |
| 126 | }; |
| 127 | |
| 128 | struct pccard_resource_ops { |
Dominik Brodowski | de75914 | 2005-09-28 19:41:56 +0200 | [diff] [blame] | 129 | int (*validate_mem) (struct pcmcia_socket *s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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); |
| 144 | }; |
| 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; |
| 149 | |
Marcelo Tosatti | 553ee5d | 2006-03-31 16:37:25 -0600 | [diff] [blame] | 150 | /* static mem, dynamic IO sockets */ |
| 151 | extern struct pccard_resource_ops pccard_iodyn_ops; |
| 152 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | /* |
| 154 | * Calls to set up low-level "Socket Services" drivers |
| 155 | */ |
| 156 | struct pcmcia_socket; |
| 157 | |
| 158 | typedef struct io_window_t { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | kio_addr_t InUse, Config; |
| 160 | struct resource *res; |
| 161 | } io_window_t; |
| 162 | |
| 163 | #define WINDOW_MAGIC 0xB35C |
| 164 | typedef struct window_t { |
| 165 | u_short magic; |
| 166 | u_short index; |
Dominik Brodowski | fba395e | 2006-03-31 17:21:06 +0200 | [diff] [blame] | 167 | struct pcmcia_device *handle; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | struct pcmcia_socket *sock; |
| 169 | pccard_mem_map ctl; |
| 170 | } window_t; |
| 171 | |
| 172 | /* Maximum number of IO windows per socket */ |
| 173 | #define MAX_IO_WIN 2 |
| 174 | |
| 175 | /* Maximum number of memory windows per socket */ |
| 176 | #define MAX_WIN 4 |
| 177 | |
| 178 | struct config_t; |
| 179 | struct pcmcia_callback; |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 180 | struct user_info_t; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 181 | |
| 182 | struct pcmcia_socket { |
| 183 | struct module *owner; |
| 184 | spinlock_t lock; |
| 185 | socket_state_t socket; |
| 186 | u_int state; |
| 187 | u_short functions; |
| 188 | u_short lock_count; |
| 189 | pccard_mem_map cis_mem; |
| 190 | void __iomem *cis_virt; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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; |
| 200 | |
| 201 | struct list_head socket_list; |
| 202 | struct completion socket_released; |
| 203 | |
| 204 | /* deprecated */ |
| 205 | unsigned int sock; /* socket number */ |
| 206 | |
| 207 | |
| 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; |
| 215 | |
| 216 | |
| 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; |
| 221 | |
| 222 | /* is set to one if resource setup is done using adjust_resource_info() */ |
| 223 | u8 resource_setup_old:1; |
Dominik Brodowski | 3c29976 | 2005-06-27 16:28:46 -0700 | [diff] [blame] | 224 | u8 resource_setup_new:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 225 | |
Dominik Brodowski | 3c29976 | 2005-06-27 16:28:46 -0700 | [diff] [blame] | 226 | u8 reserved:5; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 227 | |
| 228 | /* socket operations */ |
| 229 | struct pccard_operations * ops; |
| 230 | struct pccard_resource_ops * resource_ops; |
| 231 | void * resource_data; |
| 232 | |
| 233 | /* Zoom video behaviour is so chip specific its not worth adding |
| 234 | this to _ops */ |
| 235 | void (*zoom_video)(struct pcmcia_socket *, int); |
Daniel Ritz | fa912bc | 2005-06-23 00:10:12 -0700 | [diff] [blame] | 236 | |
| 237 | /* so is power hook */ |
| 238 | int (*power_hook)(struct pcmcia_socket *sock, int operation); |
Daniel Ritz | 8c3520d | 2005-08-21 22:29:26 -0700 | [diff] [blame] | 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 |
| 243 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 244 | /* state thread */ |
Dominik Brodowski | 7fe908d | 2006-01-10 21:20:36 +0100 | [diff] [blame] | 245 | struct mutex skt_mutex; /* protects socket h/w state */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 246 | |
| 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; |
| 252 | |
| 253 | /* pcmcia (16-bit) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 254 | struct pcmcia_callback *callback; |
| 255 | |
Dominik Brodowski | dc10949 | 2005-06-27 16:28:50 -0700 | [diff] [blame] | 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 */ |
| 261 | |
| 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; |
| 270 | |
| 271 | struct work_struct device_add; /* for adding further pseudo-multifunction |
| 272 | * devices */ |
| 273 | |
| 274 | #ifdef CONFIG_PCMCIA_IOCTL |
| 275 | struct user_info_t *user; |
| 276 | wait_queue_head_t queue; |
| 277 | #endif |
| 278 | #endif |
| 279 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 280 | /* cardbus (32-bit) */ |
| 281 | #ifdef CONFIG_CARDBUS |
| 282 | struct resource * cb_cis_res; |
| 283 | void __iomem *cb_cis_virt; |
| 284 | #endif |
| 285 | |
| 286 | /* socket device */ |
| 287 | struct class_device dev; |
| 288 | void *driver_data; /* data internal to the socket driver */ |
| 289 | |
| 290 | }; |
| 291 | |
| 292 | struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr); |
| 293 | |
| 294 | |
| 295 | |
| 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); |
| 299 | |
| 300 | extern struct class pcmcia_socket_class; |
| 301 | |
| 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); |
| 305 | |
| 306 | #endif /* _LINUX_SS_H */ |