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