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#include <linux/gpio.h>
20#include <linux/platform_data/atmel.h>
21#include <linux/io.h>
22#include <linux/sizes.h>
23#include <linux/of.h>
24#include <linux/of_device.h>
25#include <linux/of_gpio.h>
26
27#include <pcmcia/ss.h>
28
29#include <mach/at91rm9200_mc.h>
30#include <mach/at91_ramc.h>
31
32
33/*
34 * A0..A10 work in each range; A23 indicates I/O space;  A25 is CFRNW;
35 * some other bit in {A24,A22..A11} is nREG to flag memory access
36 * (vs attributes).  So more than 2KB/region would just be waste.
37 * Note: These are offsets from the physical base address.
38 */
39#define	CF_ATTR_PHYS	(0)
40#define	CF_IO_PHYS	(1 << 23)
41#define	CF_MEM_PHYS	(0x017ff800)
42
43/*--------------------------------------------------------------------------*/
44
45struct 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
56static inline int at91_cf_present(struct at91_cf_socket *cf)
57{
58	return !gpio_get_value(cf->board->det_pin);
59}
60
61/*--------------------------------------------------------------------------*/
62
63static int at91_cf_ss_init(struct pcmcia_socket *s)
64{
65	return 0;
66}
67
68static irqreturn_t at91_cf_irq(int irq, void *_cf)
69{
70	struct at91_cf_socket *cf = _cf;
71
72	if (irq == gpio_to_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			dev_dbg(&cf->pdev->dev, "card %s\n",
79					present ? "present" : "gone");
80			pcmcia_parse_events(&cf->socket, SS_DETECT);
81		}
82	}
83
84	return IRQ_HANDLED;
85}
86
87static 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	= gpio_is_valid(cf->board->irq_pin);	/* RDY/nIRQ */
99		int vcc	= gpio_is_valid(cf->board->vcc_pin);
100
101		*sp = SS_DETECT | SS_3VCARD;
102		if (!rdy || gpio_get_value(cf->board->irq_pin))
103			*sp |= SS_READY;
104		if (!vcc || gpio_get_value(cf->board->vcc_pin))
105			*sp |= SS_POWERON;
106	} else
107		*sp = 0;
108
109	return 0;
110}
111
112static int
113at91_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 (gpio_is_valid(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	dev_dbg(&cf->pdev->dev, "Vcc %d, io_irq %d, flags %04x csc %04x\n",
137				s->Vcc, s->io_irq, s->flags, s->csc_mask);
138
139	return 0;
140}
141
142static 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 */
148static 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_ramc_read(0, 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		dev_dbg(&cf->pdev->dev, "8bit i/o bus\n");
174	} else {
175		csr |= AT91_SMC_DBW_16;
176		dev_dbg(&cf->pdev->dev, "16bit i/o bus\n");
177	}
178	at91_ramc_write(0, 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 */
187static int
188at91_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
206static 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
217#if defined(CONFIG_OF)
218static const struct of_device_id at91_cf_dt_ids[] = {
219	{ .compatible = "atmel,at91rm9200-cf" },
220	{ /* sentinel */ }
221};
222MODULE_DEVICE_TABLE(of, at91_cf_dt_ids);
223
224static int at91_cf_dt_init(struct platform_device *pdev)
225{
226	struct at91_cf_data *board;
227
228	board = devm_kzalloc(&pdev->dev, sizeof(*board), GFP_KERNEL);
229	if (!board)
230		return -ENOMEM;
231
232	board->irq_pin = of_get_gpio(pdev->dev.of_node, 0);
233	board->det_pin = of_get_gpio(pdev->dev.of_node, 1);
234	board->vcc_pin = of_get_gpio(pdev->dev.of_node, 2);
235	board->rst_pin = of_get_gpio(pdev->dev.of_node, 3);
236
237	pdev->dev.platform_data = board;
238
239	return 0;
240}
241#else
242static int at91_cf_dt_init(struct platform_device *pdev)
243{
244	return -ENODEV;
245}
246#endif
247
248static int at91_cf_probe(struct platform_device *pdev)
249{
250	struct at91_cf_socket	*cf;
251	struct at91_cf_data	*board = pdev->dev.platform_data;
252	struct resource		*io;
253	int			status;
254
255	if (!board) {
256		status = at91_cf_dt_init(pdev);
257		if (status)
258			return status;
259
260		board = pdev->dev.platform_data;
261	}
262
263	if (!gpio_is_valid(board->det_pin) || !gpio_is_valid(board->rst_pin))
264		return -ENODEV;
265
266	io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
267	if (!io)
268		return -ENODEV;
269
270	cf = devm_kzalloc(&pdev->dev, sizeof(*cf), GFP_KERNEL);
271	if (!cf)
272		return -ENOMEM;
273
274	cf->board = board;
275	cf->pdev = pdev;
276	cf->phys_baseaddr = io->start;
277	platform_set_drvdata(pdev, cf);
278
279	/* must be a GPIO; ergo must trigger on both edges */
280	status = devm_gpio_request(&pdev->dev, board->det_pin, "cf_det");
281	if (status < 0)
282		return status;
283
284	status = devm_request_irq(&pdev->dev, gpio_to_irq(board->det_pin),
285					at91_cf_irq, 0, "at91_cf detect", cf);
286	if (status < 0)
287		return status;
288
289	device_init_wakeup(&pdev->dev, 1);
290
291	status = devm_gpio_request(&pdev->dev, board->rst_pin, "cf_rst");
292	if (status < 0)
293		goto fail0a;
294
295	if (gpio_is_valid(board->vcc_pin)) {
296		status = devm_gpio_request(&pdev->dev, board->vcc_pin, "cf_vcc");
297		if (status < 0)
298			goto fail0a;
299	}
300
301	/*
302	 * The card driver will request this irq later as needed.
303	 * but it causes lots of "irqNN: nobody cared" messages
304	 * unless we report that we handle everything (sigh).
305	 * (Note:  DK board doesn't wire the IRQ pin...)
306	 */
307	if (gpio_is_valid(board->irq_pin)) {
308		status = devm_gpio_request(&pdev->dev, board->irq_pin, "cf_irq");
309		if (status < 0)
310			goto fail0a;
311
312		status = devm_request_irq(&pdev->dev, gpio_to_irq(board->irq_pin),
313					at91_cf_irq, IRQF_SHARED, "at91_cf", cf);
314		if (status < 0)
315			goto fail0a;
316		cf->socket.pci_irq = gpio_to_irq(board->irq_pin);
317	} else
318		cf->socket.pci_irq = nr_irqs + 1;
319
320	/*
321	 * pcmcia layer only remaps "real" memory not iospace
322	 * io_offset is set to 0x10000 to avoid the check in static_find_io().
323	 * */
324	cf->socket.io_offset = 0x10000;
325	status = pci_ioremap_io(0x10000, cf->phys_baseaddr + CF_IO_PHYS);
326	if (status)
327		goto fail0a;
328
329	/* reserve chip-select regions */
330	if (!devm_request_mem_region(&pdev->dev, io->start, resource_size(io), "at91_cf")) {
331		status = -ENXIO;
332		goto fail0a;
333	}
334
335	dev_info(&pdev->dev, "irqs det #%d, io #%d\n",
336		gpio_to_irq(board->det_pin), gpio_to_irq(board->irq_pin));
337
338	cf->socket.owner = THIS_MODULE;
339	cf->socket.dev.parent = &pdev->dev;
340	cf->socket.ops = &at91_cf_ops;
341	cf->socket.resource_ops = &pccard_static_ops;
342	cf->socket.features = SS_CAP_PCCARD | SS_CAP_STATIC_MAP
343				| SS_CAP_MEM_ALIGN;
344	cf->socket.map_size = SZ_2K;
345	cf->socket.io[0].res = io;
346
347	status = pcmcia_register_socket(&cf->socket);
348	if (status < 0)
349		goto fail0a;
350
351	return 0;
352
353fail0a:
354	device_init_wakeup(&pdev->dev, 0);
355	return status;
356}
357
358static int at91_cf_remove(struct platform_device *pdev)
359{
360	struct at91_cf_socket	*cf = platform_get_drvdata(pdev);
361
362	pcmcia_unregister_socket(&cf->socket);
363	device_init_wakeup(&pdev->dev, 0);
364
365	return 0;
366}
367
368#ifdef	CONFIG_PM
369
370static int at91_cf_suspend(struct platform_device *pdev, pm_message_t mesg)
371{
372	struct at91_cf_socket	*cf = platform_get_drvdata(pdev);
373	struct at91_cf_data	*board = cf->board;
374
375	if (device_may_wakeup(&pdev->dev)) {
376		enable_irq_wake(gpio_to_irq(board->det_pin));
377		if (gpio_is_valid(board->irq_pin))
378			enable_irq_wake(gpio_to_irq(board->irq_pin));
379	}
380	return 0;
381}
382
383static int at91_cf_resume(struct platform_device *pdev)
384{
385	struct at91_cf_socket	*cf = platform_get_drvdata(pdev);
386	struct at91_cf_data	*board = cf->board;
387
388	if (device_may_wakeup(&pdev->dev)) {
389		disable_irq_wake(gpio_to_irq(board->det_pin));
390		if (gpio_is_valid(board->irq_pin))
391			disable_irq_wake(gpio_to_irq(board->irq_pin));
392	}
393
394	return 0;
395}
396
397#else
398#define	at91_cf_suspend		NULL
399#define	at91_cf_resume		NULL
400#endif
401
402static struct platform_driver at91_cf_driver = {
403	.driver = {
404		.name		= "at91_cf",
405		.of_match_table = of_match_ptr(at91_cf_dt_ids),
406	},
407	.probe		= at91_cf_probe,
408	.remove		= at91_cf_remove,
409	.suspend	= at91_cf_suspend,
410	.resume		= at91_cf_resume,
411};
412
413module_platform_driver(at91_cf_driver);
414
415MODULE_DESCRIPTION("AT91 Compact Flash Driver");
416MODULE_AUTHOR("David Brownell");
417MODULE_LICENSE("GPL");
418MODULE_ALIAS("platform:at91_cf");
419