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