7f712df3e2974919e1fc3a7408da9ccaaef4a1cf
[linux-3.10.git] / 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 - 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/bulkmem.h>
24 #include <pcmcia/cs_types.h>
25 #include <pcmcia/device_id.h>
26
27 typedef struct tuple_parse_t {
28     tuple_t             tuple;
29     cisdata_t           data[255];
30     cisparse_t          parse;
31 } tuple_parse_t;
32
33 typedef struct win_info_t {
34     window_handle_t     handle;
35     win_req_t           window;
36     memreq_t            map;
37 } win_info_t;
38     
39 typedef struct bind_info_t {
40     dev_info_t          dev_info;
41     u_char              function;
42     struct dev_link_t   *instance;
43     char                name[DEV_NAME_LEN];
44     u_short             major, minor;
45     void                *next;
46 } bind_info_t;
47
48 typedef struct mtd_info_t {
49     dev_info_t          dev_info;
50     u_int               Attributes;
51     u_int               CardOffset;
52 } mtd_info_t;
53
54 typedef union ds_ioctl_arg_t {
55     adjust_t            adjust;
56     config_info_t       config;
57     tuple_t             tuple;
58     tuple_parse_t       tuple_parse;
59     client_req_t        client_req;
60     cs_status_t         status;
61     conf_reg_t          conf_reg;
62     cisinfo_t           cisinfo;
63     region_info_t       region;
64     bind_info_t         bind_info;
65     mtd_info_t          mtd_info;
66     win_info_t          win_info;
67     cisdump_t           cisdump;
68 } ds_ioctl_arg_t;
69
70 #define DS_ADJUST_RESOURCE_INFO         _IOWR('d', 2, adjust_t)
71 #define DS_GET_CONFIGURATION_INFO       _IOWR('d', 3, config_info_t)
72 #define DS_GET_FIRST_TUPLE              _IOWR('d', 4, tuple_t)
73 #define DS_GET_NEXT_TUPLE               _IOWR('d', 5, tuple_t)
74 #define DS_GET_TUPLE_DATA               _IOWR('d', 6, tuple_parse_t)
75 #define DS_PARSE_TUPLE                  _IOWR('d', 7, tuple_parse_t)
76 #define DS_RESET_CARD                   _IO  ('d', 8)
77 #define DS_GET_STATUS                   _IOWR('d', 9, cs_status_t)
78 #define DS_ACCESS_CONFIGURATION_REGISTER _IOWR('d', 10, conf_reg_t)
79 #define DS_VALIDATE_CIS                 _IOR ('d', 11, cisinfo_t)
80 #define DS_SUSPEND_CARD                 _IO  ('d', 12)
81 #define DS_RESUME_CARD                  _IO  ('d', 13)
82 #define DS_EJECT_CARD                   _IO  ('d', 14)
83 #define DS_INSERT_CARD                  _IO  ('d', 15)
84 #define DS_GET_FIRST_REGION             _IOWR('d', 16, region_info_t)
85 #define DS_GET_NEXT_REGION              _IOWR('d', 17, region_info_t)
86 #define DS_REPLACE_CIS                  _IOWR('d', 18, cisdump_t)
87 #define DS_GET_FIRST_WINDOW             _IOR ('d', 19, win_info_t)
88 #define DS_GET_NEXT_WINDOW              _IOWR('d', 20, win_info_t)
89 #define DS_GET_MEM_PAGE                 _IOWR('d', 21, win_info_t)
90
91 #define DS_BIND_REQUEST                 _IOWR('d', 60, bind_info_t)
92 #define DS_GET_DEVICE_INFO              _IOWR('d', 61, bind_info_t) 
93 #define DS_GET_NEXT_DEVICE              _IOWR('d', 62, bind_info_t) 
94 #define DS_UNBIND_REQUEST               _IOW ('d', 63, bind_info_t)
95 #define DS_BIND_MTD                     _IOWR('d', 64, mtd_info_t)
96
97 #ifdef __KERNEL__
98 #include <linux/device.h>
99
100 typedef struct dev_node_t {
101     char                dev_name[DEV_NAME_LEN];
102     u_short             major, minor;
103     struct dev_node_t   *next;
104 } dev_node_t;
105
106 typedef struct dev_link_t {
107     dev_node_t          *dev;
108     u_int               state, open;
109     client_handle_t     handle;
110     io_req_t            io;
111     irq_req_t           irq;
112     config_req_t        conf;
113     window_handle_t     win;
114     void                *priv;
115     struct dev_link_t   *next;
116 } dev_link_t;
117
118 /* Flags for device state */
119 #define DEV_PRESENT             0x01
120 #define DEV_CONFIG              0x02
121 #define DEV_SUSPEND_NORELEASE   0x04
122 #define DEV_CONFIG_PENDING      0x10
123 #define DEV_RELEASE_PENDING     0x20
124 #define DEV_SUSPEND             0x40
125 #define DEV_BUSY                0x80
126
127 #define DEV_OK(l) \
128     ((l) && ((l->state & ~DEV_BUSY) == (DEV_CONFIG|DEV_PRESENT)))
129
130
131 struct pcmcia_socket;
132 struct config_t;
133
134 struct pcmcia_driver {
135         int (*probe)            (struct pcmcia_device *dev);
136         void (*remove)          (struct pcmcia_device *dev);
137
138         int (*suspend)          (struct pcmcia_device *dev);
139         int (*resume)           (struct pcmcia_device *dev);
140
141         struct module           *owner;
142         struct pcmcia_device_id *id_table;
143         struct device_driver    drv;
144 };
145
146 /* driver registration */
147 int pcmcia_register_driver(struct pcmcia_driver *driver);
148 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
149
150 struct pcmcia_device {
151         /* the socket and the device_no [for multifunction devices]
152            uniquely define a pcmcia_device */
153         struct pcmcia_socket    *socket;
154
155         char                    *devname;
156
157         u8                      device_no;
158
159         /* the hardware "function" device; certain subdevices can
160          * share one hardware "function" device. */
161         u8                      func;
162         struct config_t*        function_config;
163
164         struct list_head        socket_device_list;
165
166         /* deprecated, a cleaned up version will be moved into this
167            struct soon */
168         dev_link_t              *instance;
169         u_int                   p_state;
170
171         /* information about this device */
172         u8                      has_manf_id:1;
173         u8                      has_card_id:1;
174         u8                      has_func_id:1;
175
176         u8                      allow_func_id_match:1;
177         u8                      reserved:4;
178
179         u8                      func_id;
180         u16                     manf_id;
181         u16                     card_id;
182
183         char *                  prod_id[4];
184
185         struct device           dev;
186
187 #ifdef CONFIG_PCMCIA_IOCTL
188         /* device driver wanted by cardmgr */
189         struct pcmcia_driver *  cardmgr;
190 #endif
191 };
192
193 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
194 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
195
196 #define handle_to_pdev(handle) (handle)
197 #define handle_to_dev(handle) (handle->dev)
198
199 #define dev_to_instance(dev) (dev->instance)
200
201 /* error reporting */
202 void cs_error(client_handle_t handle, int func, int ret);
203
204 #endif /* __KERNEL__ */
205 #endif /* _LINUX_DS_H */