Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |
Dominik Brodowski | a583578 | 2008-08-28 00:41:16 +0200 | [diff] [blame] | 13 | * (C) 2003 - 2008 Dominik Brodowski |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | */ |
| 15 | |
| 16 | #ifndef _LINUX_DS_H |
| 17 | #define _LINUX_DS_H |
| 18 | |
Dominik Brodowski | 8e2f3b7 | 2005-07-12 13:58:14 -0700 | [diff] [blame] | 19 | #ifdef __KERNEL__ |
| 20 | #include <linux/mod_devicetable.h> |
| 21 | #endif |
| 22 | |
Dominik Brodowski | 1ad275e | 2005-06-27 16:28:06 -0700 | [diff] [blame] | 23 | #include <pcmcia/device_id.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | #ifdef __KERNEL__ |
| 26 | #include <linux/device.h> |
Dominik Brodowski | e2d4096 | 2006-03-02 00:09:29 +0100 | [diff] [blame] | 27 | #include <pcmcia/ss.h> |
Dominik Brodowski | 04de081 | 2010-04-20 14:49:01 +0200 | [diff] [blame] | 28 | #include <asm/atomic.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | |
Dominik Brodowski | a583578 | 2008-08-28 00:41:16 +0200 | [diff] [blame] | 30 | /* |
| 31 | * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus |
| 32 | * a.k.a. PCI drivers |
| 33 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | struct pcmcia_socket; |
Dominik Brodowski | a583578 | 2008-08-28 00:41:16 +0200 | [diff] [blame] | 35 | struct pcmcia_device; |
Dominik Brodowski | dbb22f0 | 2006-01-10 20:41:27 +0100 | [diff] [blame] | 36 | struct config_t; |
Dominik Brodowski | 9128422 | 2009-10-18 23:32:33 +0200 | [diff] [blame] | 37 | struct net_device; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | |
Dominik Brodowski | 0ca724d | 2010-07-24 19:03:02 +0200 | [diff] [blame] | 39 | typedef struct resource *window_handle_t; |
Dominik Brodowski | ac8b422 | 2010-07-21 22:38:13 +0200 | [diff] [blame] | 40 | |
Dominik Brodowski | a583578 | 2008-08-28 00:41:16 +0200 | [diff] [blame] | 41 | /* dynamic device IDs for PCMCIA device drivers. See |
| 42 | * Documentation/pcmcia/driver.txt for details. |
| 43 | */ |
Bernhard Walle | 6179b55 | 2007-05-06 14:48:44 -0700 | [diff] [blame] | 44 | struct pcmcia_dynids { |
Dominik Brodowski | 3f56523 | 2010-01-16 13:06:40 +0100 | [diff] [blame] | 45 | struct mutex lock; |
Bernhard Walle | 6179b55 | 2007-05-06 14:48:44 -0700 | [diff] [blame] | 46 | struct list_head list; |
| 47 | }; |
| 48 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | struct pcmcia_driver { |
Dominik Brodowski | f8cfa61 | 2005-11-14 21:25:51 +0100 | [diff] [blame] | 50 | int (*probe) (struct pcmcia_device *dev); |
Dominik Brodowski | cc3b486 | 2005-11-14 21:23:14 +0100 | [diff] [blame] | 51 | void (*remove) (struct pcmcia_device *dev); |
| 52 | |
Dominik Brodowski | 98e4c28 | 2005-11-14 21:21:18 +0100 | [diff] [blame] | 53 | int (*suspend) (struct pcmcia_device *dev); |
| 54 | int (*resume) (struct pcmcia_device *dev); |
| 55 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | struct module *owner; |
Dominik Brodowski | 1ad275e | 2005-06-27 16:28:06 -0700 | [diff] [blame] | 57 | struct pcmcia_device_id *id_table; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | struct device_driver drv; |
Bernhard Walle | 6179b55 | 2007-05-06 14:48:44 -0700 | [diff] [blame] | 59 | struct pcmcia_dynids dynids; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | }; |
| 61 | |
| 62 | /* driver registration */ |
| 63 | int pcmcia_register_driver(struct pcmcia_driver *driver); |
| 64 | void pcmcia_unregister_driver(struct pcmcia_driver *driver); |
| 65 | |
Dominik Brodowski | 0ca724d | 2010-07-24 19:03:02 +0200 | [diff] [blame] | 66 | /* for struct resource * array embedded in struct pcmcia_device */ |
| 67 | enum { |
| 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | struct 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 Goglin | bd65a68 | 2005-09-09 13:03:29 -0700 | [diff] [blame] | 82 | char *devname; |
| 83 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 84 | u8 device_no; |
| 85 | |
| 86 | /* the hardware "function" device; certain subdevices can |
| 87 | * share one hardware "function" device. */ |
| 88 | u8 func; |
Dominik Brodowski | 9fea84f | 2009-12-07 22:11:45 +0100 | [diff] [blame] | 89 | struct config_t *function_config; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | |
| 91 | struct list_head socket_device_list; |
| 92 | |
Dominik Brodowski | fd23823 | 2006-03-05 10:45:09 +0100 | [diff] [blame] | 93 | /* deprecated, will be cleaned up soon */ |
Dominik Brodowski | fd23823 | 2006-03-05 10:45:09 +0100 | [diff] [blame] | 94 | config_req_t conf; |
| 95 | window_handle_t win; |
Dominik Brodowski | fd23823 | 2006-03-05 10:45:09 +0100 | [diff] [blame] | 96 | |
Dominik Brodowski | 6f0f38c | 2010-04-08 20:33:16 +0200 | [diff] [blame] | 97 | /* device setup */ |
Dominik Brodowski | eb14120 | 2010-03-07 12:21:16 +0100 | [diff] [blame] | 98 | unsigned int irq; |
Dominik Brodowski | 0ca724d | 2010-07-24 19:03:02 +0200 | [diff] [blame] | 99 | struct resource *resource[PCMCIA_NUM_RESOURCES]; |
Dominik Brodowski | 6f0f38c | 2010-04-08 20:33:16 +0200 | [diff] [blame] | 100 | |
Dominik Brodowski | 90abdc3 | 2010-07-24 17:23:51 +0200 | [diff] [blame] | 101 | unsigned int io_lines; /* number of I/O lines */ |
| 102 | |
Dominik Brodowski | 04de081 | 2010-04-20 14:49:01 +0200 | [diff] [blame] | 103 | /* Is the device suspended? */ |
Dominik Brodowski | e2d4096 | 2006-03-02 00:09:29 +0100 | [diff] [blame] | 104 | u16 suspended:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | |
Dominik Brodowski | e2d4096 | 2006-03-02 00:09:29 +0100 | [diff] [blame] | 106 | /* 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 Brodowski | f6fbe01 | 2006-01-20 15:10:23 +0100 | [diff] [blame] | 116 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | /* information about this device */ |
Dominik Brodowski | e2d4096 | 2006-03-02 00:09:29 +0100 | [diff] [blame] | 118 | u16 has_manf_id:1; |
| 119 | u16 has_card_id:1; |
| 120 | u16 has_func_id:1; |
Dominik Brodowski | 1ad275e | 2005-06-27 16:28:06 -0700 | [diff] [blame] | 121 | |
Dominik Brodowski | 04de081 | 2010-04-20 14:49:01 +0200 | [diff] [blame] | 122 | u16 reserved:4; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | |
| 124 | u8 func_id; |
| 125 | u16 manf_id; |
| 126 | u16 card_id; |
| 127 | |
Dominik Brodowski | 9fea84f | 2009-12-07 22:11:45 +0100 | [diff] [blame] | 128 | char *prod_id[4]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | |
James Bottomley | 43d9f7f | 2007-10-16 01:23:58 -0700 | [diff] [blame] | 130 | u64 dma_mask; |
Dominik Brodowski | 0e0fad8 | 2006-01-15 01:14:31 +0100 | [diff] [blame] | 131 | struct device dev; |
| 132 | |
Dominik Brodowski | e2d4096 | 2006-03-02 00:09:29 +0100 | [diff] [blame] | 133 | /* data private to drivers */ |
| 134 | void *priv; |
Dominik Brodowski | 2ce4905 | 2010-07-24 13:14:44 +0200 | [diff] [blame] | 135 | unsigned int open; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | }; |
| 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 Brodowski | a583578 | 2008-08-28 00:41:16 +0200 | [diff] [blame] | 141 | |
Dominik Brodowski | 9128422 | 2009-10-18 23:32:33 +0200 | [diff] [blame] | 142 | /* |
| 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 Brodowski | 272433e | 2008-08-31 15:55:58 +0200 | [diff] [blame] | 152 | */ |
Dominik Brodowski | 9128422 | 2009-10-18 23:32:33 +0200 | [diff] [blame] | 153 | |
| 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. */ |
| 156 | size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code, |
| 157 | u8 **buf); |
| 158 | |
| 159 | /* loop over CIS entries */ |
| 160 | int 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 */ |
| 167 | int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev, |
| 168 | struct net_device *dev); |
| 169 | |
| 170 | |
| 171 | /* parse a tuple_t */ |
Dominik Brodowski | 272433e | 2008-08-31 15:55:58 +0200 | [diff] [blame] | 172 | int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse); |
| 173 | |
Dominik Brodowski | 272433e | 2008-08-31 15:55:58 +0200 | [diff] [blame] | 174 | /* loop CIS entries for valid configuration */ |
| 175 | int 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | |
Dominik Brodowski | 994917f | 2008-08-31 15:20:26 +0200 | [diff] [blame] | 183 | /* is the device still there? */ |
| 184 | struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev); |
| 185 | |
| 186 | /* low-level interface reset */ |
| 187 | int pcmcia_reset_card(struct pcmcia_socket *skt); |
| 188 | |
| 189 | /* CIS config */ |
Dominik Brodowski | 1d5cc19 | 2010-07-24 12:23:21 +0200 | [diff] [blame] | 190 | int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val); |
| 191 | int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val); |
Dominik Brodowski | 994917f | 2008-08-31 15:20:26 +0200 | [diff] [blame] | 192 | |
| 193 | /* device configuration */ |
Dominik Brodowski | 90abdc3 | 2010-07-24 17:23:51 +0200 | [diff] [blame] | 194 | int pcmcia_request_io(struct pcmcia_device *p_dev); |
Dominik Brodowski | eb14120 | 2010-03-07 12:21:16 +0100 | [diff] [blame] | 195 | |
Dominik Brodowski | b19a727 | 2010-03-20 13:10:47 +0100 | [diff] [blame] | 196 | int __must_check |
| 197 | __pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev, |
Dominik Brodowski | eb14120 | 2010-03-07 12:21:16 +0100 | [diff] [blame] | 198 | irq_handler_t handler); |
Dominik Brodowski | b19a727 | 2010-03-20 13:10:47 +0100 | [diff] [blame] | 199 | static inline __must_check __deprecated int |
| 200 | pcmcia_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 Brodowski | eb14120 | 2010-03-07 12:21:16 +0100 | [diff] [blame] | 206 | int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev, |
| 207 | irq_handler_t handler); |
| 208 | |
Dominik Brodowski | 994917f | 2008-08-31 15:20:26 +0200 | [diff] [blame] | 209 | int pcmcia_request_configuration(struct pcmcia_device *p_dev, |
| 210 | config_req_t *req); |
| 211 | |
Dominik Brodowski | 6838b03 | 2009-11-03 01:31:52 +0100 | [diff] [blame] | 212 | int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req, |
Dominik Brodowski | 994917f | 2008-08-31 15:20:26 +0200 | [diff] [blame] | 213 | window_handle_t *wh); |
Magnus Damm | f5560da | 2006-12-13 19:46:38 +0900 | [diff] [blame] | 214 | int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win); |
Magnus Damm | 868575d | 2006-12-13 19:46:43 +0900 | [diff] [blame] | 215 | int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win, |
Dominik Brodowski | b5cb259 | 2010-07-24 18:46:42 +0200 | [diff] [blame] | 216 | unsigned int offset); |
Dominik Brodowski | 994917f | 2008-08-31 15:20:26 +0200 | [diff] [blame] | 217 | |
| 218 | int pcmcia_modify_configuration(struct pcmcia_device *p_dev, modconf_t *mod); |
| 219 | void pcmcia_disable_device(struct pcmcia_device *p_dev); |
| 220 | |
Dominik Brodowski | 90abdc3 | 2010-07-24 17:23:51 +0200 | [diff] [blame] | 221 | /* 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 */ |
| 228 | static 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 237 | #endif /* __KERNEL__ */ |
Dominik Brodowski | a583578 | 2008-08-28 00:41:16 +0200 | [diff] [blame] | 238 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 239 | #endif /* _LINUX_DS_H */ |