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  * <[email protected]>.  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 - 2004      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 typedef struct tuple_parse_t {
  27     tuple_t             tuple;
  28     cisdata_t           data[255];
  29     cisparse_t          parse;
  30 } tuple_parse_t;
  31
  32 typedef struct win_info_t {
  33     window_handle_t     handle;
  34     win_req_t           window;
  35     memreq_t            map;
  36 } win_info_t;
  37
  38 typedef struct bind_info_t {
  39     dev_info_t          dev_info;
  40     u_char              function;
  41     struct pcmcia_device *instance;
  42     char                name[DEV_NAME_LEN];
  43     u_short             major, minor;
  44     void                *next;
  45 } bind_info_t;
  46
  47 typedef struct mtd_info_t {
  48     dev_info_t          dev_info;
  49     u_int               Attributes;
  50     u_int               CardOffset;
  51 } mtd_info_t;
  52
  53 typedef struct region_info_t {
  54     u_int               Attributes;
  55     u_int               CardOffset;
  56     u_int               RegionSize;
  57     u_int               AccessSpeed;
  58     u_int               BlockSize;
  59     u_int               PartMultiple;
  60     u_char              JedecMfr, JedecInfo;
  61     memory_handle_t     next;
  62 } region_info_t;
  63 #define REGION_TYPE             0x0001
  64 #define REGION_TYPE_CM          0x0000
  65 #define REGION_TYPE_AM          0x0001
  66 #define REGION_PREFETCH         0x0008
  67 #define REGION_CACHEABLE        0x0010
  68 #define REGION_BAR_MASK         0xe000
  69 #define REGION_BAR_SHIFT        13
  70
  71 /* For ReplaceCIS */
  72 typedef struct cisdump_t {
  73     u_int       Length;
  74     cisdata_t   Data[CISTPL_MAX_CIS_SIZE];
  75 } cisdump_t;
  76
  77 /* for GetConfigurationInfo */
  78 typedef struct config_info_t {
  79     u_char      Function;
  80     u_int       Attributes;
  81     u_int       Vcc, Vpp1, Vpp2;
  82     u_int       IntType;
  83     u_int       ConfigBase;
  84     u_char      Status, Pin, Copy, Option, ExtStatus;
  85     u_int       Present;
  86     u_int       CardValues;
  87     u_int       AssignedIRQ;
  88     u_int       IRQAttributes;
  89     ioaddr_t    BasePort1;
  90     ioaddr_t    NumPorts1;
  91     u_int       Attributes1;
  92     ioaddr_t    BasePort2;
  93     ioaddr_t    NumPorts2;
  94     u_int       Attributes2;
  95     u_int       IOAddrLines;
  96 } config_info_t;
  97
  98 typedef union ds_ioctl_arg_t {
  99     adjust_t            adjust;
 100     config_info_t       config;
 101     tuple_t             tuple;
 102     tuple_parse_t       tuple_parse;
 103     client_req_t        client_req;
 104     cs_status_t         status;
 105     conf_reg_t          conf_reg;
 106     cisinfo_t           cisinfo;
 107     region_info_t       region;
 108     bind_info_t         bind_info;
 109     mtd_info_t          mtd_info;
 110     win_info_t          win_info;
 111     cisdump_t           cisdump;
 112 } ds_ioctl_arg_t;
 113
 114 #define DS_ADJUST_RESOURCE_INFO         _IOWR('d', 2, adjust_t)
 115 #define DS_GET_CONFIGURATION_INFO       _IOWR('d', 3, config_info_t)
 116 #define DS_GET_FIRST_TUPLE              _IOWR('d', 4, tuple_t)
 117 #define DS_GET_NEXT_TUPLE               _IOWR('d', 5, tuple_t)
 118 #define DS_GET_TUPLE_DATA               _IOWR('d', 6, tuple_parse_t)
 119 #define DS_PARSE_TUPLE                  _IOWR('d', 7, tuple_parse_t)
 120 #define DS_RESET_CARD                   _IO  ('d', 8)
 121 #define DS_GET_STATUS                   _IOWR('d', 9, cs_status_t)
 122 #define DS_ACCESS_CONFIGURATION_REGISTER _IOWR('d', 10, conf_reg_t)
 123 #define DS_VALIDATE_CIS                 _IOR ('d', 11, cisinfo_t)
 124 #define DS_SUSPEND_CARD                 _IO  ('d', 12)
 125 #define DS_RESUME_CARD                  _IO  ('d', 13)
 126 #define DS_EJECT_CARD                   _IO  ('d', 14)
 127 #define DS_INSERT_CARD                  _IO  ('d', 15)
 128 #define DS_GET_FIRST_REGION             _IOWR('d', 16, region_info_t)
 129 #define DS_GET_NEXT_REGION              _IOWR('d', 17, region_info_t)
 130 #define DS_REPLACE_CIS                  _IOWR('d', 18, cisdump_t)
 131 #define DS_GET_FIRST_WINDOW             _IOR ('d', 19, win_info_t)
 132 #define DS_GET_NEXT_WINDOW              _IOWR('d', 20, win_info_t)
 133 #define DS_GET_MEM_PAGE                 _IOWR('d', 21, win_info_t)
 134
 135 #define DS_BIND_REQUEST                 _IOWR('d', 60, bind_info_t)
 136 #define DS_GET_DEVICE_INFO              _IOWR('d', 61, bind_info_t)
 137 #define DS_GET_NEXT_DEVICE              _IOWR('d', 62, bind_info_t)
 138 #define DS_UNBIND_REQUEST               _IOW ('d', 63, bind_info_t)
 139 #define DS_BIND_MTD                     _IOWR('d', 64, mtd_info_t)
 140
 141 /* used in userspace only */
 142 #define CS_IN_USE                       0x1e
 143
 144 #ifdef __KERNEL__
 145 #include <linux/device.h>
 146 #include <pcmcia/ss.h>
 147
 148 typedef struct dev_node_t {
 149     char                dev_name[DEV_NAME_LEN];
 150     u_short             major, minor;
 151     struct dev_node_t   *next;
 152 } dev_node_t;
 153
 154
 155 struct pcmcia_socket;
 156 struct config_t;
 157
 158 struct pcmcia_dynids {
 159         spinlock_t              lock;
 160         struct list_head        list;
 161 };
 162
 163 struct pcmcia_driver {
 164         int (*probe)            (struct pcmcia_device *dev);
 165         void (*remove)          (struct pcmcia_device *dev);
 166
 167         int (*suspend)          (struct pcmcia_device *dev);
 168         int (*resume)           (struct pcmcia_device *dev);
 169
 170         struct module           *owner;
 171         struct pcmcia_device_id *id_table;
 172         struct device_driver    drv;
 173         struct pcmcia_dynids    dynids;
 174 };
 175
 176 /* driver registration */
 177 int pcmcia_register_driver(struct pcmcia_driver *driver);
 178 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
 179
 180
 181 struct pcmcia_device {
 182         /* the socket and the device_no [for multifunction devices]
 183            uniquely define a pcmcia_device */
 184         struct pcmcia_socket    *socket;
 185
 186         char                    *devname;
 187
 188         u8                      device_no;
 189
 190         /* the hardware "function" device; certain subdevices can
 191          * share one hardware "function" device. */
 192         u8                      func;
 193         struct config_t*        function_config;
 194
 195         struct list_head        socket_device_list;
 196
 197         /* deprecated, will be cleaned up soon */
 198         dev_node_t              *dev_node;
 199         u_int                   open;
 200         io_req_t                io;
 201         irq_req_t               irq;
 202         config_req_t            conf;
 203         window_handle_t         win;
 204
 205         /* Is the device suspended, or in the process of
 206          * being removed? */
 207         u16                     suspended:1;
 208         u16                     _removed:1;
 209
 210         /* Flags whether io, irq, win configurations were
 211          * requested, and whether the configuration is "locked" */
 212         u16                     _irq:1;
 213         u16                     _io:1;
 214         u16                     _win:4;
 215         u16                     _locked:1;
 216
 217         /* Flag whether a "fuzzy" func_id based match is
 218          * allowed. */
 219         u16                     allow_func_id_match:1;
 220
 221         /* information about this device */
 222         u16                     has_manf_id:1;
 223         u16                     has_card_id:1;
 224         u16                     has_func_id:1;
 225
 226         u16                     reserved:3;
 227
 228         u8                      func_id;
 229         u16                     manf_id;
 230         u16                     card_id;
 231
 232         char *                  prod_id[4];
 233
 234         u64                     dma_mask;
 235         struct device           dev;
 236
 237 #ifdef CONFIG_PCMCIA_IOCTL
 238         /* device driver wanted by cardmgr */
 239         struct pcmcia_driver *  cardmgr;
 240 #endif
 241
 242         /* data private to drivers */
 243         void                    *priv;
 244 };
 245
 246 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
 247 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
 248
 249 #define handle_to_dev(handle) (handle->dev)
 250
 251 /* error reporting */
 252
 253 const char *pcmcia_error_func(int func);
 254 const char *pcmcia_error_ret(int ret);
 255
 256 #define cs_error(p_dev, func, ret)                      \
 257         {                                               \
 258                 dev_printk(KERN_NOTICE, &p_dev->dev,    \
 259                            "%s : %s\n",                 \
 260                            pcmcia_error_func(func),     \
 261                            pcmcia_error_ret(ret));      \
 262         }
 263
 264
 265 #endif /* __KERNEL__ */
 266 #endif /* _LINUX_DS_H */