pcmcia: only copy CIS override data once
[safe/jmp/linux-2.6] / 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/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 typedef union ds_ioctl_arg_t {
78     adjust_t            adjust;
79     config_info_t       config;
80     tuple_t             tuple;
81     tuple_parse_t       tuple_parse;
82     client_req_t        client_req;
83     cs_status_t         status;
84     conf_reg_t          conf_reg;
85     cisinfo_t           cisinfo;
86     region_info_t       region;
87     bind_info_t         bind_info;
88     mtd_info_t          mtd_info;
89     win_info_t          win_info;
90     cisdump_t           cisdump;
91 } ds_ioctl_arg_t;
92
93 #define DS_ADJUST_RESOURCE_INFO         _IOWR('d', 2, adjust_t)
94 #define DS_GET_CONFIGURATION_INFO       _IOWR('d', 3, config_info_t)
95 #define DS_GET_FIRST_TUPLE              _IOWR('d', 4, tuple_t)
96 #define DS_GET_NEXT_TUPLE               _IOWR('d', 5, tuple_t)
97 #define DS_GET_TUPLE_DATA               _IOWR('d', 6, tuple_parse_t)
98 #define DS_PARSE_TUPLE                  _IOWR('d', 7, tuple_parse_t)
99 #define DS_RESET_CARD                   _IO  ('d', 8)
100 #define DS_GET_STATUS                   _IOWR('d', 9, cs_status_t)
101 #define DS_ACCESS_CONFIGURATION_REGISTER _IOWR('d', 10, conf_reg_t)
102 #define DS_VALIDATE_CIS                 _IOR ('d', 11, cisinfo_t)
103 #define DS_SUSPEND_CARD                 _IO  ('d', 12)
104 #define DS_RESUME_CARD                  _IO  ('d', 13)
105 #define DS_EJECT_CARD                   _IO  ('d', 14)
106 #define DS_INSERT_CARD                  _IO  ('d', 15)
107 #define DS_GET_FIRST_REGION             _IOWR('d', 16, region_info_t)
108 #define DS_GET_NEXT_REGION              _IOWR('d', 17, region_info_t)
109 #define DS_REPLACE_CIS                  _IOWR('d', 18, cisdump_t)
110 #define DS_GET_FIRST_WINDOW             _IOR ('d', 19, win_info_t)
111 #define DS_GET_NEXT_WINDOW              _IOWR('d', 20, win_info_t)
112 #define DS_GET_MEM_PAGE                 _IOWR('d', 21, win_info_t)
113
114 #define DS_BIND_REQUEST                 _IOWR('d', 60, bind_info_t)
115 #define DS_GET_DEVICE_INFO              _IOWR('d', 61, bind_info_t) 
116 #define DS_GET_NEXT_DEVICE              _IOWR('d', 62, bind_info_t) 
117 #define DS_UNBIND_REQUEST               _IOW ('d', 63, bind_info_t)
118 #define DS_BIND_MTD                     _IOWR('d', 64, mtd_info_t)
119
120 #ifdef __KERNEL__
121 #include <linux/device.h>
122 #include <pcmcia/ss.h>
123
124 typedef struct dev_node_t {
125     char                dev_name[DEV_NAME_LEN];
126     u_short             major, minor;
127     struct dev_node_t   *next;
128 } dev_node_t;
129
130
131 struct pcmcia_socket;
132 struct config_t;
133
134 struct pcmcia_dynids {
135         spinlock_t              lock;
136         struct list_head        list;
137 };
138
139 struct pcmcia_driver {
140         int (*probe)            (struct pcmcia_device *dev);
141         void (*remove)          (struct pcmcia_device *dev);
142
143         int (*suspend)          (struct pcmcia_device *dev);
144         int (*resume)           (struct pcmcia_device *dev);
145
146         struct module           *owner;
147         struct pcmcia_device_id *id_table;
148         struct device_driver    drv;
149         struct pcmcia_dynids    dynids;
150 };
151
152 /* driver registration */
153 int pcmcia_register_driver(struct pcmcia_driver *driver);
154 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
155
156
157 struct pcmcia_device {
158         /* the socket and the device_no [for multifunction devices]
159            uniquely define a pcmcia_device */
160         struct pcmcia_socket    *socket;
161
162         char                    *devname;
163
164         u8                      device_no;
165
166         /* the hardware "function" device; certain subdevices can
167          * share one hardware "function" device. */
168         u8                      func;
169         struct config_t*        function_config;
170
171         struct list_head        socket_device_list;
172
173         /* deprecated, will be cleaned up soon */
174         dev_node_t              *dev_node;
175         u_int                   open;
176         io_req_t                io;
177         irq_req_t               irq;
178         config_req_t            conf;
179         window_handle_t         win;
180
181         /* Is the device suspended, or in the process of
182          * being removed? */
183         u16                     suspended:1;
184         u16                     _removed:1;
185
186         /* Flags whether io, irq, win configurations were
187          * requested, and whether the configuration is "locked" */
188         u16                     _irq:1;
189         u16                     _io:1;
190         u16                     _win:4;
191         u16                     _locked:1;
192
193         /* Flag whether a "fuzzy" func_id based match is
194          * allowed. */
195         u16                     allow_func_id_match:1;
196
197         /* information about this device */
198         u16                     has_manf_id:1;
199         u16                     has_card_id:1;
200         u16                     has_func_id:1;
201
202         u16                     reserved:3;
203
204         u8                      func_id;
205         u16                     manf_id;
206         u16                     card_id;
207
208         char *                  prod_id[4];
209
210         u64                     dma_mask;
211         struct device           dev;
212
213 #ifdef CONFIG_PCMCIA_IOCTL
214         /* device driver wanted by cardmgr */
215         struct pcmcia_driver *  cardmgr;
216 #endif
217
218         /* data private to drivers */
219         void                    *priv;
220 };
221
222 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
223 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
224
225 #define handle_to_dev(handle) (handle->dev)
226
227 /* error reporting */
228 void cs_error(struct pcmcia_device *handle, int func, int ret);
229
230 #endif /* __KERNEL__ */
231 #endif /* _LINUX_DS_H */