blob: 3bbbd78e143954aba700d5c661b14195e15bff92 [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 Brodowski1ac71e52010-07-29 19:27:09 +020027#include <linux/interrupt.h>
Dominik Brodowskie2d40962006-03-02 00:09:29 +010028#include <pcmcia/ss.h>
Arun Sharma600634972011-07-26 16:09:06 -070029#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Dominik Brodowski1ac71e52010-07-29 19:27:09 +020031
Dominik Brodowskia5835782008-08-28 00:41:16 +020032/*
33 * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
34 * a.k.a. PCI drivers
35 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036struct pcmcia_socket;
Dominik Brodowskia5835782008-08-28 00:41:16 +020037struct pcmcia_device;
Dominik Brodowskidbb22f02006-01-10 20:41:27 +010038struct config_t;
Dominik Brodowski91284222009-10-18 23:32:33 +020039struct net_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
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 Brodowski2e9b9812010-08-08 11:36:26 +020050 const char *name;
51
Dominik Brodowskif8cfa612005-11-14 21:25:51 +010052 int (*probe) (struct pcmcia_device *dev);
Dominik Brodowskicc3b4862005-11-14 21:23:14 +010053 void (*remove) (struct pcmcia_device *dev);
54
Dominik Brodowski98e4c282005-11-14 21:21:18 +010055 int (*suspend) (struct pcmcia_device *dev);
56 int (*resume) (struct pcmcia_device *dev);
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 struct module *owner;
Joe Perchese9fb13b2011-05-03 19:29:00 -070059 const struct pcmcia_device_id *id_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 struct device_driver drv;
Bernhard Walle6179b552007-05-06 14:48:44 -070061 struct pcmcia_dynids dynids;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062};
63
64/* driver registration */
65int pcmcia_register_driver(struct pcmcia_driver *driver);
66void pcmcia_unregister_driver(struct pcmcia_driver *driver);
67
Dominik Brodowski0ca724d2010-07-24 19:03:02 +020068/* for struct resource * array embedded in struct pcmcia_device */
69enum {
70 PCMCIA_IOPORT_0,
71 PCMCIA_IOPORT_1,
72 PCMCIA_IOMEM_0,
73 PCMCIA_IOMEM_1,
74 PCMCIA_IOMEM_2,
75 PCMCIA_IOMEM_3,
76 PCMCIA_NUM_RESOURCES,
77};
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079struct pcmcia_device {
80 /* the socket and the device_no [for multifunction devices]
81 uniquely define a pcmcia_device */
82 struct pcmcia_socket *socket;
83
Brice Goglinbd65a682005-09-09 13:03:29 -070084 char *devname;
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 u8 device_no;
87
88 /* the hardware "function" device; certain subdevices can
89 * share one hardware "function" device. */
90 u8 func;
Dominik Brodowski9fea84f2009-12-07 22:11:45 +010091 struct config_t *function_config;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93 struct list_head socket_device_list;
94
Dominik Brodowski6f0f38c2010-04-08 20:33:16 +020095 /* device setup */
Dominik Brodowskieb141202010-03-07 12:21:16 +010096 unsigned int irq;
Dominik Brodowski0ca724d2010-07-24 19:03:02 +020097 struct resource *resource[PCMCIA_NUM_RESOURCES];
Dominik Brodowski00990e72010-07-30 13:13:46 +020098 resource_size_t card_addr; /* for the 1st IOMEM resource */
Dominik Brodowskie8405f02010-07-29 15:50:55 +020099 unsigned int vpp;
Dominik Brodowski6f0f38c2010-04-08 20:33:16 +0200100
Dominik Brodowski1ac71e52010-07-29 19:27:09 +0200101 unsigned int config_flags; /* CONF_ENABLE_ flags below */
Dominik Brodowski7feabb62010-07-29 18:35:47 +0200102 unsigned int config_base;
103 unsigned int config_index;
104 unsigned int config_regs; /* PRESENT_ flags below */
Dominik Brodowski1ac71e52010-07-29 19:27:09 +0200105 unsigned int io_lines; /* number of I/O lines */
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200106
Dominik Brodowski04de0812010-04-20 14:49:01 +0200107 /* Is the device suspended? */
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100108 u16 suspended:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100110 /* Flags whether io, irq, win configurations were
111 * requested, and whether the configuration is "locked" */
112 u16 _irq:1;
113 u16 _io:1;
114 u16 _win:4;
115 u16 _locked:1;
116
117 /* Flag whether a "fuzzy" func_id based match is
118 * allowed. */
119 u16 allow_func_id_match:1;
Dominik Brodowskif6fbe012006-01-20 15:10:23 +0100120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 /* information about this device */
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100122 u16 has_manf_id:1;
123 u16 has_card_id:1;
124 u16 has_func_id:1;
Dominik Brodowski1ad275e2005-06-27 16:28:06 -0700125
Dominik Brodowski04de0812010-04-20 14:49:01 +0200126 u16 reserved:4;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128 u8 func_id;
129 u16 manf_id;
130 u16 card_id;
131
Dominik Brodowski9fea84f2009-12-07 22:11:45 +0100132 char *prod_id[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
James Bottomley43d9f7f2007-10-16 01:23:58 -0700134 u64 dma_mask;
Dominik Brodowski0e0fad82006-01-15 01:14:31 +0100135 struct device dev;
136
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100137 /* data private to drivers */
138 void *priv;
Dominik Brodowski2ce49052010-07-24 13:14:44 +0200139 unsigned int open;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140};
141
142#define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
143#define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
144
Dominik Brodowskia5835782008-08-28 00:41:16 +0200145
Dominik Brodowski91284222009-10-18 23:32:33 +0200146/*
147 * CIS access.
148 *
149 * Please use the following functions to access CIS tuples:
150 * - pcmcia_get_tuple()
151 * - pcmcia_loop_tuple()
152 * - pcmcia_get_mac_from_cis()
153 *
154 * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
155 * might change in future.
Dominik Brodowski272433e2008-08-31 15:55:58 +0200156 */
Dominik Brodowski91284222009-10-18 23:32:33 +0200157
158/* get the very first CIS entry of type @code. Note that buf is pointer
159 * to u8 *buf; and that you need to kfree(buf) afterwards. */
160size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
161 u8 **buf);
162
163/* loop over CIS entries */
164int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
165 int (*loop_tuple) (struct pcmcia_device *p_dev,
166 tuple_t *tuple,
167 void *priv_data),
168 void *priv_data);
169
170/* get the MAC address from CISTPL_FUNCE */
171int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
172 struct net_device *dev);
173
174
175/* parse a tuple_t */
Dominik Brodowski272433e2008-08-31 15:55:58 +0200176int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
177
Dominik Brodowski272433e2008-08-31 15:55:58 +0200178/* loop CIS entries for valid configuration */
179int pcmcia_loop_config(struct pcmcia_device *p_dev,
180 int (*conf_check) (struct pcmcia_device *p_dev,
Dominik Brodowski272433e2008-08-31 15:55:58 +0200181 void *priv_data),
182 void *priv_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Dominik Brodowski994917f2008-08-31 15:20:26 +0200184/* is the device still there? */
185struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
186
187/* low-level interface reset */
188int pcmcia_reset_card(struct pcmcia_socket *skt);
189
190/* CIS config */
Dominik Brodowski1d5cc192010-07-24 12:23:21 +0200191int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val);
192int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);
Dominik Brodowski994917f2008-08-31 15:20:26 +0200193
194/* device configuration */
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200195int pcmcia_request_io(struct pcmcia_device *p_dev);
Dominik Brodowskieb141202010-03-07 12:21:16 +0100196
Dominik Brodowskib19a7272010-03-20 13:10:47 +0100197int __must_check
198__pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
Dominik Brodowskieb141202010-03-07 12:21:16 +0100199 irq_handler_t handler);
Dominik Brodowskib19a7272010-03-20 13:10:47 +0100200static inline __must_check __deprecated int
201pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
202 irq_handler_t handler)
203{
204 return __pcmcia_request_exclusive_irq(p_dev, handler);
205}
206
Dominik Brodowskieb141202010-03-07 12:21:16 +0100207int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
208 irq_handler_t handler);
209
Dominik Brodowski1ac71e52010-07-29 19:27:09 +0200210int pcmcia_enable_device(struct pcmcia_device *p_dev);
Dominik Brodowski994917f2008-08-31 15:20:26 +0200211
Dominik Brodowskicdb13802010-07-28 10:59:06 +0200212int pcmcia_request_window(struct pcmcia_device *p_dev, struct resource *res,
213 unsigned int speed);
214int pcmcia_release_window(struct pcmcia_device *p_dev, struct resource *res);
215int pcmcia_map_mem_page(struct pcmcia_device *p_dev, struct resource *res,
Dominik Brodowskib5cb2592010-07-24 18:46:42 +0200216 unsigned int offset);
Dominik Brodowski994917f2008-08-31 15:20:26 +0200217
Dominik Brodowskifb49fa52010-07-29 14:06:42 +0200218int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp);
219int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev);
220
Dominik Brodowski994917f2008-08-31 15:20:26 +0200221void pcmcia_disable_device(struct pcmcia_device *p_dev);
222
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200223/* IO ports */
224#define IO_DATA_PATH_WIDTH 0x18
225#define IO_DATA_PATH_WIDTH_8 0x00
226#define IO_DATA_PATH_WIDTH_16 0x08
227#define IO_DATA_PATH_WIDTH_AUTO 0x10
228
Dominik Brodowskicdb13802010-07-28 10:59:06 +0200229/* IO memory */
230#define WIN_MEMORY_TYPE_CM 0x00 /* default */
231#define WIN_MEMORY_TYPE_AM 0x20 /* MAP_ATTRIB */
232#define WIN_DATA_WIDTH_8 0x00 /* default */
233#define WIN_DATA_WIDTH_16 0x02 /* MAP_16BIT */
234#define WIN_ENABLE 0x01 /* MAP_ACTIVE */
235#define WIN_USE_WAIT 0x40 /* MAP_USE_WAIT */
236
237#define WIN_FLAGS_MAP 0x63 /* MAP_ATTRIB | MAP_16BIT | MAP_ACTIVE |
238 MAP_USE_WAIT */
239#define WIN_FLAGS_REQ 0x1c /* mapping to socket->win[i]:
240 0x04 -> 0
241 0x08 -> 1
242 0x0c -> 2
243 0x10 -> 3 */
244
Dominik Brodowski7feabb62010-07-29 18:35:47 +0200245/* config_reg{ister}s present for this PCMCIA device */
246#define PRESENT_OPTION 0x001
247#define PRESENT_STATUS 0x002
248#define PRESENT_PIN_REPLACE 0x004
249#define PRESENT_COPY 0x008
250#define PRESENT_EXT_STATUS 0x010
251#define PRESENT_IOBASE_0 0x020
252#define PRESENT_IOBASE_1 0x040
253#define PRESENT_IOBASE_2 0x080
254#define PRESENT_IOBASE_3 0x100
255#define PRESENT_IOSIZE 0x200
Dominik Brodowskicdb13802010-07-28 10:59:06 +0200256
Dominik Brodowski1ac71e52010-07-29 19:27:09 +0200257/* flags to be passed to pcmcia_enable_device() */
Dominik Brodowski00990e72010-07-30 13:13:46 +0200258#define CONF_ENABLE_IRQ 0x0001
259#define CONF_ENABLE_SPKR 0x0002
260#define CONF_ENABLE_PULSE_IRQ 0x0004
261#define CONF_ENABLE_ESR 0x0008
Dominik Brodowskiff10fca2010-10-22 08:46:36 +0200262#define CONF_ENABLE_IOCARD 0x0010 /* auto-enabled if IO resources or IRQ
263 * (CONF_ENABLE_IRQ) in use */
Dominik Brodowski33619f02011-02-19 12:35:15 +0100264#define CONF_ENABLE_ZVCARD 0x0020
Dominik Brodowski1ac71e52010-07-29 19:27:09 +0200265
Dominik Brodowski440eed42010-07-30 09:51:52 +0200266/* flags used by pcmcia_loop_config() autoconfiguration */
Dominik Brodowski00990e72010-07-30 13:13:46 +0200267#define CONF_AUTO_CHECK_VCC 0x0100 /* check for matching Vcc? */
268#define CONF_AUTO_SET_VPP 0x0200 /* set Vpp? */
269#define CONF_AUTO_AUDIO 0x0400 /* enable audio line? */
270#define CONF_AUTO_SET_IO 0x0800 /* set ->resource[0,1] */
271#define CONF_AUTO_SET_IOMEM 0x1000 /* set ->resource[2] */
Dominik Brodowski440eed42010-07-30 09:51:52 +0200272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273#endif /* __KERNEL__ */
Dominik Brodowskia5835782008-08-28 00:41:16 +0200274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275#endif /* _LINUX_DS_H */