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 #include <asm/atomic.h>
  30
  31 /*
  32  * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
  33  * a.k.a. PCI drivers
  34  */
  35 struct pcmcia_socket;
  36 struct pcmcia_device;
  37 struct config_t;
  38 struct net_device;
  39
  40 /* dynamic device IDs for PCMCIA device drivers. See
  41  * Documentation/pcmcia/driver.txt for details.
  42 */
  43 struct pcmcia_dynids {
  44         struct mutex            lock;
  45         struct list_head        list;
  46 };
  47
  48 struct pcmcia_driver {
  49         int (*probe)            (struct pcmcia_device *dev);
  50         void (*remove)          (struct pcmcia_device *dev);
  51
  52         int (*suspend)          (struct pcmcia_device *dev);
  53         int (*resume)           (struct pcmcia_device *dev);
  54
  55         struct module           *owner;
  56         struct pcmcia_device_id *id_table;
  57         struct device_driver    drv;
  58         struct pcmcia_dynids    dynids;
  59 };
  60
  61 /* driver registration */
  62 int pcmcia_register_driver(struct pcmcia_driver *driver);
  63 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
  64
  65 /* Some drivers use dev_node_t to store char or block device information.
  66  * Don't use this in new drivers, though.
  67  */
  68 typedef struct dev_node_t {
  69         char                    dev_name[DEV_NAME_LEN];
  70         u_short                 major, minor;
  71         struct dev_node_t       *next;
  72 } dev_node_t;
  73
  74 struct pcmcia_device {
  75         /* the socket and the device_no [for multifunction devices]
  76            uniquely define a pcmcia_device */
  77         struct pcmcia_socket    *socket;
  78
  79         char                    *devname;
  80
  81         u8                      device_no;
  82
  83         /* the hardware "function" device; certain subdevices can
  84          * share one hardware "function" device. */
  85         u8                      func;
  86         struct config_t         *function_config;
  87
  88         struct list_head        socket_device_list;
  89
  90         /* deprecated, will be cleaned up soon */
  91         dev_node_t              *dev_node;
  92         u_int                   open;
  93         io_req_t                io;
  94         config_req_t            conf;
  95         window_handle_t         win;
  96
  97         /* device setup */
  98         unsigned int            irq;
  99
 100         /* Is the device suspended? */
 101         u16                     suspended:1;
 102
 103         /* Flags whether io, irq, win configurations were
 104          * requested, and whether the configuration is "locked" */
 105         u16                     _irq:1;
 106         u16                     _io:1;
 107         u16                     _win:4;
 108         u16                     _locked:1;
 109
 110         /* Flag whether a "fuzzy" func_id based match is
 111          * allowed. */
 112         u16                     allow_func_id_match:1;
 113
 114         /* information about this device */
 115         u16                     has_manf_id:1;
 116         u16                     has_card_id:1;
 117         u16                     has_func_id:1;
 118
 119         u16                     reserved:4;
 120
 121         u8                      func_id;
 122         u16                     manf_id;
 123         u16                     card_id;
 124
 125         char                    *prod_id[4];
 126
 127         u64                     dma_mask;
 128         struct device           dev;
 129
 130 #ifdef CONFIG_PCMCIA_IOCTL
 131         /* device driver wanted by cardmgr */
 132         struct pcmcia_driver    *cardmgr;
 133 #endif
 134
 135         /* data private to drivers */
 136         void                    *priv;
 137 };
 138
 139 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
 140 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
 141
 142
 143 /*
 144  * CIS access.
 145  *
 146  * Please use the following functions to access CIS tuples:
 147  * - pcmcia_get_tuple()
 148  * - pcmcia_loop_tuple()
 149  * - pcmcia_get_mac_from_cis()
 150  *
 151  * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
 152  * might change in future.
 153  */
 154
 155 /* get the very first CIS entry of type @code. Note that buf is pointer
 156  * to u8 *buf; and that you need to kfree(buf) afterwards. */
 157 size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
 158                         u8 **buf);
 159
 160 /* loop over CIS entries */
 161 int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
 162                       int (*loop_tuple) (struct pcmcia_device *p_dev,
 163                                          tuple_t *tuple,
 164                                          void *priv_data),
 165                       void *priv_data);
 166
 167 /* get the MAC address from CISTPL_FUNCE */
 168 int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
 169                             struct net_device *dev);
 170
 171
 172 /* parse a tuple_t */
 173 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
 174
 175 /* loop CIS entries for valid configuration */
 176 int pcmcia_loop_config(struct pcmcia_device *p_dev,
 177                        int      (*conf_check)   (struct pcmcia_device *p_dev,
 178                                                  cistpl_cftable_entry_t *cf,
 179                                                  cistpl_cftable_entry_t *dflt,
 180                                                  unsigned int vcc,
 181                                                  void *priv_data),
 182                        void *priv_data);
 183
 184 /* is the device still there? */
 185 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
 186
 187 /* low-level interface reset */
 188 int pcmcia_reset_card(struct pcmcia_socket *skt);
 189
 190 /* CIS config */
 191 int pcmcia_access_configuration_register(struct pcmcia_device *p_dev,
 192                                          conf_reg_t *reg);
 193
 194 /* device configuration */
 195 int pcmcia_request_io(struct pcmcia_device *p_dev, io_req_t *req);
 196
 197 int __must_check __deprecated
 198 pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
 199                                 irq_handler_t handler);
 200 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
 201                                 irq_handler_t handler);
 202
 203 int pcmcia_request_configuration(struct pcmcia_device *p_dev,
 204                                  config_req_t *req);
 205
 206 int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req,
 207                           window_handle_t *wh);
 208 int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win);
 209 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win,
 210                         memreq_t *req);
 211
 212 int pcmcia_modify_configuration(struct pcmcia_device *p_dev, modconf_t *mod);
 213 void pcmcia_disable_device(struct pcmcia_device *p_dev);
 214
 215 #endif /* __KERNEL__ */
 216
 217
 218
 219 /* Below, there are only definitions which are used by
 220  * - the PCMCIA ioctl
 221  * - deprecated PCMCIA userspace tools only
 222  *
 223  * here be dragons ... here be dragons ... here be dragons ... here be drag
 224  */
 225
 226 #if defined(CONFIG_PCMCIA_IOCTL) || !defined(__KERNEL__)
 227
 228 #if defined(__arm__) || defined(__mips__) || defined(__avr32__) || \
 229         defined(__bfin__)
 230 /* This (ioaddr_t) is exposed to userspace & hence cannot be changed. */
 231 typedef u_int   ioaddr_t;
 232 #else
 233 typedef u_short ioaddr_t;
 234 #endif
 235
 236 /* for AdjustResourceInfo */
 237 typedef struct adjust_t {
 238         u_int                   Action;
 239         u_int                   Resource;
 240         u_int                   Attributes;
 241         union {
 242                 struct memory {
 243                         u_long          Base;
 244                         u_long          Size;
 245                 } memory;
 246                 struct io {
 247                         ioaddr_t        BasePort;
 248                         ioaddr_t        NumPorts;
 249                         u_int           IOAddrLines;
 250                 } io;
 251                 struct irq {
 252                         u_int           IRQ;
 253                 } irq;
 254         } resource;
 255 } adjust_t;
 256
 257 /* Action field */
 258 #define REMOVE_MANAGED_RESOURCE         1
 259 #define ADD_MANAGED_RESOURCE            2
 260 #define GET_FIRST_MANAGED_RESOURCE      3
 261 #define GET_NEXT_MANAGED_RESOURCE       4
 262 /* Resource field */
 263 #define RES_MEMORY_RANGE                1
 264 #define RES_IO_RANGE                    2
 265 #define RES_IRQ                         3
 266 /* Attribute field */
 267 #define RES_IRQ_TYPE                    0x03
 268 #define RES_IRQ_TYPE_EXCLUSIVE          0
 269 #define RES_IRQ_TYPE_TIME               1
 270 #define RES_IRQ_TYPE_DYNAMIC            2
 271 #define RES_IRQ_CSC                     0x04
 272 #define RES_SHARED                      0x08
 273 #define RES_RESERVED                    0x10
 274 #define RES_ALLOCATED                   0x20
 275 #define RES_REMOVED                     0x40
 276
 277
 278 typedef struct tuple_parse_t {
 279         tuple_t                 tuple;
 280         cisdata_t               data[255];
 281         cisparse_t              parse;
 282 } tuple_parse_t;
 283
 284 typedef struct win_info_t {
 285         window_handle_t         handle;
 286         win_req_t               window;
 287         memreq_t                map;
 288 } win_info_t;
 289
 290 typedef struct bind_info_t {
 291         dev_info_t              dev_info;
 292         u_char                  function;
 293         struct pcmcia_device    *instance;
 294         char                    name[DEV_NAME_LEN];
 295         u_short                 major, minor;
 296         void                    *next;
 297 } bind_info_t;
 298
 299 typedef struct mtd_info_t {
 300         dev_info_t              dev_info;
 301         u_int                   Attributes;
 302         u_int                   CardOffset;
 303 } mtd_info_t;
 304
 305 typedef struct region_info_t {
 306         u_int                   Attributes;
 307         u_int                   CardOffset;
 308         u_int                   RegionSize;
 309         u_int                   AccessSpeed;
 310         u_int                   BlockSize;
 311         u_int                   PartMultiple;
 312         u_char                  JedecMfr, JedecInfo;
 313         memory_handle_t         next;
 314 } region_info_t;
 315
 316 #define REGION_TYPE             0x0001
 317 #define REGION_TYPE_CM          0x0000
 318 #define REGION_TYPE_AM          0x0001
 319 #define REGION_PREFETCH         0x0008
 320 #define REGION_CACHEABLE        0x0010
 321 #define REGION_BAR_MASK         0xe000
 322 #define REGION_BAR_SHIFT        13
 323
 324 /* For ReplaceCIS */
 325 typedef struct cisdump_t {
 326         u_int                   Length;
 327         cisdata_t               Data[CISTPL_MAX_CIS_SIZE];
 328 } cisdump_t;
 329
 330 /* for GetConfigurationInfo */
 331 typedef struct config_info_t {
 332         u_char                  Function;
 333         u_int                   Attributes;
 334         u_int                   Vcc, Vpp1, Vpp2;
 335         u_int                   IntType;
 336         u_int                   ConfigBase;
 337         u_char                  Status, Pin, Copy, Option, ExtStatus;
 338         u_int                   Present;
 339         u_int                   CardValues;
 340         u_int                   AssignedIRQ;
 341         u_int                   IRQAttributes;
 342         ioaddr_t                BasePort1;
 343         ioaddr_t                NumPorts1;
 344         u_int                   Attributes1;
 345         ioaddr_t                BasePort2;
 346         ioaddr_t                NumPorts2;
 347         u_int                   Attributes2;
 348         u_int                   IOAddrLines;
 349 } config_info_t;
 350
 351 /* For ValidateCIS */
 352 typedef struct cisinfo_t {
 353         u_int                   Chains;
 354 } cisinfo_t;
 355
 356 typedef struct cs_status_t {
 357         u_char                  Function;
 358         event_t                 CardState;
 359         event_t                 SocketState;
 360 } cs_status_t;
 361
 362 typedef union ds_ioctl_arg_t {
 363         adjust_t                adjust;
 364         config_info_t           config;
 365         tuple_t                 tuple;
 366         tuple_parse_t           tuple_parse;
 367         client_req_t            client_req;
 368         cs_status_t             status;
 369         conf_reg_t              conf_reg;
 370         cisinfo_t               cisinfo;
 371         region_info_t           region;
 372         bind_info_t             bind_info;
 373         mtd_info_t              mtd_info;
 374         win_info_t              win_info;
 375         cisdump_t               cisdump;
 376 } ds_ioctl_arg_t;
 377
 378 #define DS_ADJUST_RESOURCE_INFO                 _IOWR('d',  2, adjust_t)
 379 #define DS_GET_CONFIGURATION_INFO               _IOWR('d',  3, config_info_t)
 380 #define DS_GET_FIRST_TUPLE                      _IOWR('d',  4, tuple_t)
 381 #define DS_GET_NEXT_TUPLE                       _IOWR('d',  5, tuple_t)
 382 #define DS_GET_TUPLE_DATA                       _IOWR('d',  6, tuple_parse_t)
 383 #define DS_PARSE_TUPLE                          _IOWR('d',  7, tuple_parse_t)
 384 #define DS_RESET_CARD                           _IO  ('d',  8)
 385 #define DS_GET_STATUS                           _IOWR('d',  9, cs_status_t)
 386 #define DS_ACCESS_CONFIGURATION_REGISTER        _IOWR('d', 10, conf_reg_t)
 387 #define DS_VALIDATE_CIS                         _IOR ('d', 11, cisinfo_t)
 388 #define DS_SUSPEND_CARD                         _IO  ('d', 12)
 389 #define DS_RESUME_CARD                          _IO  ('d', 13)
 390 #define DS_EJECT_CARD                           _IO  ('d', 14)
 391 #define DS_INSERT_CARD                          _IO  ('d', 15)
 392 #define DS_GET_FIRST_REGION                     _IOWR('d', 16, region_info_t)
 393 #define DS_GET_NEXT_REGION                      _IOWR('d', 17, region_info_t)
 394 #define DS_REPLACE_CIS                          _IOWR('d', 18, cisdump_t)
 395 #define DS_GET_FIRST_WINDOW                     _IOR ('d', 19, win_info_t)
 396 #define DS_GET_NEXT_WINDOW                      _IOWR('d', 20, win_info_t)
 397 #define DS_GET_MEM_PAGE                         _IOWR('d', 21, win_info_t)
 398
 399 #define DS_BIND_REQUEST                         _IOWR('d', 60, bind_info_t)
 400 #define DS_GET_DEVICE_INFO                      _IOWR('d', 61, bind_info_t)
 401 #define DS_GET_NEXT_DEVICE                      _IOWR('d', 62, bind_info_t)
 402 #define DS_UNBIND_REQUEST                       _IOW ('d', 63, bind_info_t)
 403 #define DS_BIND_MTD                             _IOWR('d', 64, mtd_info_t)
 404
 405
 406 /* used in userspace only */
 407 #define CS_IN_USE                       0x1e
 408
 409 #define INFO_MASTER_CLIENT      0x01
 410 #define INFO_IO_CLIENT          0x02
 411 #define INFO_MTD_CLIENT         0x04
 412 #define INFO_MEM_CLIENT         0x08
 413 #define MAX_NUM_CLIENTS         3
 414
 415 #define INFO_CARD_SHARE         0x10
 416 #define INFO_CARD_EXCL          0x20
 417
 418
 419 #endif /* !defined(__KERNEL__) || defined(CONFIG_PCMCIA_IOCTL) */
 420
 421 #endif /* _LINUX_DS_H */