Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | /* |
3 | * linux/drivers/pcmcia/soc_common.h | |
4 | * | |
5 | * Copyright (C) 2000 John G Dorsey <john+@cs.cmu.edu> | |
6 | * | |
7 | * This file contains definitions for the PCMCIA support code common to | |
8 | * integrated SOCs like the SA-11x0 and PXA2xx microprocessors. | |
9 | */ | |
10 | #ifndef _ASM_ARCH_PCMCIA | |
11 | #define _ASM_ARCH_PCMCIA | |
12 | ||
13 | /* include the world */ | |
2a125dd5 | 14 | #include <linux/clk.h> |
1da177e4 | 15 | #include <linux/cpufreq.h> |
1da177e4 | 16 | #include <pcmcia/ss.h> |
1da177e4 | 17 | #include <pcmcia/cistpl.h> |
1da177e4 LT |
18 | |
19 | ||
20 | struct device; | |
45ca7536 | 21 | struct gpio_desc; |
1da177e4 | 22 | struct pcmcia_low_level; |
ac61b600 RK |
23 | struct regulator; |
24 | ||
25 | struct soc_pcmcia_regulator { | |
26 | struct regulator *reg; | |
27 | bool on; | |
28 | }; | |
1da177e4 LT |
29 | |
30 | /* | |
31 | * This structure encapsulates per-socket state which we might need to | |
32 | * use when responding to a Card Services query of some kind. | |
33 | */ | |
34 | struct soc_pcmcia_socket { | |
35 | struct pcmcia_socket socket; | |
36 | ||
37 | /* | |
38 | * Info from low level handler | |
39 | */ | |
1da177e4 | 40 | unsigned int nr; |
2a125dd5 | 41 | struct clk *clk; |
1da177e4 LT |
42 | |
43 | /* | |
44 | * Core PCMCIA state | |
45 | */ | |
b62d99b5 | 46 | const struct pcmcia_low_level *ops; |
1da177e4 LT |
47 | |
48 | unsigned int status; | |
49 | socket_state_t cs_state; | |
50 | ||
51 | unsigned short spd_io[MAX_IO_WIN]; | |
52 | unsigned short spd_mem[MAX_WIN]; | |
53 | unsigned short spd_attr[MAX_WIN]; | |
54 | ||
55 | struct resource res_skt; | |
56 | struct resource res_io; | |
57 | struct resource res_mem; | |
58 | struct resource res_attr; | |
59 | void __iomem *virt_io; | |
60 | ||
d9dc8787 RK |
61 | struct { |
62 | int gpio; | |
45ca7536 | 63 | struct gpio_desc *desc; |
d9dc8787 RK |
64 | unsigned int irq; |
65 | const char *name; | |
5805271d | 66 | } stat[6]; |
d9dc8787 RK |
67 | #define SOC_STAT_CD 0 /* Card detect */ |
68 | #define SOC_STAT_BVD1 1 /* BATDEAD / IOSTSCHG */ | |
69 | #define SOC_STAT_BVD2 2 /* BATWARN / IOSPKR */ | |
70 | #define SOC_STAT_RDY 3 /* Ready / Interrupt */ | |
5805271d RK |
71 | #define SOC_STAT_VS1 4 /* Voltage sense 1 */ |
72 | #define SOC_STAT_VS2 5 /* Voltage sense 2 */ | |
d9dc8787 | 73 | |
535e0abc RK |
74 | struct gpio_desc *gpio_reset; |
75 | struct gpio_desc *gpio_bus_enable; | |
ac61b600 RK |
76 | struct soc_pcmcia_regulator vcc; |
77 | struct soc_pcmcia_regulator vpp; | |
535e0abc | 78 | |
1da177e4 LT |
79 | unsigned int irq_state; |
80 | ||
fb8c9959 RK |
81 | #ifdef CONFIG_CPU_FREQ |
82 | struct notifier_block cpufreq_nb; | |
83 | #endif | |
1da177e4 LT |
84 | struct timer_list poll_timer; |
85 | struct list_head node; | |
4a5d67d7 | 86 | void *driver_data; |
1da177e4 LT |
87 | }; |
88 | ||
b393c696 EM |
89 | struct skt_dev_info { |
90 | int nskt; | |
af741b0b | 91 | struct soc_pcmcia_socket skt[]; |
b393c696 EM |
92 | }; |
93 | ||
1da177e4 LT |
94 | struct pcmcia_state { |
95 | unsigned detect: 1, | |
96 | ready: 1, | |
97 | bvd1: 1, | |
98 | bvd2: 1, | |
99 | wrprot: 1, | |
100 | vs_3v: 1, | |
101 | vs_Xv: 1; | |
102 | }; | |
103 | ||
104 | struct pcmcia_low_level { | |
105 | struct module *owner; | |
106 | ||
107 | /* first socket in system */ | |
108 | int first; | |
109 | /* nr of sockets */ | |
110 | int nr; | |
111 | ||
112 | int (*hw_init)(struct soc_pcmcia_socket *); | |
113 | void (*hw_shutdown)(struct soc_pcmcia_socket *); | |
114 | ||
115 | void (*socket_state)(struct soc_pcmcia_socket *, struct pcmcia_state *); | |
116 | int (*configure_socket)(struct soc_pcmcia_socket *, const socket_state_t *); | |
117 | ||
118 | /* | |
119 | * Enable card status IRQs on (re-)initialisation. This can | |
120 | * be called at initialisation, power management event, or | |
121 | * pcmcia event. | |
122 | */ | |
123 | void (*socket_init)(struct soc_pcmcia_socket *); | |
124 | ||
125 | /* | |
126 | * Disable card status IRQs and PCMCIA bus on suspend. | |
127 | */ | |
128 | void (*socket_suspend)(struct soc_pcmcia_socket *); | |
129 | ||
130 | /* | |
131 | * Hardware specific timing routines. | |
132 | * If provided, the get_timing routine overrides the SOC default. | |
133 | */ | |
134 | unsigned int (*get_timing)(struct soc_pcmcia_socket *, unsigned int, unsigned int); | |
135 | int (*set_timing)(struct soc_pcmcia_socket *); | |
136 | int (*show_timing)(struct soc_pcmcia_socket *, char *); | |
137 | ||
138 | #ifdef CONFIG_CPU_FREQ | |
139 | /* | |
140 | * CPUFREQ support. | |
141 | */ | |
142 | int (*frequency_change)(struct soc_pcmcia_socket *, unsigned long, struct cpufreq_freqs *); | |
143 | #endif | |
144 | }; | |
145 | ||
146 | ||
1da177e4 LT |
147 | struct soc_pcmcia_timing { |
148 | unsigned short io; | |
149 | unsigned short mem; | |
150 | unsigned short attr; | |
151 | }; | |
152 | ||
1da177e4 LT |
153 | extern void soc_common_pcmcia_get_timing(struct soc_pcmcia_socket *, struct soc_pcmcia_timing *); |
154 | ||
e0d21178 | 155 | void soc_pcmcia_init_one(struct soc_pcmcia_socket *skt, |
c8f9ce55 | 156 | const struct pcmcia_low_level *ops, struct device *dev); |
097e296d RKAL |
157 | void soc_pcmcia_remove_one(struct soc_pcmcia_socket *skt); |
158 | int soc_pcmcia_add_one(struct soc_pcmcia_socket *skt); | |
45ca7536 | 159 | int soc_pcmcia_request_gpiods(struct soc_pcmcia_socket *skt); |
1da177e4 | 160 | |
a1d05002 RK |
161 | void soc_common_cf_socket_state(struct soc_pcmcia_socket *skt, |
162 | struct pcmcia_state *state); | |
1da177e4 | 163 | |
ac61b600 RK |
164 | int soc_pcmcia_regulator_set(struct soc_pcmcia_socket *skt, |
165 | struct soc_pcmcia_regulator *r, int v); | |
166 | ||
7d16b658 | 167 | #ifdef CONFIG_PCMCIA_DEBUG |
1da177e4 LT |
168 | |
169 | extern void soc_pcmcia_debug(struct soc_pcmcia_socket *skt, const char *func, | |
170 | int lvl, const char *fmt, ...); | |
171 | ||
172 | #define debug(skt, lvl, fmt, arg...) \ | |
173 | soc_pcmcia_debug(skt, __func__, lvl, fmt , ## arg) | |
174 | ||
175 | #else | |
176 | #define debug(skt, lvl, fmt, arg...) do { } while (0) | |
177 | #endif | |
178 | ||
179 | ||
180 | /* | |
181 | * The PC Card Standard, Release 7, section 4.13.4, says that twIORD | |
182 | * has a minimum value of 165ns. Section 4.13.5 says that twIOWR has | |
183 | * a minimum value of 165ns, as well. Section 4.7.2 (describing | |
184 | * common and attribute memory write timing) says that twWE has a | |
185 | * minimum value of 150ns for a 250ns cycle time (for 5V operation; | |
186 | * see section 4.7.4), or 300ns for a 600ns cycle time (for 3.3V | |
187 | * operation, also section 4.7.4). Section 4.7.3 says that taOE | |
188 | * has a maximum value of 150ns for a 300ns cycle time (for 5V | |
189 | * operation), or 300ns for a 600ns cycle time (for 3.3V operation). | |
190 | * | |
191 | * When configuring memory maps, Card Services appears to adopt the policy | |
192 | * that a memory access time of "0" means "use the default." The default | |
193 | * PCMCIA I/O command width time is 165ns. The default PCMCIA 5V attribute | |
194 | * and memory command width time is 150ns; the PCMCIA 3.3V attribute and | |
195 | * memory command width time is 300ns. | |
196 | */ | |
197 | #define SOC_PCMCIA_IO_ACCESS (165) | |
198 | #define SOC_PCMCIA_5V_MEM_ACCESS (150) | |
199 | #define SOC_PCMCIA_3V_MEM_ACCESS (300) | |
200 | #define SOC_PCMCIA_ATTR_MEM_ACCESS (300) | |
201 | ||
202 | /* | |
203 | * The socket driver actually works nicely in interrupt-driven form, | |
204 | * so the (relatively infrequent) polling is "just to be sure." | |
205 | */ | |
206 | #define SOC_PCMCIA_POLL_PERIOD (2*HZ) | |
207 | ||
208 | ||
209 | /* I/O pins replacing memory pins | |
210 | * (PCMCIA System Architecture, 2nd ed., by Don Anderson, p.75) | |
211 | * | |
212 | * These signals change meaning when going from memory-only to | |
213 | * memory-or-I/O interface: | |
214 | */ | |
215 | #define iostschg bvd1 | |
216 | #define iospkr bvd2 | |
217 | ||
218 | #endif |