2 * ds.h -- 16-bit PCMCIA core support
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.
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.
12 * (C) 1999 David A. Hinds
13 * (C) 2003 - 2008 Dominik Brodowski
20 #include <linux/mod_devicetable.h>
23 #include <pcmcia/cs_types.h>
24 #include <pcmcia/device_id.h>
27 #include <linux/device.h>
28 #include <pcmcia/ss.h>
29 #include <asm/atomic.h>
32 * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
40 /* dynamic device IDs for PCMCIA device drivers. See
41 * Documentation/pcmcia/driver.txt for details.
43 struct pcmcia_dynids
{
45 struct list_head list
;
48 struct pcmcia_driver
{
49 int (*probe
) (struct pcmcia_device
*dev
);
50 void (*remove
) (struct pcmcia_device
*dev
);
52 int (*suspend
) (struct pcmcia_device
*dev
);
53 int (*resume
) (struct pcmcia_device
*dev
);
56 struct pcmcia_device_id
*id_table
;
57 struct device_driver drv
;
58 struct pcmcia_dynids dynids
;
61 /* driver registration */
62 int pcmcia_register_driver(struct pcmcia_driver
*driver
);
63 void pcmcia_unregister_driver(struct pcmcia_driver
*driver
);
65 /* Some drivers use dev_node_t to store char or block device information.
66 * Don't use this in new drivers, though.
68 typedef struct dev_node_t
{
69 char dev_name
[DEV_NAME_LEN
];
71 struct dev_node_t
*next
;
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
;
83 /* the hardware "function" device; certain subdevices can
84 * share one hardware "function" device. */
86 struct config_t
*function_config
;
88 struct list_head socket_device_list
;
90 /* deprecated, will be cleaned up soon */
98 /* Is the device suspended? */
101 /* Flags whether io, irq, win configurations were
102 * requested, and whether the configuration is "locked" */
108 /* Flag whether a "fuzzy" func_id based match is
110 u16 allow_func_id_match
:1;
112 /* information about this device */
128 #ifdef CONFIG_PCMCIA_IOCTL
129 /* device driver wanted by cardmgr */
130 struct pcmcia_driver
*cardmgr
;
133 /* data private to drivers */
137 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
138 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
144 * Please use the following functions to access CIS tuples:
145 * - pcmcia_get_tuple()
146 * - pcmcia_loop_tuple()
147 * - pcmcia_get_mac_from_cis()
149 * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
150 * might change in future.
153 /* get the very first CIS entry of type @code. Note that buf is pointer
154 * to u8 *buf; and that you need to kfree(buf) afterwards. */
155 size_t pcmcia_get_tuple(struct pcmcia_device
*p_dev
, cisdata_t code
,
158 /* loop over CIS entries */
159 int pcmcia_loop_tuple(struct pcmcia_device
*p_dev
, cisdata_t code
,
160 int (*loop_tuple
) (struct pcmcia_device
*p_dev
,
165 /* get the MAC address from CISTPL_FUNCE */
166 int pcmcia_get_mac_from_cis(struct pcmcia_device
*p_dev
,
167 struct net_device
*dev
);
170 /* parse a tuple_t */
171 int pcmcia_parse_tuple(tuple_t
*tuple
, cisparse_t
*parse
);
173 /* loop CIS entries for valid configuration */
174 int pcmcia_loop_config(struct pcmcia_device
*p_dev
,
175 int (*conf_check
) (struct pcmcia_device
*p_dev
,
176 cistpl_cftable_entry_t
*cf
,
177 cistpl_cftable_entry_t
*dflt
,
182 /* is the device still there? */
183 struct pcmcia_device
*pcmcia_dev_present(struct pcmcia_device
*p_dev
);
185 /* low-level interface reset */
186 int pcmcia_reset_card(struct pcmcia_socket
*skt
);
189 int pcmcia_access_configuration_register(struct pcmcia_device
*p_dev
,
192 /* device configuration */
193 int pcmcia_request_io(struct pcmcia_device
*p_dev
, io_req_t
*req
);
194 int pcmcia_request_irq(struct pcmcia_device
*p_dev
, irq_req_t
*req
);
195 int pcmcia_request_configuration(struct pcmcia_device
*p_dev
,
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
,
204 int pcmcia_modify_configuration(struct pcmcia_device
*p_dev
, modconf_t
*mod
);
205 void pcmcia_disable_device(struct pcmcia_device
*p_dev
);
207 #endif /* __KERNEL__ */
211 /* Below, there are only definitions which are used by
213 * - deprecated PCMCIA userspace tools only
215 * here be dragons ... here be dragons ... here be dragons ... here be drag
218 #if defined(CONFIG_PCMCIA_IOCTL) || !defined(__KERNEL__)
220 #if defined(__arm__) || defined(__mips__) || defined(__avr32__) || \
222 /* This (ioaddr_t) is exposed to userspace & hence cannot be changed. */
223 typedef u_int ioaddr_t
;
225 typedef u_short ioaddr_t
;
228 /* for AdjustResourceInfo */
229 typedef struct adjust_t
{
250 #define REMOVE_MANAGED_RESOURCE 1
251 #define ADD_MANAGED_RESOURCE 2
252 #define GET_FIRST_MANAGED_RESOURCE 3
253 #define GET_NEXT_MANAGED_RESOURCE 4
255 #define RES_MEMORY_RANGE 1
256 #define RES_IO_RANGE 2
258 /* Attribute field */
259 #define RES_IRQ_TYPE 0x03
260 #define RES_IRQ_TYPE_EXCLUSIVE 0
261 #define RES_IRQ_TYPE_TIME 1
262 #define RES_IRQ_TYPE_DYNAMIC 2
263 #define RES_IRQ_CSC 0x04
264 #define RES_SHARED 0x08
265 #define RES_RESERVED 0x10
266 #define RES_ALLOCATED 0x20
267 #define RES_REMOVED 0x40
270 typedef struct tuple_parse_t
{
276 typedef struct win_info_t
{
277 window_handle_t handle
;
282 typedef struct bind_info_t
{
285 struct pcmcia_device
*instance
;
286 char name
[DEV_NAME_LEN
];
287 u_short major
, minor
;
291 typedef struct mtd_info_t
{
297 typedef struct region_info_t
{
304 u_char JedecMfr
, JedecInfo
;
305 memory_handle_t next
;
308 #define REGION_TYPE 0x0001
309 #define REGION_TYPE_CM 0x0000
310 #define REGION_TYPE_AM 0x0001
311 #define REGION_PREFETCH 0x0008
312 #define REGION_CACHEABLE 0x0010
313 #define REGION_BAR_MASK 0xe000
314 #define REGION_BAR_SHIFT 13
317 typedef struct cisdump_t
{
319 cisdata_t Data
[CISTPL_MAX_CIS_SIZE
];
322 /* for GetConfigurationInfo */
323 typedef struct config_info_t
{
326 u_int Vcc
, Vpp1
, Vpp2
;
329 u_char Status
, Pin
, Copy
, Option
, ExtStatus
;
343 /* For ValidateCIS */
344 typedef struct cisinfo_t
{
348 typedef struct cs_status_t
{
354 typedef union ds_ioctl_arg_t
{
356 config_info_t config
;
358 tuple_parse_t tuple_parse
;
359 client_req_t client_req
;
363 region_info_t region
;
364 bind_info_t bind_info
;
370 #define DS_ADJUST_RESOURCE_INFO _IOWR('d', 2, adjust_t)
371 #define DS_GET_CONFIGURATION_INFO _IOWR('d', 3, config_info_t)
372 #define DS_GET_FIRST_TUPLE _IOWR('d', 4, tuple_t)
373 #define DS_GET_NEXT_TUPLE _IOWR('d', 5, tuple_t)
374 #define DS_GET_TUPLE_DATA _IOWR('d', 6, tuple_parse_t)
375 #define DS_PARSE_TUPLE _IOWR('d', 7, tuple_parse_t)
376 #define DS_RESET_CARD _IO ('d', 8)
377 #define DS_GET_STATUS _IOWR('d', 9, cs_status_t)
378 #define DS_ACCESS_CONFIGURATION_REGISTER _IOWR('d', 10, conf_reg_t)
379 #define DS_VALIDATE_CIS _IOR ('d', 11, cisinfo_t)
380 #define DS_SUSPEND_CARD _IO ('d', 12)
381 #define DS_RESUME_CARD _IO ('d', 13)
382 #define DS_EJECT_CARD _IO ('d', 14)
383 #define DS_INSERT_CARD _IO ('d', 15)
384 #define DS_GET_FIRST_REGION _IOWR('d', 16, region_info_t)
385 #define DS_GET_NEXT_REGION _IOWR('d', 17, region_info_t)
386 #define DS_REPLACE_CIS _IOWR('d', 18, cisdump_t)
387 #define DS_GET_FIRST_WINDOW _IOR ('d', 19, win_info_t)
388 #define DS_GET_NEXT_WINDOW _IOWR('d', 20, win_info_t)
389 #define DS_GET_MEM_PAGE _IOWR('d', 21, win_info_t)
391 #define DS_BIND_REQUEST _IOWR('d', 60, bind_info_t)
392 #define DS_GET_DEVICE_INFO _IOWR('d', 61, bind_info_t)
393 #define DS_GET_NEXT_DEVICE _IOWR('d', 62, bind_info_t)
394 #define DS_UNBIND_REQUEST _IOW ('d', 63, bind_info_t)
395 #define DS_BIND_MTD _IOWR('d', 64, mtd_info_t)
398 /* used in userspace only */
399 #define CS_IN_USE 0x1e
401 #define INFO_MASTER_CLIENT 0x01
402 #define INFO_IO_CLIENT 0x02
403 #define INFO_MTD_CLIENT 0x04
404 #define INFO_MEM_CLIENT 0x08
405 #define MAX_NUM_CLIENTS 3
407 #define INFO_CARD_SHARE 0x10
408 #define INFO_CARD_EXCL 0x20
411 #endif /* !defined(__KERNEL__) || defined(CONFIG_PCMCIA_IOCTL) */
413 #endif /* _LINUX_DS_H */