Pileus Git - ~andy/linux/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 struct pcmcia_device {
  66         /* the socket and the device_no [for multifunction devices]
  67            uniquely define a pcmcia_device */
  68         struct pcmcia_socket    *socket;
  69
  70         char                    *devname;
  71
  72         u8                      device_no;
  73
  74         /* the hardware "function" device; certain subdevices can
  75          * share one hardware "function" device. */
  76         u8                      func;
  77         struct config_t         *function_config;
  78
  79         struct list_head        socket_device_list;
  80
  81         /* deprecated, will be cleaned up soon */
  82         u_int                   open;
  83         io_req_t                io;
  84         config_req_t            conf;
  85         window_handle_t         win;
  86
  87         /* device setup */
  88         unsigned int            irq;
  89
  90         /* Is the device suspended? */
  91         u16                     suspended:1;
  92
  93         /* Flags whether io, irq, win configurations were
  94          * requested, and whether the configuration is "locked" */
  95         u16                     _irq:1;
  96         u16                     _io:1;
  97         u16                     _win:4;
  98         u16                     _locked:1;
  99
 100         /* Flag whether a "fuzzy" func_id based match is
 101          * allowed. */
 102         u16                     allow_func_id_match:1;
 103
 104         /* information about this device */
 105         u16                     has_manf_id:1;
 106         u16                     has_card_id:1;
 107         u16                     has_func_id:1;
 108
 109         u16                     reserved:4;
 110
 111         u8                      func_id;
 112         u16                     manf_id;
 113         u16                     card_id;
 114
 115         char                    *prod_id[4];
 116
 117         u64                     dma_mask;
 118         struct device           dev;
 119
 120         /* data private to drivers */
 121         void                    *priv;
 122 };
 123
 124 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
 125 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
 126
 127
 128 /*
 129  * CIS access.
 130  *
 131  * Please use the following functions to access CIS tuples:
 132  * - pcmcia_get_tuple()
 133  * - pcmcia_loop_tuple()
 134  * - pcmcia_get_mac_from_cis()
 135  *
 136  * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
 137  * might change in future.
 138  */
 139
 140 /* get the very first CIS entry of type @code. Note that buf is pointer
 141  * to u8 *buf; and that you need to kfree(buf) afterwards. */
 142 size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
 143                         u8 **buf);
 144
 145 /* loop over CIS entries */
 146 int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
 147                       int (*loop_tuple) (struct pcmcia_device *p_dev,
 148                                          tuple_t *tuple,
 149                                          void *priv_data),
 150                       void *priv_data);
 151
 152 /* get the MAC address from CISTPL_FUNCE */
 153 int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
 154                             struct net_device *dev);
 155
 156
 157 /* parse a tuple_t */
 158 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
 159
 160 /* loop CIS entries for valid configuration */
 161 int pcmcia_loop_config(struct pcmcia_device *p_dev,
 162                        int      (*conf_check)   (struct pcmcia_device *p_dev,
 163                                                  cistpl_cftable_entry_t *cf,
 164                                                  cistpl_cftable_entry_t *dflt,
 165                                                  unsigned int vcc,
 166                                                  void *priv_data),
 167                        void *priv_data);
 168
 169 /* is the device still there? */
 170 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
 171
 172 /* low-level interface reset */
 173 int pcmcia_reset_card(struct pcmcia_socket *skt);
 174
 175 /* CIS config */
 176 int pcmcia_access_configuration_register(struct pcmcia_device *p_dev,
 177                                          conf_reg_t *reg);
 178
 179 /* device configuration */
 180 int pcmcia_request_io(struct pcmcia_device *p_dev, io_req_t *req);
 181
 182 int __must_check
 183 __pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
 184                                 irq_handler_t handler);
 185 static inline __must_check __deprecated int
 186 pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
 187                                 irq_handler_t handler)
 188 {
 189         return __pcmcia_request_exclusive_irq(p_dev, handler);
 190 }
 191
 192 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
 193                                 irq_handler_t handler);
 194
 195 int pcmcia_request_configuration(struct pcmcia_device *p_dev,
 196                                  config_req_t *req);
 197
 198 int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req,
 199                           window_handle_t *wh);
 200 int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win);
 201 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win,
 202                         memreq_t *req);
 203
 204 int pcmcia_modify_configuration(struct pcmcia_device *p_dev, modconf_t *mod);
 205 void pcmcia_disable_device(struct pcmcia_device *p_dev);
 206
 207 #endif /* __KERNEL__ */
 208
 209 #endif /* _LINUX_DS_H */