blob: 70c58ed2278c43f80a355b7aac9c30f40bd2a315 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Dominik Brodowskia5835782008-08-28 00:41:16 +020013 * (C) 2003 - 2008 Dominik Brodowski
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 */
15
16#ifndef _LINUX_DS_H
17#define _LINUX_DS_H
18
Dominik Brodowski8e2f3b72005-07-12 13:58:14 -070019#ifdef __KERNEL__
20#include <linux/mod_devicetable.h>
21#endif
22
Dominik Brodowski1ad275e2005-06-27 16:28:06 -070023#include <pcmcia/device_id.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#ifdef __KERNEL__
26#include <linux/device.h>
Dominik Brodowskie2d40962006-03-02 00:09:29 +010027#include <pcmcia/ss.h>
Dominik Brodowski04de0812010-04-20 14:49:01 +020028#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Dominik Brodowskia5835782008-08-28 00:41:16 +020030/*
31 * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
32 * a.k.a. PCI drivers
33 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034struct pcmcia_socket;
Dominik Brodowskia5835782008-08-28 00:41:16 +020035struct pcmcia_device;
Dominik Brodowskidbb22f02006-01-10 20:41:27 +010036struct config_t;
Dominik Brodowski91284222009-10-18 23:32:33 +020037struct net_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Dominik Brodowski0ca724d2010-07-24 19:03:02 +020039typedef struct resource *window_handle_t;
Dominik Brodowskiac8b4222010-07-21 22:38:13 +020040
Dominik Brodowskia5835782008-08-28 00:41:16 +020041/* dynamic device IDs for PCMCIA device drivers. See
42 * Documentation/pcmcia/driver.txt for details.
43*/
Bernhard Walle6179b552007-05-06 14:48:44 -070044struct pcmcia_dynids {
Dominik Brodowski3f565232010-01-16 13:06:40 +010045 struct mutex lock;
Bernhard Walle6179b552007-05-06 14:48:44 -070046 struct list_head list;
47};
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049struct pcmcia_driver {
Dominik Brodowskif8cfa612005-11-14 21:25:51 +010050 int (*probe) (struct pcmcia_device *dev);
Dominik Brodowskicc3b4862005-11-14 21:23:14 +010051 void (*remove) (struct pcmcia_device *dev);
52
Dominik Brodowski98e4c282005-11-14 21:21:18 +010053 int (*suspend) (struct pcmcia_device *dev);
54 int (*resume) (struct pcmcia_device *dev);
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 struct module *owner;
Dominik Brodowski1ad275e2005-06-27 16:28:06 -070057 struct pcmcia_device_id *id_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 struct device_driver drv;
Bernhard Walle6179b552007-05-06 14:48:44 -070059 struct pcmcia_dynids dynids;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060};
61
62/* driver registration */
63int pcmcia_register_driver(struct pcmcia_driver *driver);
64void pcmcia_unregister_driver(struct pcmcia_driver *driver);
65
Dominik Brodowski0ca724d2010-07-24 19:03:02 +020066/* for struct resource * array embedded in struct pcmcia_device */
67enum {
68 PCMCIA_IOPORT_0,
69 PCMCIA_IOPORT_1,
70 PCMCIA_IOMEM_0,
71 PCMCIA_IOMEM_1,
72 PCMCIA_IOMEM_2,
73 PCMCIA_IOMEM_3,
74 PCMCIA_NUM_RESOURCES,
75};
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077struct pcmcia_device {
78 /* the socket and the device_no [for multifunction devices]
79 uniquely define a pcmcia_device */
80 struct pcmcia_socket *socket;
81
Brice Goglinbd65a682005-09-09 13:03:29 -070082 char *devname;
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 u8 device_no;
85
86 /* the hardware "function" device; certain subdevices can
87 * share one hardware "function" device. */
88 u8 func;
Dominik Brodowski9fea84f2009-12-07 22:11:45 +010089 struct config_t *function_config;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91 struct list_head socket_device_list;
92
Dominik Brodowskifd238232006-03-05 10:45:09 +010093 /* deprecated, will be cleaned up soon */
Dominik Brodowskifd238232006-03-05 10:45:09 +010094 config_req_t conf;
95 window_handle_t win;
Dominik Brodowskifd238232006-03-05 10:45:09 +010096
Dominik Brodowski6f0f38c2010-04-08 20:33:16 +020097 /* device setup */
Dominik Brodowskieb141202010-03-07 12:21:16 +010098 unsigned int irq;
Dominik Brodowski0ca724d2010-07-24 19:03:02 +020099 struct resource *resource[PCMCIA_NUM_RESOURCES];
Dominik Brodowski6f0f38c2010-04-08 20:33:16 +0200100
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200101 unsigned int io_lines; /* number of I/O lines */
102
Dominik Brodowski04de0812010-04-20 14:49:01 +0200103 /* Is the device suspended? */
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100104 u16 suspended:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100106 /* Flags whether io, irq, win configurations were
107 * requested, and whether the configuration is "locked" */
108 u16 _irq:1;
109 u16 _io:1;
110 u16 _win:4;
111 u16 _locked:1;
112
113 /* Flag whether a "fuzzy" func_id based match is
114 * allowed. */
115 u16 allow_func_id_match:1;
Dominik Brodowskif6fbe012006-01-20 15:10:23 +0100116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 /* information about this device */
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100118 u16 has_manf_id:1;
119 u16 has_card_id:1;
120 u16 has_func_id:1;
Dominik Brodowski1ad275e2005-06-27 16:28:06 -0700121
Dominik Brodowski04de0812010-04-20 14:49:01 +0200122 u16 reserved:4;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124 u8 func_id;
125 u16 manf_id;
126 u16 card_id;
127
Dominik Brodowski9fea84f2009-12-07 22:11:45 +0100128 char *prod_id[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
James Bottomley43d9f7f2007-10-16 01:23:58 -0700130 u64 dma_mask;
Dominik Brodowski0e0fad82006-01-15 01:14:31 +0100131 struct device dev;
132
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100133 /* data private to drivers */
134 void *priv;
Dominik Brodowski2ce49052010-07-24 13:14:44 +0200135 unsigned int open;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136};
137
138#define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
139#define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
140
Dominik Brodowskia5835782008-08-28 00:41:16 +0200141
Dominik Brodowski91284222009-10-18 23:32:33 +0200142/*
143 * CIS access.
144 *
145 * Please use the following functions to access CIS tuples:
146 * - pcmcia_get_tuple()
147 * - pcmcia_loop_tuple()
148 * - pcmcia_get_mac_from_cis()
149 *
150 * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
151 * might change in future.
Dominik Brodowski272433e2008-08-31 15:55:58 +0200152 */
Dominik Brodowski91284222009-10-18 23:32:33 +0200153
154/* get the very first CIS entry of type @code. Note that buf is pointer
155 * to u8 *buf; and that you need to kfree(buf) afterwards. */
156size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
157 u8 **buf);
158
159/* loop over CIS entries */
160int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
161 int (*loop_tuple) (struct pcmcia_device *p_dev,
162 tuple_t *tuple,
163 void *priv_data),
164 void *priv_data);
165
166/* get the MAC address from CISTPL_FUNCE */
167int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
168 struct net_device *dev);
169
170
171/* parse a tuple_t */
Dominik Brodowski272433e2008-08-31 15:55:58 +0200172int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
173
Dominik Brodowski272433e2008-08-31 15:55:58 +0200174/* loop CIS entries for valid configuration */
175int pcmcia_loop_config(struct pcmcia_device *p_dev,
176 int (*conf_check) (struct pcmcia_device *p_dev,
177 cistpl_cftable_entry_t *cf,
178 cistpl_cftable_entry_t *dflt,
179 unsigned int vcc,
180 void *priv_data),
181 void *priv_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Dominik Brodowski994917f2008-08-31 15:20:26 +0200183/* is the device still there? */
184struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
185
186/* low-level interface reset */
187int pcmcia_reset_card(struct pcmcia_socket *skt);
188
189/* CIS config */
Dominik Brodowski1d5cc192010-07-24 12:23:21 +0200190int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val);
191int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);
Dominik Brodowski994917f2008-08-31 15:20:26 +0200192
193/* device configuration */
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200194int pcmcia_request_io(struct pcmcia_device *p_dev);
Dominik Brodowskieb141202010-03-07 12:21:16 +0100195
Dominik Brodowskib19a7272010-03-20 13:10:47 +0100196int __must_check
197__pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
Dominik Brodowskieb141202010-03-07 12:21:16 +0100198 irq_handler_t handler);
Dominik Brodowskib19a7272010-03-20 13:10:47 +0100199static inline __must_check __deprecated int
200pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
201 irq_handler_t handler)
202{
203 return __pcmcia_request_exclusive_irq(p_dev, handler);
204}
205
Dominik Brodowskieb141202010-03-07 12:21:16 +0100206int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
207 irq_handler_t handler);
208
Dominik Brodowski994917f2008-08-31 15:20:26 +0200209int pcmcia_request_configuration(struct pcmcia_device *p_dev,
210 config_req_t *req);
211
Dominik Brodowski6838b032009-11-03 01:31:52 +0100212int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req,
Dominik Brodowski994917f2008-08-31 15:20:26 +0200213 window_handle_t *wh);
Magnus Dammf5560da2006-12-13 19:46:38 +0900214int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win);
Magnus Damm868575d2006-12-13 19:46:43 +0900215int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win,
Dominik Brodowskib5cb2592010-07-24 18:46:42 +0200216 unsigned int offset);
Dominik Brodowski994917f2008-08-31 15:20:26 +0200217
218int pcmcia_modify_configuration(struct pcmcia_device *p_dev, modconf_t *mod);
219void pcmcia_disable_device(struct pcmcia_device *p_dev);
220
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200221/* IO ports */
222#define IO_DATA_PATH_WIDTH 0x18
223#define IO_DATA_PATH_WIDTH_8 0x00
224#define IO_DATA_PATH_WIDTH_16 0x08
225#define IO_DATA_PATH_WIDTH_AUTO 0x10
226
227/* convert flag found in cfgtable to data path width parameter */
228static inline int pcmcia_io_cfg_data_width(unsigned int flags)
229{
230 if (!(flags & CISTPL_IO_8BIT))
231 return IO_DATA_PATH_WIDTH_16;
232 if (!(flags & CISTPL_IO_16BIT))
233 return IO_DATA_PATH_WIDTH_8;
234 return IO_DATA_PATH_WIDTH_AUTO;
235}
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237#endif /* __KERNEL__ */
Dominik Brodowskia5835782008-08-28 00:41:16 +0200238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239#endif /* _LINUX_DS_H */