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.h> 23#ifdef CONFIG_CARDBUS 24#include <linux/pci.h> 25#endif 26 27/* Definitions for card status flags for GetStatus */ 28#define SS_WRPROT 0x0001 29#define SS_CARDLOCK 0x0002 30#define SS_EJECTION 0x0004 31#define SS_INSERTION 0x0008 32#define SS_BATDEAD 0x0010 33#define SS_BATWARN 0x0020 34#define SS_READY 0x0040 35#define SS_DETECT 0x0080 36#define SS_POWERON 0x0100 37#define SS_GPI 0x0200 38#define SS_STSCHG 0x0400 39#define SS_CARDBUS 0x0800 40#define SS_3VCARD 0x1000 41#define SS_XVCARD 0x2000 42#define SS_PENDING 0x4000 43#define SS_ZVCARD 0x8000 44 45/* InquireSocket capabilities */ 46#define SS_CAP_PAGE_REGS 0x0001 47#define SS_CAP_VIRTUAL_BUS 0x0002 48#define SS_CAP_MEM_ALIGN 0x0004 49#define SS_CAP_STATIC_MAP 0x0008 50#define SS_CAP_PCCARD 0x4000 51#define SS_CAP_CARDBUS 0x8000 52 53/* for GetSocket, SetSocket */ 54typedef struct socket_state_t { 55 u_int flags; 56 u_int csc_mask; 57 u_char Vcc, Vpp; 58 u_char io_irq; 59} socket_state_t; 60 61extern socket_state_t dead_socket; 62 63/* Socket configuration flags */ 64#define SS_PWR_AUTO 0x0010 65#define SS_IOCARD 0x0020 66#define SS_RESET 0x0040 67#define SS_DMA_MODE 0x0080 68#define SS_SPKR_ENA 0x0100 69#define SS_OUTPUT_ENA 0x0200 70 71/* Flags for I/O port and memory windows */ 72#define MAP_ACTIVE 0x01 73#define MAP_16BIT 0x02 74#define MAP_AUTOSZ 0x04 75#define MAP_0WS 0x08 76#define MAP_WRPROT 0x10 77#define MAP_ATTRIB 0x20 78#define MAP_USE_WAIT 0x40 79#define MAP_PREFETCH 0x80 80 81/* Use this just for bridge windows */ 82#define MAP_IOSPACE 0x20 83 84/* power hook operations */ 85#define HOOK_POWER_PRE 0x01 86#define HOOK_POWER_POST 0x02 87 88typedef struct pccard_io_map { 89 u_char map; 90 u_char flags; 91 u_short speed; 92 phys_addr_t start, stop; 93} pccard_io_map; 94 95typedef struct pccard_mem_map { 96 u_char map; 97 u_char flags; 98 u_short speed; 99 phys_addr_t static_start; 100 u_int card_start; 101 struct resource *res; 102} pccard_mem_map; 103 104typedef struct io_window_t { 105 u_int InUse, Config; 106 struct resource *res; 107} io_window_t; 108 109/* Maximum number of IO windows per socket */ 110#define MAX_IO_WIN 2 111 112/* Maximum number of memory windows per socket */ 113#define MAX_WIN 4 114 115 116/* 117 * Socket operations. 118 */ 119struct pcmcia_socket; 120struct pccard_resource_ops; 121struct config_t; 122struct pcmcia_callback; 123struct user_info_t; 124 125struct pccard_operations { 126 int (*init)(struct pcmcia_socket *s); 127 int (*suspend)(struct pcmcia_socket *s); 128 int (*get_status)(struct pcmcia_socket *s, u_int *value); 129 int (*set_socket)(struct pcmcia_socket *s, socket_state_t *state); 130 int (*set_io_map)(struct pcmcia_socket *s, struct pccard_io_map *io); 131 int (*set_mem_map)(struct pcmcia_socket *s, struct pccard_mem_map *mem); 132}; 133 134struct pcmcia_socket { 135 struct module *owner; 136 socket_state_t socket; 137 u_int state; 138 u_int suspended_state; /* state before suspend */ 139 u_short functions; 140 u_short lock_count; 141 pccard_mem_map cis_mem; 142 void __iomem *cis_virt; 143 io_window_t io[MAX_IO_WIN]; 144 pccard_mem_map win[MAX_WIN]; 145 struct list_head cis_cache; 146 size_t fake_cis_len; 147 u8 *fake_cis; 148 149 struct list_head socket_list; 150 struct completion socket_released; 151 152 /* deprecated */ 153 unsigned int sock; /* socket number */ 154 155 156 /* socket capabilities */ 157 u_int features; 158 u_int irq_mask; 159 u_int map_size; 160 u_int io_offset; 161 u_int pci_irq; 162 struct pci_dev *cb_dev; 163 164 /* socket setup is done so resources should be able to be allocated. 165 * Only if set to 1, calls to find_{io,mem}_region are handled, and 166 * insertio events are actually managed by the PCMCIA layer.*/ 167 u8 resource_setup_done; 168 169 /* socket operations */ 170 struct pccard_operations *ops; 171 struct pccard_resource_ops *resource_ops; 172 void *resource_data; 173 174 /* Zoom video behaviour is so chip specific its not worth adding 175 this to _ops */ 176 void (*zoom_video)(struct pcmcia_socket *, 177 int); 178 179 /* so is power hook */ 180 int (*power_hook)(struct pcmcia_socket *sock, int operation); 181 182 /* allows tuning the CB bridge before loading driver for the CB card */ 183#ifdef CONFIG_CARDBUS 184 void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus); 185#endif 186 187 /* state thread */ 188 struct task_struct *thread; 189 struct completion thread_done; 190 unsigned int thread_events; 191 unsigned int sysfs_events; 192 193 /* For the non-trivial interaction between these locks, 194 * see Documentation/pcmcia/locking.txt */ 195 struct mutex skt_mutex; 196 struct mutex ops_mutex; 197 198 /* protects thread_events and sysfs_events */ 199 spinlock_t thread_lock; 200 201 /* pcmcia (16-bit) */ 202 struct pcmcia_callback *callback; 203 204#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE) 205 /* The following elements refer to 16-bit PCMCIA devices inserted 206 * into the socket */ 207 struct list_head devices_list; 208 209 /* the number of devices, used only internally and subject to 210 * incorrectness and change */ 211 u8 device_count; 212 213 /* does the PCMCIA card consist of two pseudo devices? */ 214 u8 pcmcia_pfc; 215 216 /* non-zero if PCMCIA card is present */ 217 atomic_t present; 218 219 /* IRQ to be used by PCMCIA devices. May not be IRQ 0. */ 220 unsigned int pcmcia_irq; 221 222#endif /* CONFIG_PCMCIA */ 223 224 /* socket device */ 225 struct device dev; 226 /* data internal to the socket driver */ 227 void *driver_data; 228 /* status of the card during resume from a system sleep state */ 229 int resume_status; 230}; 231 232 233/* socket drivers must define the resource operations type they use. There 234 * are three options: 235 * - pccard_static_ops iomem and ioport areas are assigned statically 236 * - pccard_iodyn_ops iomem areas is assigned statically, ioport 237 * areas dynamically 238 * If this option is selected, use 239 * "select PCCARD_IODYN" in Kconfig. 240 * - pccard_nonstatic_ops iomem and ioport areas are assigned dynamically. 241 * If this option is selected, use 242 * "select PCCARD_NONSTATIC" in Kconfig. 243 * 244 */ 245extern struct pccard_resource_ops pccard_static_ops; 246#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE) 247extern struct pccard_resource_ops pccard_iodyn_ops; 248extern struct pccard_resource_ops pccard_nonstatic_ops; 249#else 250/* If PCMCIA is not used, but only CARDBUS, these functions are not used 251 * at all. Therefore, do not use the large (240K!) rsrc_nonstatic module 252 */ 253#define pccard_iodyn_ops pccard_static_ops 254#define pccard_nonstatic_ops pccard_static_ops 255#endif 256 257 258/* socket drivers use this callback in their IRQ handler */ 259extern void pcmcia_parse_events(struct pcmcia_socket *socket, 260 unsigned int events); 261 262/* to register and unregister a socket */ 263extern int pcmcia_register_socket(struct pcmcia_socket *socket); 264extern void pcmcia_unregister_socket(struct pcmcia_socket *socket); 265 266 267#endif /* _LINUX_SS_H */ 268