include/pcmcia/ss.h

   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 typedef struct pccard_io_map {
  90         u_char  map;
  91         u_char  flags;
  92         u_short speed;
  93         phys_addr_t start, stop;
  94 } pccard_io_map;
  95
  96 typedef struct pccard_mem_map {
  97         u_char          map;
  98         u_char          flags;
  99         u_short         speed;
 100         phys_addr_t     static_start;
 101         u_int           card_start;
 102         struct resource *res;
 103 } pccard_mem_map;
 104
 105 typedef struct io_window_t {
 106         u_int                   InUse, Config;
 107         struct resource         *res;
 108 } io_window_t;
 109
 110 /* Maximum number of IO windows per socket */
 111 #define MAX_IO_WIN 2
 112
 113 /* Maximum number of memory windows per socket */
 114 #define MAX_WIN 4
 115
 116
 117 /*
 118  * Socket operations.
 119  */
 120 struct pcmcia_socket;
 121 struct pccard_resource_ops;
 122 struct config_t;
 123 struct pcmcia_callback;
 124 struct user_info_t;
 125
 126 struct pccard_operations {
 127         int (*init)(struct pcmcia_socket *s);
 128         int (*suspend)(struct pcmcia_socket *s);
 129         int (*get_status)(struct pcmcia_socket *s, u_int *value);
 130         int (*set_socket)(struct pcmcia_socket *s, socket_state_t *state);
 131         int (*set_io_map)(struct pcmcia_socket *s, struct pccard_io_map *io);
 132         int (*set_mem_map)(struct pcmcia_socket *s, struct pccard_mem_map *mem);
 133 };
 134
 135 struct pcmcia_socket {
 136         struct module                   *owner;
 137         socket_state_t                  socket;
 138         u_int                           state;
 139         u_int                           suspended_state;        /* state before suspend */
 140         u_short                         functions;
 141         u_short                         lock_count;
 142         pccard_mem_map                  cis_mem;
 143         void __iomem                    *cis_virt;
 144         struct {
 145                 u_int                   AssignedIRQ;
 146                 u_int                   Config;
 147         } irq;
 148         io_window_t                     io[MAX_IO_WIN];
 149         pccard_mem_map                  win[MAX_WIN];
 150         struct list_head                cis_cache;
 151         size_t                          fake_cis_len;
 152         u8                              *fake_cis;
 153
 154         struct list_head                socket_list;
 155         struct completion               socket_released;
 156
 157         /* deprecated */
 158         unsigned int                    sock;           /* socket number */
 159
 160
 161         /* socket capabilities */
 162         u_int                           features;
 163         u_int                           irq_mask;
 164         u_int                           map_size;
 165         u_int                           io_offset;
 166         u_int                           pci_irq;
 167         struct pci_dev                  *cb_dev;
 168
 169
 170         /* socket setup is done so resources should be able to be allocated.
 171          * Only if set to 1, calls to find_{io,mem}_region are handled, and
 172          * insertio events are actually managed by the PCMCIA layer.*/
 173         u8                              resource_setup_done:1;
 174
 175         /* It's old if resource setup is done using adjust_resource_info() */
 176         u8                              resource_setup_old:1;
 177         u8                              resource_setup_new:1;
 178
 179         u8                              reserved:5;
 180
 181         /* socket operations */
 182         struct pccard_operations        *ops;
 183         struct pccard_resource_ops      *resource_ops;
 184         void                            *resource_data;
 185
 186         /* Zoom video behaviour is so chip specific its not worth adding
 187            this to _ops */
 188         void                            (*zoom_video)(struct pcmcia_socket *,
 189                                                       int);
 190
 191         /* so is power hook */
 192         int (*power_hook)(struct pcmcia_socket *sock, int operation);
 193
 194         /* allows tuning the CB bridge before loading driver for the CB card */
 195 #ifdef CONFIG_CARDBUS
 196         void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);
 197 #endif
 198
 199         /* state thread */
 200         struct task_struct              *thread;
 201         struct completion               thread_done;
 202         unsigned int                    thread_events;
 203         unsigned int                    sysfs_events;
 204
 205         /* For the non-trivial interaction between these locks,
 206          * see Documentation/pcmcia/locking.txt */
 207         struct mutex                    skt_mutex;
 208         struct mutex                    ops_mutex;
 209
 210         /* protects thread_events and sysfs_events */
 211         spinlock_t                      thread_lock;
 212
 213         /* pcmcia (16-bit) */
 214         struct pcmcia_callback          *callback;
 215
 216 #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
 217         /* The following elements refer to 16-bit PCMCIA devices inserted
 218          * into the socket */
 219         struct list_head                devices_list;
 220
 221         /* the number of devices, used only internally and subject to
 222          * incorrectness and change */
 223         u8                              device_count;
 224
 225         /* 16-bit state: */
 226         struct {
 227                 /* PCMCIA card is present in socket */
 228                 u8                      present:1;
 229                 /* "master" ioctl is used */
 230                 u8                      busy:1;
 231                 /* pcmcia module is being unloaded */
 232                 u8                      dead:1;
 233                 /* the PCMCIA card consists of two pseudo devices */
 234                 u8                      has_pfc:1;
 235
 236                 u8                      reserved:4;
 237         } pcmcia_state;
 238
 239
 240 #ifdef CONFIG_PCMCIA_IOCTL
 241         struct user_info_t              *user;
 242         wait_queue_head_t               queue;
 243 #endif /* CONFIG_PCMCIA_IOCTL */
 244 #endif /* CONFIG_PCMCIA */
 245
 246         /* socket device */
 247         struct device                   dev;
 248         /* data internal to the socket driver */
 249         void                            *driver_data;
 250         /* status of the card during resume from a system sleep state */
 251         int                             resume_status;
 252 };
 253
 254
 255 /* socket drivers must define the resource operations type they use. There
 256  * are three options:
 257  * - pccard_static_ops          iomem and ioport areas are assigned statically
 258  * - pccard_iodyn_ops           iomem areas is assigned statically, ioport
 259  *                              areas dynamically
 260  *                              If this option is selected, use
 261  *                              "select PCCARD_IODYN" in Kconfig.
 262  * - pccard_nonstatic_ops       iomem and ioport areas are assigned dynamically.
 263  *                              If this option is selected, use
 264  *                              "select PCCARD_NONSTATIC" in Kconfig.
 265  *
 266  */
 267 extern struct pccard_resource_ops pccard_static_ops;
 268 #if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
 269 extern struct pccard_resource_ops pccard_iodyn_ops;
 270 extern struct pccard_resource_ops pccard_nonstatic_ops;
 271 #else
 272 /* If PCMCIA is not used, but only CARDBUS, these functions are not used
 273  * at all. Therefore, do not use the large (240K!) rsrc_nonstatic module
 274  */
 275 #define pccard_iodyn_ops pccard_static_ops
 276 #define pccard_nonstatic_ops pccard_static_ops
 277 #endif
 278
 279
 280 /* socket drivers are expected to use these callbacks in their .drv struct */
 281 extern int pcmcia_socket_dev_suspend(struct device *dev);
 282 extern void pcmcia_socket_dev_early_resume(struct device *dev);
 283 extern void pcmcia_socket_dev_late_resume(struct device *dev);
 284 extern int pcmcia_socket_dev_resume(struct device *dev);
 285
 286 /* socket drivers use this callback in their IRQ handler */
 287 extern void pcmcia_parse_events(struct pcmcia_socket *socket,
 288                                 unsigned int events);
 289
 290 /* to register and unregister a socket */
 291 extern int pcmcia_register_socket(struct pcmcia_socket *socket);
 292 extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);
 293
 294
 295 #endif /* _LINUX_SS_H */