pcmcia: merge ds_internal.h into cs_internal.h
[linux-2.6.git] / drivers / pcmcia / cs_internal.h
1 /*
2  * cs_internal.h -- definitions internal to the PCMCIA core modules
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
13  * (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.
19  */
20
21 #ifndef _LINUX_CS_INTERNAL_H
22 #define _LINUX_CS_INTERNAL_H
23
24 #include <linux/kref.h>
25
26 /* Flags in client state */
27 #define CLIENT_WIN_REQ(i)       (0x1<<(i))
28
29 /* Each card function gets one of these guys */
30 typedef struct config_t {
31         struct kref     ref;
32         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;
42 } config_t;
43
44
45 struct 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
53 /* Flags in config state */
54 #define CONFIG_LOCKED           0x01
55 #define CONFIG_IRQ_REQ          0x02
56 #define CONFIG_IO_REQ           0x04
57
58 /* Flags in socket state */
59 #define SOCKET_PRESENT          0x0008
60 #define SOCKET_INUSE            0x0010
61 #define SOCKET_SUSPEND          0x0080
62 #define SOCKET_WIN_REQ(i)       (0x0100<<(i))
63 #define SOCKET_CARDBUS          0x8000
64 #define SOCKET_CARDBUS_CONFIG   0x10000
65
66 static inline int cs_socket_get(struct pcmcia_socket *skt)
67 {
68         int ret;
69
70         WARN_ON(skt->state & SOCKET_INUSE);
71
72         ret = try_module_get(skt->owner);
73         if (ret)
74                 skt->state |= SOCKET_INUSE;
75         return ret;
76 }
77
78 static inline void cs_socket_put(struct pcmcia_socket *skt)
79 {
80         if (skt->state & SOCKET_INUSE) {
81                 skt->state &= ~SOCKET_INUSE;
82                 module_put(skt->owner);
83         }
84 }
85
86 #ifdef CONFIG_PCMCIA_DEBUG
87 extern int cs_debug_level(int);
88
89 #define cs_dbg(skt, lvl, fmt, arg...) do {              \
90         if (cs_debug_level(lvl))                        \
91                 dev_printk(KERN_DEBUG, &skt->dev,       \
92                  "cs: " fmt, ## arg);                   \
93 } while (0)
94 #define __cs_dbg(lvl, fmt, arg...) do {                 \
95         if (cs_debug_level(lvl))                        \
96                 printk(KERN_DEBUG                       \
97                  "cs: " fmt, ## arg);                   \
98 } while (0)
99
100 #else
101 #define cs_dbg(skt, lvl, fmt, arg...) do { } while (0)
102 #define __cs_dbg(lvl, fmt, arg...) do { } while (0)
103 #endif
104
105 #define cs_err(skt, fmt, arg...) \
106         dev_printk(KERN_ERR, &skt->dev, "cs: " fmt, ## arg)
107
108
109 /*
110  * Stuff internal to module "pcmcia_core":
111  */
112
113 /* cistpl.c */
114 int verify_cis_cache(struct pcmcia_socket *s);
115
116 /* rsrc_mgr.c */
117 void release_resource_db(struct pcmcia_socket *s);
118
119 /* socket_sysfs.c */
120 extern int pccard_sysfs_add_socket(struct device *dev);
121 extern void pccard_sysfs_remove_socket(struct device *dev);
122
123 /* cardbus.c */
124 int cb_alloc(struct pcmcia_socket *s);
125 void cb_free(struct pcmcia_socket *s);
126 int read_cb_mem(struct pcmcia_socket *s, int space, u_int addr, u_int len,
127                 void *ptr);
128
129
130
131 /*
132  * Stuff exported by module "pcmcia_core" to module "pcmcia"
133  */
134
135 struct pcmcia_callback{
136         struct module   *owner;
137         int             (*event) (struct pcmcia_socket *s,
138                                   event_t event, int priority);
139         void            (*requery) (struct pcmcia_socket *s, int new_cis);
140         int             (*suspend) (struct pcmcia_socket *s);
141         int             (*resume) (struct pcmcia_socket *s);
142 };
143
144 /* cs.c */
145 extern struct rw_semaphore pcmcia_socket_list_rwsem;
146 extern struct list_head pcmcia_socket_list;
147 int pcmcia_get_window(struct pcmcia_socket *s,
148                       window_handle_t *handle,
149                       int idx,
150                       win_req_t *req);
151 int pccard_reset_card(struct pcmcia_socket *skt);
152 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);
153
154 /* cistpl.c */
155 int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
156                         u_int addr, u_int len, void *ptr);
157 void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
158                           u_int addr, u_int len, void *ptr);
159 void release_cis_mem(struct pcmcia_socket *s);
160 void destroy_cis_cache(struct pcmcia_socket *s);
161 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
162                       cisdata_t code, void *parse);
163
164 /* rsrc_mgr.c */
165 int pcmcia_validate_mem(struct pcmcia_socket *s);
166 struct resource *pcmcia_find_io_region(unsigned long base,
167                                        int num,
168                                        unsigned long align,
169                                        struct pcmcia_socket *s);
170 int pcmcia_adjust_io_region(struct resource *res,
171                             unsigned long r_start,
172                             unsigned long r_end,
173                             struct pcmcia_socket *s);
174 struct resource *pcmcia_find_mem_region(u_long base,
175                                         u_long num,
176                                         u_long align,
177                                         int low,
178                                         struct pcmcia_socket *s);
179
180 /*
181  * Stuff internal to module "pcmcia".
182  */
183 /* ds.c */
184 extern struct bus_type pcmcia_bus_type;
185
186 /* pcmcia_resource.c */
187 extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
188
189 #ifdef CONFIG_PCMCIA_IOCTL
190 /* ds.c */
191 extern spinlock_t pcmcia_dev_list_lock;
192
193 extern struct pcmcia_device *pcmcia_get_dev(struct pcmcia_device *p_dev);
194 extern void pcmcia_put_dev(struct pcmcia_device *p_dev);
195
196 struct pcmcia_device *pcmcia_device_add(struct pcmcia_socket *s,
197                                         unsigned int function);
198
199 /* pcmcia_ioctl.c */
200 extern void __init pcmcia_setup_ioctl(void);
201 extern void __exit pcmcia_cleanup_ioctl(void);
202 extern void handle_event(struct pcmcia_socket *s, event_t event);
203 extern int handle_request(struct pcmcia_socket *s, event_t event);
204
205 #else /* CONFIG_PCMCIA_IOCTL */
206
207 static inline void __init pcmcia_setup_ioctl(void) { return; }
208 static inline void __exit pcmcia_cleanup_ioctl(void) { return; }
209 static inline void handle_event(struct pcmcia_socket *s, event_t event)
210 {
211         return;
212 }
213 static inline int handle_request(struct pcmcia_socket *s, event_t event)
214 {
215         return 0;
216 }
217
218 #endif /* CONFIG_PCMCIA_IOCTL */
219
220 #endif /* _LINUX_CS_INTERNAL_H */