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