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