pcmcia: use struct resource for PCMCIA devices
[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 - 2010      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
39         struct resource io[MAX_IO_WIN]; /* io ports */
40
41         struct {
42                 u_int   Attributes;
43         } irq;
44 } config_t;
45
46
47 struct cis_cache_entry {
48         struct list_head        node;
49         unsigned int            addr;
50         unsigned int            len;
51         unsigned int            attr;
52         unsigned char           cache[0];
53 };
54
55 struct pccard_resource_ops {
56         int     (*validate_mem)         (struct pcmcia_socket *s);
57         int     (*find_io)              (struct pcmcia_socket *s,
58                                          unsigned int attr,
59                                          unsigned int *base,
60                                          unsigned int num,
61                                          unsigned int align);
62         struct resource* (*find_mem)    (unsigned long base, unsigned long num,
63                                          unsigned long align, int low,
64                                          struct pcmcia_socket *s);
65         int     (*init)                 (struct pcmcia_socket *s);
66         void    (*exit)                 (struct pcmcia_socket *s);
67 };
68
69 /* Flags in config state */
70 #define CONFIG_LOCKED           0x01
71 #define CONFIG_IRQ_REQ          0x02
72 #define CONFIG_IO_REQ           0x04
73
74 /* Flags in socket state */
75 #define SOCKET_PRESENT          0x0008
76 #define SOCKET_INUSE            0x0010
77 #define SOCKET_SUSPEND          0x0080
78 #define SOCKET_WIN_REQ(i)       (0x0100<<(i))
79 #define SOCKET_CARDBUS          0x8000
80 #define SOCKET_CARDBUS_CONFIG   0x10000
81
82
83 /*
84  * Stuff internal to module "pcmcia_rsrc":
85  */
86 extern int static_init(struct pcmcia_socket *s);
87 extern struct resource *pcmcia_make_resource(unsigned long start,
88                                         unsigned long end,
89                                         int flags, const char *name);
90
91 /*
92  * Stuff internal to module "pcmcia_core":
93  */
94
95 /* socket_sysfs.c */
96 extern int pccard_sysfs_add_socket(struct device *dev);
97 extern void pccard_sysfs_remove_socket(struct device *dev);
98
99 /* cardbus.c */
100 int cb_alloc(struct pcmcia_socket *s);
101 void cb_free(struct pcmcia_socket *s);
102
103
104
105 /*
106  * Stuff exported by module "pcmcia_core" to module "pcmcia"
107  */
108
109 struct pcmcia_callback{
110         struct module   *owner;
111         int             (*add) (struct pcmcia_socket *s);
112         int             (*remove) (struct pcmcia_socket *s);
113         void            (*requery) (struct pcmcia_socket *s);
114         int             (*validate) (struct pcmcia_socket *s, unsigned int *i);
115         int             (*suspend) (struct pcmcia_socket *s);
116         int             (*early_resume) (struct pcmcia_socket *s);
117         int             (*resume) (struct pcmcia_socket *s);
118 };
119
120 /* cs.c */
121 extern struct rw_semaphore pcmcia_socket_list_rwsem;
122 extern struct list_head pcmcia_socket_list;
123 extern struct class pcmcia_socket_class;
124
125 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);
126 struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr);
127
128 void pcmcia_parse_uevents(struct pcmcia_socket *socket, unsigned int events);
129 #define PCMCIA_UEVENT_EJECT     0x0001
130 #define PCMCIA_UEVENT_INSERT    0x0002
131 #define PCMCIA_UEVENT_SUSPEND   0x0004
132 #define PCMCIA_UEVENT_RESUME    0x0008
133 #define PCMCIA_UEVENT_REQUERY   0x0010
134
135 struct pcmcia_socket *pcmcia_get_socket(struct pcmcia_socket *skt);
136 void pcmcia_put_socket(struct pcmcia_socket *skt);
137
138 /*
139  * Stuff internal to module "pcmcia".
140  */
141 /* ds.c */
142 extern struct bus_type pcmcia_bus_type;
143
144 struct pcmcia_device;
145
146 /* pcmcia_resource.c */
147 extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
148 extern int pcmcia_validate_mem(struct pcmcia_socket *s);
149 extern struct resource *pcmcia_find_mem_region(u_long base,
150                                                u_long num,
151                                                u_long align,
152                                                int low,
153                                                struct pcmcia_socket *s);
154
155 void pcmcia_cleanup_irq(struct pcmcia_socket *s);
156 int pcmcia_setup_irq(struct pcmcia_device *p_dev);
157
158 /* cistpl.c */
159 extern struct bin_attribute pccard_cis_attr;
160
161 int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
162                         u_int addr, u_int len, void *ptr);
163 int pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
164                         u_int addr, u_int len, void *ptr);
165 void release_cis_mem(struct pcmcia_socket *s);
166 void destroy_cis_cache(struct pcmcia_socket *s);
167 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
168                       cisdata_t code, void *parse);
169 int pcmcia_replace_cis(struct pcmcia_socket *s,
170                        const u8 *data, const size_t len);
171 int pccard_validate_cis(struct pcmcia_socket *s, unsigned int *count);
172 int verify_cis_cache(struct pcmcia_socket *s);
173
174 int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
175                       cisdata_t code, cisparse_t *parse, void *priv_data,
176                       int (*loop_tuple) (tuple_t *tuple,
177                                          cisparse_t *parse,
178                                          void *priv_data));
179
180 int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
181                         tuple_t *tuple);
182
183 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
184                         tuple_t *tuple);
185
186 int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple);
187
188 #endif /* _LINUX_CS_INTERNAL_H */