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