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 18 #include <linux/device.h> 19 #include <linux/sched.h> /* task_struct, completion */ 20 #include <linux/mutex.h> 21 22 #include <pcmcia/cs_types.h> 23 #include <pcmcia/cs.h> 24 #ifdef CONFIG_CARDBUS 25 #include <linux/pci.h> 26 #endif 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 { 56 u_int flags; 57 u_int csc_mask; 58 u_char Vcc, Vpp; 59 u_char io_irq; 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 85 /* power hook operations */ 86 #define HOOK_POWER_PRE 0x01 87 #define HOOK_POWER_POST 0x02 88 89 90 typedef struct pccard_io_map { 91 u_char map; 92 u_char flags; 93 u_short speed; 94 u_int start, stop; 95 } pccard_io_map; 96 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; 105 106 typedef struct cb_bridge_map { 107 u_char map; 108 u_char flags; 109 u_int start, stop; 110 } cb_bridge_map; 111 112 /* 113 * Socket operations. 114 */ 115 struct pcmcia_socket; 116 117 struct pccard_operations { 118 int (*init)(struct pcmcia_socket *sock); 119 int (*suspend)(struct pcmcia_socket *sock); 120 int (*get_status)(struct pcmcia_socket *sock, u_int *value); 121 int (*set_socket)(struct pcmcia_socket *sock, socket_state_t *state); 122 int (*set_io_map)(struct pcmcia_socket *sock, struct pccard_io_map *io); 123 int (*set_mem_map)(struct pcmcia_socket *sock, struct pccard_mem_map *mem); 124 }; 125 126 struct pccard_resource_ops { 127 int (*validate_mem) (struct pcmcia_socket *s); 128 int (*adjust_io_region) (struct resource *res, 129 unsigned long r_start, 130 unsigned long r_end, 131 struct pcmcia_socket *s); 132 struct resource* (*find_io) (unsigned long base, int num, 133 unsigned long align, 134 struct pcmcia_socket *s); 135 struct resource* (*find_mem) (unsigned long base, unsigned long num, 136 unsigned long align, int low, 137 struct pcmcia_socket *s); 138 int (*add_io) (struct pcmcia_socket *s, 139 unsigned int action, 140 unsigned long r_start, 141 unsigned long r_end); 142 int (*add_mem) (struct pcmcia_socket *s, 143 unsigned int action, 144 unsigned long r_start, 145 unsigned long r_end); 146 int (*init) (struct pcmcia_socket *s); 147 void (*exit) (struct pcmcia_socket *s); 148 }; 149 /* SS_CAP_STATIC_MAP */ 150 extern struct pccard_resource_ops pccard_static_ops; 151 /* !SS_CAP_STATIC_MAP */ 152 extern struct pccard_resource_ops pccard_nonstatic_ops; 153 154 /* static mem, dynamic IO sockets */ 155 extern struct pccard_resource_ops pccard_iodyn_ops; 156 157 /* 158 * Calls to set up low-level "Socket Services" drivers 159 */ 160 struct pcmcia_socket; 161 162 typedef struct io_window_t { 163 u_int InUse, Config; 164 struct resource *res; 165 } io_window_t; 166 167 #define WINDOW_MAGIC 0xB35C 168 typedef struct window_t { 169 u_short magic; 170 u_short index; 171 struct pcmcia_device *handle; 172 struct pcmcia_socket *sock; 173 pccard_mem_map ctl; 174 } window_t; 175 176 /* Maximum number of IO windows per socket */ 177 #define MAX_IO_WIN 2 178 179 /* Maximum number of memory windows per socket */ 180 #define MAX_WIN 4 181 182 struct config_t; 183 struct pcmcia_callback; 184 struct user_info_t; 185 186 struct pcmcia_socket { 187 struct module *owner; 188 spinlock_t lock; 189 socket_state_t socket; 190 u_int state; 191 u_short functions; 192 u_short lock_count; 193 pccard_mem_map cis_mem; 194 void __iomem *cis_virt; 195 struct { 196 u_int AssignedIRQ; 197 u_int Config; 198 } irq; 199 io_window_t io[MAX_IO_WIN]; 200 window_t win[MAX_WIN]; 201 struct list_head cis_cache; 202 u_int fake_cis_len; 203 char *fake_cis; 204 205 struct list_head socket_list; 206 struct completion socket_released; 207 208 /* deprecated */ 209 unsigned int sock; /* socket number */ 210 211 212 /* socket capabilities */ 213 u_int features; 214 u_int irq_mask; 215 u_int map_size; 216 u_int io_offset; 217 u_char pci_irq; 218 struct pci_dev * cb_dev; 219 220 221 /* socket setup is done so resources should be able to be allocated. Only 222 * if set to 1, calls to find_{io,mem}_region are handled, and insertion 223 * events are actually managed by the PCMCIA layer.*/ 224 u8 resource_setup_done:1; 225 226 /* is set to one if resource setup is done using adjust_resource_info() */ 227 u8 resource_setup_old:1; 228 u8 resource_setup_new:1; 229 230 u8 reserved:5; 231 232 /* socket operations */ 233 struct pccard_operations * ops; 234 struct pccard_resource_ops * resource_ops; 235 void * resource_data; 236 237 /* Zoom video behaviour is so chip specific its not worth adding 238 this to _ops */ 239 void (*zoom_video)(struct pcmcia_socket *, int); 240 241 /* so is power hook */ 242 int (*power_hook)(struct pcmcia_socket *sock, int operation); 243 #ifdef CONFIG_CARDBUS 244 /* allows tuning the CB bridge before loading driver for the CB card */ 245 void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus); 246 #endif 247 248 /* state thread */ 249 struct mutex skt_mutex; /* protects socket h/w state */ 250 251 struct task_struct *thread; 252 struct completion thread_done; 253 spinlock_t thread_lock; /* protects thread_events */ 254 unsigned int thread_events; 255 256 /* pcmcia (16-bit) */ 257 struct pcmcia_callback *callback; 258 259 #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE) 260 struct list_head devices_list; /* PCMCIA devices */ 261 u8 device_count; /* the number of devices, used 262 * only internally and subject 263 * to incorrectness and change */ 264 265 struct { 266 u8 present:1, /* PCMCIA card is present in socket */ 267 busy:1, /* "master" ioctl is used */ 268 dead:1, /* pcmcia module is being unloaded */ 269 device_add_pending:1, /* a multifunction-device 270 * add event is pending */ 271 mfc_pfc:1, /* the pending event adds a mfc (1) or pfc (0) */ 272 reserved:3; 273 } pcmcia_state; 274 275 struct work_struct device_add; /* for adding further pseudo-multifunction 276 * devices */ 277 278 #ifdef CONFIG_PCMCIA_IOCTL 279 struct user_info_t *user; 280 wait_queue_head_t queue; 281 #endif 282 #endif 283 284 /* cardbus (32-bit) */ 285 #ifdef CONFIG_CARDBUS 286 struct resource * cb_cis_res; 287 void __iomem *cb_cis_virt; 288 #endif 289 290 /* socket device */ 291 struct device dev; 292 void *driver_data; /* data internal to the socket driver */ 293 294 }; 295 296 struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr); 297 298 299 300 extern void pcmcia_parse_events(struct pcmcia_socket *socket, unsigned int events); 301 extern int pcmcia_register_socket(struct pcmcia_socket *socket); 302 extern void pcmcia_unregister_socket(struct pcmcia_socket *socket); 303 304 extern struct class pcmcia_socket_class; 305 306 /* socket drivers are expected to use these callbacks in their .drv struct */ 307 extern int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state); 308 extern int pcmcia_socket_dev_resume(struct device *dev); 309 310 #endif /* _LINUX_SS_H */ 311