SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/pcmcia/ds.h

   1 /*
   2  * ds.h -- 16-bit PCMCIA core support
   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  * (C) 2003 - 2008      Dominik Brodowski
  14  */
  15
  16 #ifndef _LINUX_DS_H
  17 #define _LINUX_DS_H
  18
  19 #ifdef __KERNEL__
  20 #include <linux/mod_devicetable.h>
  21 #endif
  22
  23 #include <pcmcia/cs_types.h>
  24 #include <pcmcia/device_id.h>
  25
  26 #ifdef __KERNEL__
  27 #include <linux/device.h>
  28 #include <pcmcia/ss.h>
  29
  30 /*
  31  * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
  32  * a.k.a. PCI drivers
  33  */
  34 struct pcmcia_socket;
  35 struct pcmcia_device;
  36 struct config_t;
  37
  38 /* dynamic device IDs for PCMCIA device drivers. See
  39  * Documentation/pcmcia/driver.txt for details.
  40 */
  41 struct pcmcia_dynids {
  42         spinlock_t              lock;
  43         struct list_head        list;
  44 };
  45
  46 struct pcmcia_driver {
  47         int (*probe)            (struct pcmcia_device *dev);
  48         void (*remove)          (struct pcmcia_device *dev);
  49
  50         int (*suspend)          (struct pcmcia_device *dev);
  51         int (*resume)           (struct pcmcia_device *dev);
  52
  53         struct module           *owner;
  54         struct pcmcia_device_id *id_table;
  55         struct device_driver    drv;
  56         struct pcmcia_dynids    dynids;
  57 };
  58
  59 /* driver registration */
  60 int pcmcia_register_driver(struct pcmcia_driver *driver);
  61 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
  62
  63 /* Some drivers use dev_node_t to store char or block device information.
  64  * Don't use this in new drivers, though.
  65  */
  66 typedef struct dev_node_t {
  67         char                    dev_name[DEV_NAME_LEN];
  68         u_short                 major, minor;
  69         struct dev_node_t       *next;
  70 } dev_node_t;
  71
  72 struct pcmcia_device {
  73         /* the socket and the device_no [for multifunction devices]
  74            uniquely define a pcmcia_device */
  75         struct pcmcia_socket    *socket;
  76
  77         char                    *devname;
  78
  79         u8                      device_no;
  80
  81         /* the hardware "function" device; certain subdevices can
  82          * share one hardware "function" device. */
  83         u8                      func;
  84         struct config_t*        function_config;
  85
  86         struct list_head        socket_device_list;
  87
  88         /* deprecated, will be cleaned up soon */
  89         dev_node_t              *dev_node;
  90         u_int                   open;
  91         io_req_t                io;
  92         irq_req_t               irq;
  93         config_req_t            conf;
  94         window_handle_t         win;
  95
  96         /* Is the device suspended, or in the process of
  97          * being removed? */
  98         u16                     suspended:1;
  99         u16                     _removed:1;
 100
 101         /* Flags whether io, irq, win configurations were
 102          * requested, and whether the configuration is "locked" */
 103         u16                     _irq:1;
 104         u16                     _io:1;
 105         u16                     _win:4;
 106         u16                     _locked:1;
 107
 108         /* Flag whether a "fuzzy" func_id based match is
 109          * allowed. */
 110         u16                     allow_func_id_match:1;
 111
 112         /* information about this device */
 113         u16                     has_manf_id:1;
 114         u16                     has_card_id:1;
 115         u16                     has_func_id:1;
 116
 117         u16                     reserved:3;
 118
 119         u8                      func_id;
 120         u16                     manf_id;
 121         u16                     card_id;
 122
 123         char *                  prod_id[4];
 124
 125         u64                     dma_mask;
 126         struct device           dev;
 127
 128 #ifdef CONFIG_PCMCIA_IOCTL
 129         /* device driver wanted by cardmgr */
 130         struct pcmcia_driver *  cardmgr;
 131 #endif
 132
 133         /* data private to drivers */
 134         void                    *priv;
 135 };
 136
 137 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
 138 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
 139
 140 /* deprecated -- don't use! */
 141 #define handle_to_dev(handle) (handle->dev)
 142
 143
 144 /* (deprecated) error reporting by PCMCIA devices. Use dev_printk()
 145  * or dev_dbg() directly in the driver, without referring to pcmcia_error_func()
 146  * and/or pcmcia_error_ret() for those functions will go away soon.
 147  */
 148
 149 const char *pcmcia_error_func(int func);
 150 const char *pcmcia_error_ret(int ret);
 151
 152 #define cs_error(p_dev, func, ret)                      \
 153         {                                               \
 154                 dev_printk(KERN_NOTICE, &p_dev->dev,    \
 155                            "%s : %s\n",                 \
 156                            pcmcia_error_func(func),     \
 157                            pcmcia_error_ret(ret));      \
 158         }
 159
 160
 161 #endif /* __KERNEL__ */
 162
 163
 164
 165 /* Below, there are only definitions which are used by
 166  * - the PCMCIA ioctl
 167  * - deprecated PCMCIA userspace tools only
 168  *
 169  * here be dragons ... here be dragons ... here be dragons ... here be drag
 170  */
 171
 172 #if defined(CONFIG_PCMCIA_IOCTL) || !defined(__KERNEL__)
 173
 174 #if defined(__arm__) || defined(__mips__) || defined(__avr32__) || \
 175         defined(__bfin__)
 176 /* This (ioaddr_t) is exposed to userspace & hence cannot be changed. */
 177 typedef u_int   ioaddr_t;
 178 #else
 179 typedef u_short ioaddr_t;
 180 #endif
 181
 182 /* for AdjustResourceInfo */
 183 typedef struct adjust_t {
 184         u_int                   Action;
 185         u_int                   Resource;
 186         u_int                   Attributes;
 187         union {
 188                 struct memory {
 189                         u_long          Base;
 190                         u_long          Size;
 191                 } memory;
 192                 struct io {
 193                         ioaddr_t        BasePort;
 194                         ioaddr_t        NumPorts;
 195                         u_int           IOAddrLines;
 196                 } io;
 197                 struct irq {
 198                         u_int           IRQ;
 199                 } irq;
 200         } resource;
 201 } adjust_t;
 202
 203 /* Action field */
 204 #define REMOVE_MANAGED_RESOURCE         1
 205 #define ADD_MANAGED_RESOURCE            2
 206 #define GET_FIRST_MANAGED_RESOURCE      3
 207 #define GET_NEXT_MANAGED_RESOURCE       4
 208 /* Resource field */
 209 #define RES_MEMORY_RANGE                1
 210 #define RES_IO_RANGE                    2
 211 #define RES_IRQ                         3
 212 /* Attribute field */
 213 #define RES_IRQ_TYPE                    0x03
 214 #define RES_IRQ_TYPE_EXCLUSIVE          0
 215 #define RES_IRQ_TYPE_TIME               1
 216 #define RES_IRQ_TYPE_DYNAMIC            2
 217 #define RES_IRQ_CSC                     0x04
 218 #define RES_SHARED                      0x08
 219 #define RES_RESERVED                    0x10
 220 #define RES_ALLOCATED                   0x20
 221 #define RES_REMOVED                     0x40
 222
 223
 224 typedef struct tuple_parse_t {
 225         tuple_t                 tuple;
 226         cisdata_t               data[255];
 227         cisparse_t              parse;
 228 } tuple_parse_t;
 229
 230 typedef struct win_info_t {
 231         window_handle_t         handle;
 232         win_req_t               window;
 233         memreq_t                map;
 234 } win_info_t;
 235
 236 typedef struct bind_info_t {
 237         dev_info_t              dev_info;
 238         u_char                  function;
 239         struct pcmcia_device    *instance;
 240         char                    name[DEV_NAME_LEN];
 241         u_short                 major, minor;
 242         void                    *next;
 243 } bind_info_t;
 244
 245 typedef struct mtd_info_t {
 246         dev_info_t              dev_info;
 247         u_int                   Attributes;
 248         u_int                   CardOffset;
 249 } mtd_info_t;
 250
 251 typedef struct region_info_t {
 252         u_int                   Attributes;
 253         u_int                   CardOffset;
 254         u_int                   RegionSize;
 255         u_int                   AccessSpeed;
 256         u_int                   BlockSize;
 257         u_int                   PartMultiple;
 258         u_char                  JedecMfr, JedecInfo;
 259         memory_handle_t         next;
 260 } region_info_t;
 261
 262 #define REGION_TYPE             0x0001
 263 #define REGION_TYPE_CM          0x0000
 264 #define REGION_TYPE_AM          0x0001
 265 #define REGION_PREFETCH         0x0008
 266 #define REGION_CACHEABLE        0x0010
 267 #define REGION_BAR_MASK         0xe000
 268 #define REGION_BAR_SHIFT        13
 269
 270 /* For ReplaceCIS */
 271 typedef struct cisdump_t {
 272         u_int                   Length;
 273         cisdata_t               Data[CISTPL_MAX_CIS_SIZE];
 274 } cisdump_t;
 275
 276 /* for GetConfigurationInfo */
 277 typedef struct config_info_t {
 278         u_char                  Function;
 279         u_int                   Attributes;
 280         u_int                   Vcc, Vpp1, Vpp2;
 281         u_int                   IntType;
 282         u_int                   ConfigBase;
 283         u_char                  Status, Pin, Copy, Option, ExtStatus;
 284         u_int                   Present;
 285         u_int                   CardValues;
 286         u_int                   AssignedIRQ;
 287         u_int                   IRQAttributes;
 288         ioaddr_t                BasePort1;
 289         ioaddr_t                NumPorts1;
 290         u_int                   Attributes1;
 291         ioaddr_t                BasePort2;
 292         ioaddr_t                NumPorts2;
 293         u_int                   Attributes2;
 294         u_int                   IOAddrLines;
 295 } config_info_t;
 296
 297 typedef union ds_ioctl_arg_t {
 298         adjust_t                adjust;
 299         config_info_t           config;
 300         tuple_t                 tuple;
 301         tuple_parse_t           tuple_parse;
 302         client_req_t            client_req;
 303         cs_status_t             status;
 304         conf_reg_t              conf_reg;
 305         cisinfo_t               cisinfo;
 306         region_info_t           region;
 307         bind_info_t             bind_info;
 308         mtd_info_t              mtd_info;
 309         win_info_t              win_info;
 310         cisdump_t               cisdump;
 311 } ds_ioctl_arg_t;
 312
 313 #define DS_ADJUST_RESOURCE_INFO                 _IOWR('d',  2, adjust_t)
 314 #define DS_GET_CONFIGURATION_INFO               _IOWR('d',  3, config_info_t)
 315 #define DS_GET_FIRST_TUPLE                      _IOWR('d',  4, tuple_t)
 316 #define DS_GET_NEXT_TUPLE                       _IOWR('d',  5, tuple_t)
 317 #define DS_GET_TUPLE_DATA                       _IOWR('d',  6, tuple_parse_t)
 318 #define DS_PARSE_TUPLE                          _IOWR('d',  7, tuple_parse_t)
 319 #define DS_RESET_CARD                           _IO  ('d',  8)
 320 #define DS_GET_STATUS                           _IOWR('d',  9, cs_status_t)
 321 #define DS_ACCESS_CONFIGURATION_REGISTER        _IOWR('d', 10, conf_reg_t)
 322 #define DS_VALIDATE_CIS                         _IOR ('d', 11, cisinfo_t)
 323 #define DS_SUSPEND_CARD                         _IO  ('d', 12)
 324 #define DS_RESUME_CARD                          _IO  ('d', 13)
 325 #define DS_EJECT_CARD                           _IO  ('d', 14)
 326 #define DS_INSERT_CARD                          _IO  ('d', 15)
 327 #define DS_GET_FIRST_REGION                     _IOWR('d', 16, region_info_t)
 328 #define DS_GET_NEXT_REGION                      _IOWR('d', 17, region_info_t)
 329 #define DS_REPLACE_CIS                          _IOWR('d', 18, cisdump_t)
 330 #define DS_GET_FIRST_WINDOW                     _IOR ('d', 19, win_info_t)
 331 #define DS_GET_NEXT_WINDOW                      _IOWR('d', 20, win_info_t)
 332 #define DS_GET_MEM_PAGE                         _IOWR('d', 21, win_info_t)
 333
 334 #define DS_BIND_REQUEST                         _IOWR('d', 60, bind_info_t)
 335 #define DS_GET_DEVICE_INFO                      _IOWR('d', 61, bind_info_t)
 336 #define DS_GET_NEXT_DEVICE                      _IOWR('d', 62, bind_info_t)
 337 #define DS_UNBIND_REQUEST                       _IOW ('d', 63, bind_info_t)
 338 #define DS_BIND_MTD                             _IOWR('d', 64, mtd_info_t)
 339
 340
 341 /* used in userspace only */
 342 #define CS_IN_USE                       0x1e
 343
 344
 345 #endif /* !defined(__KERNEL__) || defined(CONFIG_PCMCIA_IOCTL) */
 346
 347 #endif /* _LINUX_DS_H */