[PATCH] pcmcia: merge suspend into device model
[linux-2.6.git] / drivers / pcmcia / cs_internal.h
1 /*
2  * cs_internal.h
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  */
14
15 #ifndef _LINUX_CS_INTERNAL_H
16 #define _LINUX_CS_INTERNAL_H
17
18 #include <linux/config.h>
19
20 /* Flags in client state */
21 #define CLIENT_CONFIG_LOCKED    0x0001
22 #define CLIENT_IRQ_REQ          0x0002
23 #define CLIENT_IO_REQ           0x0004
24 #define CLIENT_UNBOUND          0x0008
25 #define CLIENT_STALE            0x0010
26 #define CLIENT_WIN_REQ(i)       (0x20<<(i))
27 #define CLIENT_CARDBUS          0x8000
28
29 #define REGION_MAGIC    0xE3C9
30 typedef struct region_t {
31     u_short             region_magic;
32     u_short             state;
33     dev_info_t          dev_info;
34     client_handle_t     mtd;
35     u_int               MediaID;
36     region_info_t       info;
37 } region_t;
38
39 #define REGION_STALE    0x01
40
41 /* Each card function gets one of these guys */
42 typedef struct config_t {
43     u_int               state;
44     u_int               Attributes;
45     u_int               IntType;
46     u_int               ConfigBase;
47     u_char              Status, Pin, Copy, Option, ExtStatus;
48     u_int               Present;
49     u_int               CardValues;
50     io_req_t            io;
51     struct {
52         u_int           Attributes;
53     } irq;
54 } config_t;
55
56 struct cis_cache_entry {
57         struct list_head        node;
58         unsigned int            addr;
59         unsigned int            len;
60         unsigned int            attr;
61         unsigned char           cache[0];
62 };
63
64 /* Flags in config state */
65 #define CONFIG_LOCKED           0x01
66 #define CONFIG_IRQ_REQ          0x02
67 #define CONFIG_IO_REQ           0x04
68
69 /* Flags in socket state */
70 #define SOCKET_PRESENT          0x0008
71 #define SOCKET_INUSE            0x0010
72 #define SOCKET_SUSPEND          0x0080
73 #define SOCKET_WIN_REQ(i)       (0x0100<<(i))
74 #define SOCKET_REGION_INFO      0x4000
75 #define SOCKET_CARDBUS          0x8000
76 #define SOCKET_CARDBUS_CONFIG   0x10000
77
78 static inline int cs_socket_get(struct pcmcia_socket *skt)
79 {
80         int ret;
81
82         WARN_ON(skt->state & SOCKET_INUSE);
83
84         ret = try_module_get(skt->owner);
85         if (ret)
86                 skt->state |= SOCKET_INUSE;
87         return ret;
88 }
89
90 static inline void cs_socket_put(struct pcmcia_socket *skt)
91 {
92         if (skt->state & SOCKET_INUSE) {
93                 skt->state &= ~SOCKET_INUSE;
94                 module_put(skt->owner);
95         }
96 }
97
98 #define CHECK_SOCKET(s) \
99     (((s) >= sockets) || (socket_table[s]->ops == NULL))
100
101 #define SOCKET(h) (h->socket)
102 #define CONFIG(h) (&SOCKET(h)->config[(h)->func])
103
104 /* In cardbus.c */
105 int cb_alloc(struct pcmcia_socket *s);
106 void cb_free(struct pcmcia_socket *s);
107 int read_cb_mem(struct pcmcia_socket *s, int space, u_int addr, u_int len, void *ptr);
108
109 /* In cistpl.c */
110 int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
111                  u_int addr, u_int len, void *ptr);
112 void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
113                    u_int addr, u_int len, void *ptr);
114 void release_cis_mem(struct pcmcia_socket *s);
115 void destroy_cis_cache(struct pcmcia_socket *s);
116 int verify_cis_cache(struct pcmcia_socket *s);
117 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function, cisdata_t code, void *parse);
118
119 /* In rsrc_mgr */
120 int pcmcia_validate_mem(struct pcmcia_socket *s);
121 struct resource *pcmcia_find_io_region(unsigned long base, int num, unsigned long align,
122                    struct pcmcia_socket *s);
123 int pcmcia_adjust_io_region(struct resource *res, unsigned long r_start,
124                      unsigned long r_end, struct pcmcia_socket *s);
125 struct resource *pcmcia_find_mem_region(u_long base, u_long num, u_long align,
126                     int low, struct pcmcia_socket *s);
127 void release_resource_db(struct pcmcia_socket *s);
128
129 /* In socket_sysfs.c */
130 extern struct class_interface pccard_sysfs_interface;
131
132 /* In cs.c */
133 extern struct rw_semaphore pcmcia_socket_list_rwsem;
134 extern struct list_head pcmcia_socket_list;
135 int pcmcia_get_window(struct pcmcia_socket *s, window_handle_t *handle, int idx, win_req_t *req);
136 int pccard_get_configuration_info(struct pcmcia_socket *s, unsigned int function, config_info_t *config);
137 int pccard_reset_card(struct pcmcia_socket *skt);
138 int pccard_get_status(struct pcmcia_socket *s, unsigned int function, cs_status_t *status);
139 int pccard_access_configuration_register(struct pcmcia_socket *s, unsigned int function, conf_reg_t *reg);
140
141
142 struct pcmcia_callback{
143         struct module   *owner;
144         int             (*event) (struct pcmcia_socket *s, event_t event, int priority);
145         void            (*requery) (struct pcmcia_socket *s);
146         int             (*suspend) (struct pcmcia_socket *s);
147         int             (*resume) (struct pcmcia_socket *s);
148 };
149
150 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);
151
152 #define cs_socket_name(skt)     ((skt)->dev.class_id)
153
154 #ifdef DEBUG
155 extern int cs_debug_level(int);
156
157 #define cs_dbg(skt, lvl, fmt, arg...) do {              \
158         if (cs_debug_level(lvl))                        \
159                 printk(KERN_DEBUG "cs: %s: " fmt,       \
160                        cs_socket_name(skt) , ## arg);   \
161 } while (0)
162
163 #else
164 #define cs_dbg(skt, lvl, fmt, arg...) do { } while (0)
165 #endif
166
167 #define cs_err(skt, fmt, arg...) \
168         printk(KERN_ERR "cs: %s: " fmt, (skt)->dev.class_id , ## arg)
169
170 #endif /* _LINUX_CS_INTERNAL_H */