blob: 0a3ada970bf876436434675bc9197ef295858fa1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Dominik Brodowskidc953e52008-08-25 23:18:20 +02002 * cs_internal.h -- definitions internal to the PCMCIA core modules
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
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 Brodowskidc953e52008-08-25 23:18:20 +020013 * (C) 2003 - 2008 Dominik Brodowski
14 *
15 *
16 * This file contains definitions _only_ needed by the PCMCIA core modules.
17 * It must not be included by PCMCIA socket drivers or by PCMCIA device
18 * drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 */
20
21#ifndef _LINUX_CS_INTERNAL_H
22#define _LINUX_CS_INTERNAL_H
23
Dominik Brodowski360b65b2006-01-10 20:50:39 +010024#include <linux/kref.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/* Flags in client state */
Dominik Brodowskie2d40962006-03-02 00:09:29 +010027#define CLIENT_WIN_REQ(i) (0x1<<(i))
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/* Each card function gets one of these guys */
30typedef struct config_t {
Dominik Brodowski360b65b2006-01-10 20:50:39 +010031 struct kref ref;
Dominik Brodowskidc953e52008-08-25 23:18:20 +020032 unsigned int state;
33 unsigned int Attributes;
34 unsigned int IntType;
35 unsigned int ConfigBase;
36 unsigned char Status, Pin, Copy, Option, ExtStatus;
37 unsigned int CardValues;
38 io_req_t io;
39 struct {
40 u_int Attributes;
41 } irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042} config_t;
43
Dominik Brodowskidc953e52008-08-25 23:18:20 +020044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045struct cis_cache_entry {
46 struct list_head node;
47 unsigned int addr;
48 unsigned int len;
49 unsigned int attr;
50 unsigned char cache[0];
51};
52
Dominik Brodowskic23889c2008-08-26 00:09:56 +020053struct pccard_resource_ops {
54 int (*validate_mem) (struct pcmcia_socket *s);
55 int (*adjust_io_region) (struct resource *res,
56 unsigned long r_start,
57 unsigned long r_end,
58 struct pcmcia_socket *s);
59 struct resource* (*find_io) (unsigned long base, int num,
60 unsigned long align,
61 struct pcmcia_socket *s);
62 struct resource* (*find_mem) (unsigned long base, unsigned long num,
63 unsigned long align, int low,
64 struct pcmcia_socket *s);
65 int (*add_io) (struct pcmcia_socket *s,
66 unsigned int action,
67 unsigned long r_start,
68 unsigned long r_end);
69 int (*add_mem) (struct pcmcia_socket *s,
70 unsigned int action,
71 unsigned long r_start,
72 unsigned long r_end);
73 int (*init) (struct pcmcia_socket *s);
74 void (*exit) (struct pcmcia_socket *s);
75};
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/* Flags in config state */
78#define CONFIG_LOCKED 0x01
79#define CONFIG_IRQ_REQ 0x02
80#define CONFIG_IO_REQ 0x04
81
82/* Flags in socket state */
83#define SOCKET_PRESENT 0x0008
84#define SOCKET_INUSE 0x0010
85#define SOCKET_SUSPEND 0x0080
86#define SOCKET_WIN_REQ(i) (0x0100<<(i))
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#define SOCKET_CARDBUS 0x8000
88#define SOCKET_CARDBUS_CONFIG 0x10000
89
90static inline int cs_socket_get(struct pcmcia_socket *skt)
91{
92 int ret;
93
94 WARN_ON(skt->state & SOCKET_INUSE);
95
96 ret = try_module_get(skt->owner);
97 if (ret)
98 skt->state |= SOCKET_INUSE;
99 return ret;
100}
101
102static inline void cs_socket_put(struct pcmcia_socket *skt)
103{
104 if (skt->state & SOCKET_INUSE) {
105 skt->state &= ~SOCKET_INUSE;
106 module_put(skt->owner);
107 }
108}
109
Dominik Brodowskidc953e52008-08-25 23:18:20 +0200110
111/*
112 * Stuff internal to module "pcmcia_core":
113 */
114
115/* cistpl.c */
116int verify_cis_cache(struct pcmcia_socket *s);
117
118/* rsrc_mgr.c */
119void release_resource_db(struct pcmcia_socket *s);
120
121/* socket_sysfs.c */
122extern int pccard_sysfs_add_socket(struct device *dev);
123extern void pccard_sysfs_remove_socket(struct device *dev);
124
125/* cardbus.c */
126int cb_alloc(struct pcmcia_socket *s);
127void cb_free(struct pcmcia_socket *s);
128int read_cb_mem(struct pcmcia_socket *s, int space, u_int addr, u_int len,
129 void *ptr);
130
131
132
133/*
134 * Stuff exported by module "pcmcia_core" to module "pcmcia"
135 */
136
137struct pcmcia_callback{
138 struct module *owner;
139 int (*event) (struct pcmcia_socket *s,
140 event_t event, int priority);
141 void (*requery) (struct pcmcia_socket *s, int new_cis);
142 int (*suspend) (struct pcmcia_socket *s);
143 int (*resume) (struct pcmcia_socket *s);
144};
145
146/* cs.c */
147extern struct rw_semaphore pcmcia_socket_list_rwsem;
148extern struct list_head pcmcia_socket_list;
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200149extern struct class pcmcia_socket_class;
150
Dominik Brodowskidc953e52008-08-25 23:18:20 +0200151int pcmcia_get_window(struct pcmcia_socket *s,
152 window_handle_t *handle,
153 int idx,
154 win_req_t *req);
Dominik Brodowskidc953e52008-08-25 23:18:20 +0200155int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);
Dominik Brodowskic23889c2008-08-26 00:09:56 +0200156struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr);
Dominik Brodowskidc953e52008-08-25 23:18:20 +0200157
Dominik Brodowski994917f2008-08-31 15:20:26 +0200158int pcmcia_suspend_card(struct pcmcia_socket *skt);
159int pcmcia_resume_card(struct pcmcia_socket *skt);
160
161int pcmcia_eject_card(struct pcmcia_socket *skt);
162int pcmcia_insert_card(struct pcmcia_socket *skt);
163
164struct pcmcia_socket *pcmcia_get_socket(struct pcmcia_socket *skt);
165void pcmcia_put_socket(struct pcmcia_socket *skt);
166
Dominik Brodowskidc953e52008-08-25 23:18:20 +0200167/* cistpl.c */
168int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
169 u_int addr, u_int len, void *ptr);
170void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
171 u_int addr, u_int len, void *ptr);
172void release_cis_mem(struct pcmcia_socket *s);
173void destroy_cis_cache(struct pcmcia_socket *s);
174int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
175 cisdata_t code, void *parse);
Dominik Brodowski994917f2008-08-31 15:20:26 +0200176int pcmcia_replace_cis(struct pcmcia_socket *s,
177 const u8 *data, const size_t len);
Dominik Brodowski84897fc2009-10-18 23:51:09 +0200178int pccard_validate_cis(struct pcmcia_socket *s, unsigned int *count);
Dominik Brodowskidc953e52008-08-25 23:18:20 +0200179
Dominik Brodowski91284222009-10-18 23:32:33 +0200180/* loop over CIS entries */
181int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
182 cisdata_t code, cisparse_t *parse, void *priv_data,
183 int (*loop_tuple) (tuple_t *tuple,
184 cisparse_t *parse,
185 void *priv_data));
186
Dominik Brodowski18a7a19b2009-10-19 00:07:39 +0200187int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
188 tuple_t *tuple);
189
190int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
191 tuple_t *tuple);
192
193int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple);
194
195
Dominik Brodowskidc953e52008-08-25 23:18:20 +0200196/* rsrc_mgr.c */
197int pcmcia_validate_mem(struct pcmcia_socket *s);
198struct resource *pcmcia_find_io_region(unsigned long base,
199 int num,
200 unsigned long align,
201 struct pcmcia_socket *s);
202int pcmcia_adjust_io_region(struct resource *res,
203 unsigned long r_start,
204 unsigned long r_end,
205 struct pcmcia_socket *s);
206struct resource *pcmcia_find_mem_region(u_long base,
207 u_long num,
208 u_long align,
209 int low,
210 struct pcmcia_socket *s);
211
Dominik Brodowskib60a5ed2008-08-25 23:32:37 +0200212/*
213 * Stuff internal to module "pcmcia".
214 */
215/* ds.c */
216extern struct bus_type pcmcia_bus_type;
217
218/* pcmcia_resource.c */
219extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
220
221#ifdef CONFIG_PCMCIA_IOCTL
222/* ds.c */
223extern spinlock_t pcmcia_dev_list_lock;
224
225extern struct pcmcia_device *pcmcia_get_dev(struct pcmcia_device *p_dev);
226extern void pcmcia_put_dev(struct pcmcia_device *p_dev);
227
228struct pcmcia_device *pcmcia_device_add(struct pcmcia_socket *s,
229 unsigned int function);
230
231/* pcmcia_ioctl.c */
232extern void __init pcmcia_setup_ioctl(void);
233extern void __exit pcmcia_cleanup_ioctl(void);
234extern void handle_event(struct pcmcia_socket *s, event_t event);
235extern int handle_request(struct pcmcia_socket *s, event_t event);
236
237#else /* CONFIG_PCMCIA_IOCTL */
238
239static inline void __init pcmcia_setup_ioctl(void) { return; }
240static inline void __exit pcmcia_cleanup_ioctl(void) { return; }
241static inline void handle_event(struct pcmcia_socket *s, event_t event)
242{
243 return;
244}
245static inline int handle_request(struct pcmcia_socket *s, event_t event)
246{
247 return 0;
248}
249
250#endif /* CONFIG_PCMCIA_IOCTL */
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#endif /* _LINUX_CS_INTERNAL_H */