1 /*
2  * at91_cf.c -- AT91 CompactFlash controller driver
3  *
4  * Copyright (C) 2005 David Brownell
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  */
11 
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/platform_device.h>
15 #include <linux/errno.h>
16 #include <linux/init.h>
17 #include <linux/interrupt.h>
18 #include <linux/slab.h>
19 
20 #include <pcmcia/ss.h>
21 
22 #include <mach/hardware.h>
23 #include <asm/io.h>
24 #include <asm/sizes.h>
25 #include <asm/gpio.h>
26 
27 #include <mach/board.h>
28 #include <mach/at91rm9200_mc.h>
29 
30 
31 /*
32  * A0..A10 work in each range; A23 indicates I/O space;  A25 is CFRNW;
33  * some other bit in {A24,A22..A11} is nREG to flag memory access
34  * (vs attributes).  So more than 2KB/region would just be waste.
35  * Note: These are offsets from the physical base address.
36  */
37 #define	CF_ATTR_PHYS	(0)
38 #define	CF_IO_PHYS	(1 << 23)
39 #define	CF_MEM_PHYS	(0x017ff800)
40 
41 /*--------------------------------------------------------------------------*/
42 
43 static const char driver_name[] = "at91_cf";
44 
45 struct at91_cf_socket {
46 	struct pcmcia_socket	socket;
47 
48 	unsigned		present:1;
49 
50 	struct platform_device	*pdev;
51 	struct at91_cf_data	*board;
52 
53 	unsigned long		phys_baseaddr;
54 };
55 
at91_cf_present(struct at91_cf_socket * cf)56 static inline int at91_cf_present(struct at91_cf_socket *cf)
57 {
58 	return !gpio_get_value(cf->board->det_pin);
59 }
60 
61 /*--------------------------------------------------------------------------*/
62 
at91_cf_ss_init(struct pcmcia_socket * s)63 static int at91_cf_ss_init(struct pcmcia_socket *s)
64 {
65 	return 0;
66 }
67 
at91_cf_irq(int irq,void * _cf)68 static irqreturn_t at91_cf_irq(int irq, void *_cf)
69 {
70 	struct at91_cf_socket *cf = _cf;
71 
72 	if (irq == cf->board->det_pin) {
73 		unsigned present = at91_cf_present(cf);
74 
75 		/* kick pccard as needed */
76 		if (present != cf->present) {
77 			cf->present = present;
78 			pr_debug("%s: card %s\n", driver_name,
79 					present ? "present" : "gone");
80 			pcmcia_parse_events(&cf->socket, SS_DETECT);
81 		}
82 	}
83 
84 	return IRQ_HANDLED;
85 }
86 
at91_cf_get_status(struct pcmcia_socket * s,u_int * sp)87 static int at91_cf_get_status(struct pcmcia_socket *s, u_int *sp)
88 {
89 	struct at91_cf_socket	*cf;
90 
91 	if (!sp)
92 		return -EINVAL;
93 
94 	cf = container_of(s, struct at91_cf_socket, socket);
95 
96 	/* NOTE: CF is always 3VCARD */
97 	if (at91_cf_present(cf)) {
98 		int rdy	= cf->board->irq_pin;	/* RDY/nIRQ */
99 		int vcc	= cf->board->vcc_pin;
100 
101 		*sp = SS_DETECT | SS_3VCARD;
102 		if (!rdy || gpio_get_value(rdy))
103 			*sp |= SS_READY;
104 		if (!vcc || gpio_get_value(vcc))
105 			*sp |= SS_POWERON;
106 	} else
107 		*sp = 0;
108 
109 	return 0;
110 }
111 
112 static int
at91_cf_set_socket(struct pcmcia_socket * sock,struct socket_state_t * s)113 at91_cf_set_socket(struct pcmcia_socket *sock, struct socket_state_t *s)
114 {
115 	struct at91_cf_socket	*cf;
116 
117 	cf = container_of(sock, struct at91_cf_socket, socket);
118 
119 	/* switch Vcc if needed and possible */
120 	if (cf->board->vcc_pin) {
121 		switch (s->Vcc) {
122 			case 0:
123 				gpio_set_value(cf->board->vcc_pin, 0);
124 				break;
125 			case 33:
126 				gpio_set_value(cf->board->vcc_pin, 1);
127 				break;
128 			default:
129 				return -EINVAL;
130 		}
131 	}
132 
133 	/* toggle reset if needed */
134 	gpio_set_value(cf->board->rst_pin, s->flags & SS_RESET);
135 
136 	pr_debug("%s: Vcc %d, io_irq %d, flags %04x csc %04x\n",
137 		driver_name, s->Vcc, s->io_irq, s->flags, s->csc_mask);
138 
139 	return 0;
140 }
141 
at91_cf_ss_suspend(struct pcmcia_socket * s)142 static int at91_cf_ss_suspend(struct pcmcia_socket *s)
143 {
144 	return at91_cf_set_socket(s, &dead_socket);
145 }
146 
147 /* we already mapped the I/O region */
at91_cf_set_io_map(struct pcmcia_socket * s,struct pccard_io_map * io)148 static int at91_cf_set_io_map(struct pcmcia_socket *s, struct pccard_io_map *io)
149 {
150 	struct at91_cf_socket	*cf;
151 	u32			csr;
152 
153 	cf = container_of(s, struct at91_cf_socket, socket);
154 	io->flags &= (MAP_ACTIVE | MAP_16BIT | MAP_AUTOSZ);
155 
156 	/*
157 	 * Use 16 bit accesses unless/until we need 8-bit i/o space.
158 	 */
159 	csr = at91_sys_read(AT91_SMC_CSR(cf->board->chipselect)) & ~AT91_SMC_DBW;
160 
161 	/*
162 	 * NOTE: this CF controller ignores IOIS16, so we can't really do
163 	 * MAP_AUTOSZ.  The 16bit mode allows single byte access on either
164 	 * D0-D7 (even addr) or D8-D15 (odd), so it's close enough for many
165 	 * purposes (and handles ide-cs).
166 	 *
167 	 * The 8bit mode is needed for odd byte access on D0-D7.  It seems
168 	 * some cards only like that way to get at the odd byte, despite
169 	 * CF 3.0 spec table 35 also giving the D8-D15 option.
170 	 */
171 	if (!(io->flags & (MAP_16BIT | MAP_AUTOSZ))) {
172 		csr |= AT91_SMC_DBW_8;
173 		pr_debug("%s: 8bit i/o bus\n", driver_name);
174 	} else {
175 		csr |= AT91_SMC_DBW_16;
176 		pr_debug("%s: 16bit i/o bus\n", driver_name);
177 	}
178 	at91_sys_write(AT91_SMC_CSR(cf->board->chipselect), csr);
179 
180 	io->start = cf->socket.io_offset;
181 	io->stop = io->start + SZ_2K - 1;
182 
183 	return 0;
184 }
185 
186 /* pcmcia layer maps/unmaps mem regions */
187 static int
at91_cf_set_mem_map(struct pcmcia_socket * s,struct pccard_mem_map * map)188 at91_cf_set_mem_map(struct pcmcia_socket *s, struct pccard_mem_map *map)
189 {
190 	struct at91_cf_socket	*cf;
191 
192 	if (map->card_start)
193 		return -EINVAL;
194 
195 	cf = container_of(s, struct at91_cf_socket, socket);
196 
197 	map->flags &= (MAP_ACTIVE | MAP_ATTRIB | MAP_16BIT);
198 	if (map->flags & MAP_ATTRIB)
199 		map->static_start = cf->phys_baseaddr + CF_ATTR_PHYS;
200 	else
201 		map->static_start = cf->phys_baseaddr + CF_MEM_PHYS;
202 
203 	return 0;
204 }
205 
206 static struct pccard_operations at91_cf_ops = {
207 	.init			= at91_cf_ss_init,
208 	.suspend		= at91_cf_ss_suspend,
209 	.get_status		= at91_cf_get_status,
210 	.set_socket		= at91_cf_set_socket,
211 	.set_io_map		= at91_cf_set_io_map,
212 	.set_mem_map		= at91_cf_set_mem_map,
213 };
214 
215 /*--------------------------------------------------------------------------*/
216 
at91_cf_probe(struct platform_device * pdev)217 static int __init at91_cf_probe(struct platform_device *pdev)
218 {
219 	struct at91_cf_socket	*cf;
220 	struct at91_cf_data	*board = pdev->dev.platform_data;
221 	struct resource		*io;
222 	int			status;
223 
224 	if (!board || !board->det_pin || !board->rst_pin)
225 		return -ENODEV;
226 
227 	io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
228 	if (!io)
229 		return -ENODEV;
230 
231 	cf = kzalloc(sizeof *cf, GFP_KERNEL);
232 	if (!cf)
233 		return -ENOMEM;
234 
235 	cf->board = board;
236 	cf->pdev = pdev;
237 	cf->phys_baseaddr = io->start;
238 	platform_set_drvdata(pdev, cf);
239 
240 	/* must be a GPIO; ergo must trigger on both edges */
241 	status = gpio_request(board->det_pin, "cf_det");
242 	if (status < 0)
243 		goto fail0;
244 	status = request_irq(board->det_pin, at91_cf_irq, 0, driver_name, cf);
245 	if (status < 0)
246 		goto fail00;
247 	device_init_wakeup(&pdev->dev, 1);
248 
249 	status = gpio_request(board->rst_pin, "cf_rst");
250 	if (status < 0)
251 		goto fail0a;
252 
253 	if (board->vcc_pin) {
254 		status = gpio_request(board->vcc_pin, "cf_vcc");
255 		if (status < 0)
256 			goto fail0b;
257 	}
258 
259 	/*
260 	 * The card driver will request this irq later as needed.
261 	 * but it causes lots of "irqNN: nobody cared" messages
262 	 * unless we report that we handle everything (sigh).
263 	 * (Note:  DK board doesn't wire the IRQ pin...)
264 	 */
265 	if (board->irq_pin) {
266 		status = gpio_request(board->irq_pin, "cf_irq");
267 		if (status < 0)
268 			goto fail0c;
269 		status = request_irq(board->irq_pin, at91_cf_irq,
270 				IRQF_SHARED, driver_name, cf);
271 		if (status < 0)
272 			goto fail0d;
273 		cf->socket.pci_irq = board->irq_pin;
274 	} else
275 		cf->socket.pci_irq = nr_irqs + 1;
276 
277 	/* pcmcia layer only remaps "real" memory not iospace */
278 	cf->socket.io_offset = (unsigned long)
279 			ioremap(cf->phys_baseaddr + CF_IO_PHYS, SZ_2K);
280 	if (!cf->socket.io_offset) {
281 		status = -ENXIO;
282 		goto fail1;
283 	}
284 
285 	/* reserve chip-select regions */
286 	if (!request_mem_region(io->start, resource_size(io), driver_name)) {
287 		status = -ENXIO;
288 		goto fail1;
289 	}
290 
291 	pr_info("%s: irqs det #%d, io #%d\n", driver_name,
292 		board->det_pin, board->irq_pin);
293 
294 	cf->socket.owner = THIS_MODULE;
295 	cf->socket.dev.parent = &pdev->dev;
296 	cf->socket.ops = &at91_cf_ops;
297 	cf->socket.resource_ops = &pccard_static_ops;
298 	cf->socket.features = SS_CAP_PCCARD | SS_CAP_STATIC_MAP
299 				| SS_CAP_MEM_ALIGN;
300 	cf->socket.map_size = SZ_2K;
301 	cf->socket.io[0].res = io;
302 
303 	status = pcmcia_register_socket(&cf->socket);
304 	if (status < 0)
305 		goto fail2;
306 
307 	return 0;
308 
309 fail2:
310 	release_mem_region(io->start, resource_size(io));
311 fail1:
312 	if (cf->socket.io_offset)
313 		iounmap((void __iomem *) cf->socket.io_offset);
314 	if (board->irq_pin) {
315 		free_irq(board->irq_pin, cf);
316 fail0d:
317 		gpio_free(board->irq_pin);
318 	}
319 fail0c:
320 	if (board->vcc_pin)
321 		gpio_free(board->vcc_pin);
322 fail0b:
323 	gpio_free(board->rst_pin);
324 fail0a:
325 	device_init_wakeup(&pdev->dev, 0);
326 	free_irq(board->det_pin, cf);
327 fail00:
328 	gpio_free(board->det_pin);
329 fail0:
330 	kfree(cf);
331 	return status;
332 }
333 
at91_cf_remove(struct platform_device * pdev)334 static int __exit at91_cf_remove(struct platform_device *pdev)
335 {
336 	struct at91_cf_socket	*cf = platform_get_drvdata(pdev);
337 	struct at91_cf_data	*board = cf->board;
338 	struct resource		*io = cf->socket.io[0].res;
339 
340 	pcmcia_unregister_socket(&cf->socket);
341 	release_mem_region(io->start, resource_size(io));
342 	iounmap((void __iomem *) cf->socket.io_offset);
343 	if (board->irq_pin) {
344 		free_irq(board->irq_pin, cf);
345 		gpio_free(board->irq_pin);
346 	}
347 	if (board->vcc_pin)
348 		gpio_free(board->vcc_pin);
349 	gpio_free(board->rst_pin);
350 	device_init_wakeup(&pdev->dev, 0);
351 	free_irq(board->det_pin, cf);
352 	gpio_free(board->det_pin);
353 	kfree(cf);
354 	return 0;
355 }
356 
357 #ifdef	CONFIG_PM
358 
at91_cf_suspend(struct platform_device * pdev,pm_message_t mesg)359 static int at91_cf_suspend(struct platform_device *pdev, pm_message_t mesg)
360 {
361 	struct at91_cf_socket	*cf = platform_get_drvdata(pdev);
362 	struct at91_cf_data	*board = cf->board;
363 
364 	if (device_may_wakeup(&pdev->dev)) {
365 		enable_irq_wake(board->det_pin);
366 		if (board->irq_pin)
367 			enable_irq_wake(board->irq_pin);
368 	}
369 	return 0;
370 }
371 
at91_cf_resume(struct platform_device * pdev)372 static int at91_cf_resume(struct platform_device *pdev)
373 {
374 	struct at91_cf_socket	*cf = platform_get_drvdata(pdev);
375 	struct at91_cf_data	*board = cf->board;
376 
377 	if (device_may_wakeup(&pdev->dev)) {
378 		disable_irq_wake(board->det_pin);
379 		if (board->irq_pin)
380 			disable_irq_wake(board->irq_pin);
381 	}
382 
383 	return 0;
384 }
385 
386 #else
387 #define	at91_cf_suspend		NULL
388 #define	at91_cf_resume		NULL
389 #endif
390 
391 static struct platform_driver at91_cf_driver = {
392 	.driver = {
393 		.name		= (char *) driver_name,
394 		.owner		= THIS_MODULE,
395 	},
396 	.remove		= __exit_p(at91_cf_remove),
397 	.suspend	= at91_cf_suspend,
398 	.resume		= at91_cf_resume,
399 };
400 
401 /*--------------------------------------------------------------------------*/
402 
at91_cf_init(void)403 static int __init at91_cf_init(void)
404 {
405 	return platform_driver_probe(&at91_cf_driver, at91_cf_probe);
406 }
407 module_init(at91_cf_init);
408 
at91_cf_exit(void)409 static void __exit at91_cf_exit(void)
410 {
411 	platform_driver_unregister(&at91_cf_driver);
412 }
413 module_exit(at91_cf_exit);
414 
415 MODULE_DESCRIPTION("AT91 Compact Flash Driver");
416 MODULE_AUTHOR("David Brownell");
417 MODULE_LICENSE("GPL");
418 MODULE_ALIAS("platform:at91_cf");
419