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/config.h> 19 #include <linux/device.h> 20 #include <linux/sched.h> /* task_struct, completion */ 21 22 #include <pcmcia/cs_types.h> 23 #include <pcmcia/cs.h> 24 #include <pcmcia/bulkmem.h> 25 #ifdef CONFIG_CARDBUS 26 #include <linux/pci.h> 27 #endif 28 29 /* Definitions for card status flags for GetStatus */ 30 #define SS_WRPROT 0x0001 31 #define SS_CARDLOCK 0x0002 32 #define SS_EJECTION 0x0004 33 #define SS_INSERTION 0x0008 34 #define SS_BATDEAD 0x0010 35 #define SS_BATWARN 0x0020 36 #define SS_READY 0x0040 37 #define SS_DETECT 0x0080 38 #define SS_POWERON 0x0100 39 #define SS_GPI 0x0200 40 #define SS_STSCHG 0x0400 41 #define SS_CARDBUS 0x0800 42 #define SS_3VCARD 0x1000 43 #define SS_XVCARD 0x2000 44 #define SS_PENDING 0x4000 45 #define SS_ZVCARD 0x8000 46 47 /* InquireSocket capabilities */ 48 #define SS_CAP_PAGE_REGS 0x0001 49 #define SS_CAP_VIRTUAL_BUS 0x0002 50 #define SS_CAP_MEM_ALIGN 0x0004 51 #define SS_CAP_STATIC_MAP 0x0008 52 #define SS_CAP_PCCARD 0x4000 53 #define SS_CAP_CARDBUS 0x8000 54 55 /* for GetSocket, SetSocket */ 56 typedef struct socket_state_t { 57 u_int flags; 58 u_int csc_mask; 59 u_char Vcc, Vpp; 60 u_char io_irq; 61 } socket_state_t; 62 63 extern socket_state_t dead_socket; 64 65 /* Socket configuration flags */ 66 #define SS_PWR_AUTO 0x0010 67 #define SS_IOCARD 0x0020 68 #define SS_RESET 0x0040 69 #define SS_DMA_MODE 0x0080 70 #define SS_SPKR_ENA 0x0100 71 #define SS_OUTPUT_ENA 0x0200 72 73 /* Flags for I/O port and memory windows */ 74 #define MAP_ACTIVE 0x01 75 #define MAP_16BIT 0x02 76 #define MAP_AUTOSZ 0x04 77 #define MAP_0WS 0x08 78 #define MAP_WRPROT 0x10 79 #define MAP_ATTRIB 0x20 80 #define MAP_USE_WAIT 0x40 81 #define MAP_PREFETCH 0x80 82 83 /* Use this just for bridge windows */ 84 #define MAP_IOSPACE 0x20 85 86 /* power hook operations */ 87 #define HOOK_POWER_PRE 0x01 88 #define HOOK_POWER_POST 0x02 89 90 91 typedef struct pccard_io_map { 92 u_char map; 93 u_char flags; 94 u_short speed; 95 kio_addr_t start, stop; 96 } pccard_io_map; 97 98 typedef struct pccard_mem_map { 99 u_char map; 100 u_char flags; 101 u_short speed; 102 u_long static_start; 103 u_int card_start; 104 struct resource *res; 105 } pccard_mem_map; 106 107 typedef struct cb_bridge_map { 108 u_char map; 109 u_char flags; 110 u_int start, stop; 111 } cb_bridge_map; 112 113 /* 114 * Socket operations. 115 */ 116 struct pcmcia_socket; 117 118 struct pccard_operations { 119 int (*init)(struct pcmcia_socket *sock); 120 int (*suspend)(struct pcmcia_socket *sock); 121 int (*register_callback)(struct pcmcia_socket *sock, void (*handler)(void *, unsigned int), void * info); 122 int (*get_status)(struct pcmcia_socket *sock, u_int *value); 123 int (*get_socket)(struct pcmcia_socket *sock, socket_state_t *state); 124 int (*set_socket)(struct pcmcia_socket *sock, socket_state_t *state); 125 int (*set_io_map)(struct pcmcia_socket *sock, struct pccard_io_map *io); 126 int (*set_mem_map)(struct pcmcia_socket *sock, struct pccard_mem_map *mem); 127 }; 128 129 struct pccard_resource_ops { 130 void (*validate_mem) (struct pcmcia_socket *s); 131 int (*adjust_io_region) (struct resource *res, 132 unsigned long r_start, 133 unsigned long r_end, 134 struct pcmcia_socket *s); 135 struct resource* (*find_io) (unsigned long base, int num, 136 unsigned long align, 137 struct pcmcia_socket *s); 138 struct resource* (*find_mem) (unsigned long base, unsigned long num, 139 unsigned long align, int low, 140 struct pcmcia_socket *s); 141 int (*adjust_resource) (struct pcmcia_socket *s, 142 adjust_t *adj); 143 int (*init) (struct pcmcia_socket *s); 144 void (*exit) (struct pcmcia_socket *s); 145 }; 146 /* SS_CAP_STATIC_MAP */ 147 extern struct pccard_resource_ops pccard_static_ops; 148 /* !SS_CAP_STATIC_MAP */ 149 extern struct pccard_resource_ops pccard_nonstatic_ops; 150 151 /* 152 * Calls to set up low-level "Socket Services" drivers 153 */ 154 struct pcmcia_socket; 155 156 typedef struct io_window_t { 157 u_int Attributes; 158 kio_addr_t BasePort, NumPorts; 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; 167 client_handle_t handle; 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; 180 struct user_info_t; 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; 191 struct config_t *config; 192 struct { 193 u_int AssignedIRQ; 194 u_int Config; 195 } irq; 196 io_window_t io[MAX_IO_WIN]; 197 window_t win[MAX_WIN]; 198 struct list_head cis_cache; 199 u_int fake_cis_len; 200 char *fake_cis; 201 202 struct list_head socket_list; 203 struct completion socket_released; 204 205 /* deprecated */ 206 unsigned int sock; /* socket number */ 207 208 209 /* socket capabilities */ 210 u_int features; 211 u_int irq_mask; 212 u_int map_size; 213 kio_addr_t io_offset; 214 u_char pci_irq; 215 struct pci_dev * cb_dev; 216 217 218 /* socket setup is done so resources should be able to be allocated. Only 219 * if set to 1, calls to find_{io,mem}_region are handled, and insertion 220 * events are actually managed by the PCMCIA layer.*/ 221 u8 resource_setup_done:1; 222 223 /* is set to one if resource setup is done using adjust_resource_info() */ 224 u8 resource_setup_old:1; 225 u8 resource_setup_new:1; 226 227 u8 reserved:5; 228 229 /* socket operations */ 230 struct pccard_operations * ops; 231 struct pccard_resource_ops * resource_ops; 232 void * resource_data; 233 234 /* Zoom video behaviour is so chip specific its not worth adding 235 this to _ops */ 236 void (*zoom_video)(struct pcmcia_socket *, int); 237 238 /* so is power hook */ 239 int (*power_hook)(struct pcmcia_socket *sock, int operation); 240 #ifdef CONFIG_CARDBUS 241 /* allows tuning the CB bridge before loading driver for the CB card */ 242 void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus); 243 #endif 244 245 /* state thread */ 246 struct semaphore skt_sem; /* protects socket h/w state */ 247 248 struct task_struct *thread; 249 struct completion thread_done; 250 wait_queue_head_t thread_wait; 251 spinlock_t thread_lock; /* protects thread_events */ 252 unsigned int thread_events; 253 254 /* pcmcia (16-bit) */ 255 struct pcmcia_callback *callback; 256 257 #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE) 258 struct list_head devices_list; /* PCMCIA devices */ 259 u8 device_count; /* the number of devices, used 260 * only internally and subject 261 * to incorrectness and change */ 262 263 struct { 264 u8 present:1, /* PCMCIA card is present in socket */ 265 busy:1, /* "master" ioctl is used */ 266 dead:1, /* pcmcia module is being unloaded */ 267 device_add_pending:1, /* a pseudo-multifunction-device 268 * add event is pending */ 269 reserved:4; 270 } pcmcia_state; 271 272 struct work_struct device_add; /* for adding further pseudo-multifunction 273 * devices */ 274 275 #ifdef CONFIG_PCMCIA_IOCTL 276 struct user_info_t *user; 277 wait_queue_head_t queue; 278 #endif 279 #endif 280 281 /* cardbus (32-bit) */ 282 #ifdef CONFIG_CARDBUS 283 struct resource * cb_cis_res; 284 void __iomem *cb_cis_virt; 285 #endif 286 287 /* socket device */ 288 struct class_device dev; 289 void *driver_data; /* data internal to the socket driver */ 290 291 }; 292 293 struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr); 294 295 296 297 extern void pcmcia_parse_events(struct pcmcia_socket *socket, unsigned int events); 298 extern int pcmcia_register_socket(struct pcmcia_socket *socket); 299 extern void pcmcia_unregister_socket(struct pcmcia_socket *socket); 300 301 extern struct class pcmcia_socket_class; 302 303 /* socket drivers are expected to use these callbacks in their .drv struct */ 304 extern int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state); 305 extern int pcmcia_socket_dev_resume(struct device *dev); 306 307 #endif /* _LINUX_SS_H */ 308