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