264 lines · c
1/* SPDX-License-Identifier: GPL-2.0-only */2/*3 * ss.h4 *5 * The initial developer of the original code is David A. Hinds6 * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds7 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.8 *9 * (C) 1999 David A. Hinds10 */11 12#ifndef _LINUX_SS_H13#define _LINUX_SS_H14 15#include <linux/device.h>16#include <linux/sched.h> /* task_struct, completion */17#include <linux/mutex.h>18 19#ifdef CONFIG_CARDBUS20#include <linux/pci.h>21#endif22 23/* Definitions for card status flags for GetStatus */24#define SS_WRPROT 0x000125#define SS_CARDLOCK 0x000226#define SS_EJECTION 0x000427#define SS_INSERTION 0x000828#define SS_BATDEAD 0x001029#define SS_BATWARN 0x002030#define SS_READY 0x004031#define SS_DETECT 0x008032#define SS_POWERON 0x010033#define SS_GPI 0x020034#define SS_STSCHG 0x040035#define SS_CARDBUS 0x080036#define SS_3VCARD 0x100037#define SS_XVCARD 0x200038#define SS_PENDING 0x400039#define SS_ZVCARD 0x800040 41/* InquireSocket capabilities */42#define SS_CAP_PAGE_REGS 0x000143#define SS_CAP_VIRTUAL_BUS 0x000244#define SS_CAP_MEM_ALIGN 0x000445#define SS_CAP_STATIC_MAP 0x000846#define SS_CAP_PCCARD 0x400047#define SS_CAP_CARDBUS 0x800048 49/* for GetSocket, SetSocket */50typedef struct socket_state_t {51 u_int flags;52 u_int csc_mask;53 u_char Vcc, Vpp;54 u_char io_irq;55} socket_state_t;56 57extern socket_state_t dead_socket;58 59/* Socket configuration flags */60#define SS_PWR_AUTO 0x001061#define SS_IOCARD 0x002062#define SS_RESET 0x004063#define SS_DMA_MODE 0x008064#define SS_SPKR_ENA 0x010065#define SS_OUTPUT_ENA 0x020066 67/* Flags for I/O port and memory windows */68#define MAP_ACTIVE 0x0169#define MAP_16BIT 0x0270#define MAP_AUTOSZ 0x0471#define MAP_0WS 0x0872#define MAP_WRPROT 0x1073#define MAP_ATTRIB 0x2074#define MAP_USE_WAIT 0x4075#define MAP_PREFETCH 0x8076 77/* Use this just for bridge windows */78#define MAP_IOSPACE 0x2079 80/* power hook operations */81#define HOOK_POWER_PRE 0x0182#define HOOK_POWER_POST 0x0283 84typedef struct pccard_io_map {85 u_char map;86 u_char flags;87 u_short speed;88 phys_addr_t start, stop;89} pccard_io_map;90 91typedef struct pccard_mem_map {92 u_char map;93 u_char flags;94 u_short speed;95 phys_addr_t static_start;96 u_int card_start;97 struct resource *res;98} pccard_mem_map;99 100typedef struct io_window_t {101 u_int InUse, Config;102 struct resource *res;103} io_window_t;104 105/* Maximum number of IO windows per socket */106#define MAX_IO_WIN 2107 108/* Maximum number of memory windows per socket */109#define MAX_WIN 4110 111 112/*113 * Socket operations.114 */115struct pcmcia_socket;116struct pccard_resource_ops;117struct config_t;118struct pcmcia_callback;119struct user_info_t;120 121struct pccard_operations {122 int (*init)(struct pcmcia_socket *s);123 int (*suspend)(struct pcmcia_socket *s);124 int (*get_status)(struct pcmcia_socket *s, u_int *value);125 int (*set_socket)(struct pcmcia_socket *s, socket_state_t *state);126 int (*set_io_map)(struct pcmcia_socket *s, struct pccard_io_map *io);127 int (*set_mem_map)(struct pcmcia_socket *s, struct pccard_mem_map *mem);128};129 130struct pcmcia_socket {131 struct module *owner;132 socket_state_t socket;133 u_int state;134 u_int suspended_state; /* state before suspend */135 u_short functions;136 u_short lock_count;137 pccard_mem_map cis_mem;138 void __iomem *cis_virt;139 io_window_t io[MAX_IO_WIN];140 pccard_mem_map win[MAX_WIN];141 struct list_head cis_cache;142 size_t fake_cis_len;143 u8 *fake_cis;144 145 struct list_head socket_list;146 struct completion socket_released;147 148 /* deprecated */149 unsigned int sock; /* socket number */150 151 152 /* socket capabilities */153 u_int features;154 u_int irq_mask;155 u_int map_size;156 u_int io_offset;157 u_int pci_irq;158 struct pci_dev *cb_dev;159 160 /* socket setup is done so resources should be able to be allocated.161 * Only if set to 1, calls to find_{io,mem}_region are handled, and162 * insertio events are actually managed by the PCMCIA layer.*/163 u8 resource_setup_done;164 165 /* socket operations */166 struct pccard_operations *ops;167 struct pccard_resource_ops *resource_ops;168 void *resource_data;169 170 /* Zoom video behaviour is so chip specific its not worth adding171 this to _ops */172 void (*zoom_video)(struct pcmcia_socket *,173 int);174 175 /* so is power hook */176 int (*power_hook)(struct pcmcia_socket *sock, int operation);177 178 /* allows tuning the CB bridge before loading driver for the CB card */179#ifdef CONFIG_CARDBUS180 void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);181#endif182 183 /* state thread */184 struct task_struct *thread;185 struct completion thread_done;186 unsigned int thread_events;187 unsigned int sysfs_events;188 189 /* For the non-trivial interaction between these locks,190 * see Documentation/pcmcia/locking.rst */191 struct mutex skt_mutex;192 struct mutex ops_mutex;193 194 /* protects thread_events and sysfs_events */195 spinlock_t thread_lock;196 197 /* pcmcia (16-bit) */198 struct pcmcia_callback *callback;199 200#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)201 /* The following elements refer to 16-bit PCMCIA devices inserted202 * into the socket */203 struct list_head devices_list;204 205 /* the number of devices, used only internally and subject to206 * incorrectness and change */207 u8 device_count;208 209 /* does the PCMCIA card consist of two pseudo devices? */210 u8 pcmcia_pfc;211 212 /* non-zero if PCMCIA card is present */213 atomic_t present;214 215 /* IRQ to be used by PCMCIA devices. May not be IRQ 0. */216 unsigned int pcmcia_irq;217 218#endif /* CONFIG_PCMCIA */219 220 /* socket device */221 struct device dev;222 /* data internal to the socket driver */223 void *driver_data;224 /* status of the card during resume from a system sleep state */225 int resume_status;226};227 228 229/* socket drivers must define the resource operations type they use. There230 * are three options:231 * - pccard_static_ops iomem and ioport areas are assigned statically232 * - pccard_iodyn_ops iomem areas is assigned statically, ioport233 * areas dynamically234 * If this option is selected, use235 * "select PCCARD_IODYN" in Kconfig.236 * - pccard_nonstatic_ops iomem and ioport areas are assigned dynamically.237 * If this option is selected, use238 * "select PCCARD_NONSTATIC" in Kconfig.239 *240 */241extern struct pccard_resource_ops pccard_static_ops;242#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)243extern struct pccard_resource_ops pccard_iodyn_ops;244extern struct pccard_resource_ops pccard_nonstatic_ops;245#else246/* If PCMCIA is not used, but only CARDBUS, these functions are not used247 * at all. Therefore, do not use the large (240K!) rsrc_nonstatic module248 */249#define pccard_iodyn_ops pccard_static_ops250#define pccard_nonstatic_ops pccard_static_ops251#endif252 253 254/* socket drivers use this callback in their IRQ handler */255extern void pcmcia_parse_events(struct pcmcia_socket *socket,256 unsigned int events);257 258/* to register and unregister a socket */259extern int pcmcia_register_socket(struct pcmcia_socket *socket);260extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);261 262 263#endif /* _LINUX_SS_H */264