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