pcmcia: assert locking to struct pcmcia_device
[safe/jmp/linux-2.6] / drivers / pcmcia / at91_cf.c
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 <mach/hardware.h>
22 #include <asm/io.h>
23 #include <asm/sizes.h>
24 #include <asm/gpio.h>
25
26 #include <mach/board.h>
27 #include <mach/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
42 static const char driver_name[] = "at91_cf";
43
44 struct 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 static inline int at91_cf_present(struct at91_cf_socket *cf)
56 {
57         return !gpio_get_value(cf->board->det_pin);
58 }
59
60 /*--------------------------------------------------------------------------*/
61
62 static int at91_cf_ss_init(struct pcmcia_socket *s)
63 {
64         return 0;
65 }
66
67 static irqreturn_t at91_cf_irq(int irq, void *_cf)
68 {
69         struct at91_cf_socket *cf = _cf;
70
71         if (irq == cf->board->det_pin) {
72                 unsigned present = at91_cf_present(cf);
73
74                 /* kick pccard as needed */
75                 if (present != cf->present) {
76                         cf->present = present;
77                         pr_debug("%s: card %s\n", driver_name,
78                                         present ? "present" : "gone");
79                         pcmcia_parse_events(&cf->socket, SS_DETECT);
80                 }
81         }
82
83         return IRQ_HANDLED;
84 }
85
86 static int at91_cf_get_status(struct pcmcia_socket *s, u_int *sp)
87 {
88         struct at91_cf_socket   *cf;
89
90         if (!sp)
91                 return -EINVAL;
92
93         cf = container_of(s, struct at91_cf_socket, socket);
94
95         /* NOTE: CF is always 3VCARD */
96         if (at91_cf_present(cf)) {
97                 int rdy = cf->board->irq_pin;   /* RDY/nIRQ */
98                 int vcc = cf->board->vcc_pin;
99
100                 *sp = SS_DETECT | SS_3VCARD;
101                 if (!rdy || gpio_get_value(rdy))
102                         *sp |= SS_READY;
103                 if (!vcc || gpio_get_value(vcc))
104                         *sp |= SS_POWERON;
105         } else
106                 *sp = 0;
107
108         return 0;
109 }
110
111 static int
112 at91_cf_set_socket(struct pcmcia_socket *sock, struct socket_state_t *s)
113 {
114         struct at91_cf_socket   *cf;
115
116         cf = container_of(sock, struct at91_cf_socket, socket);
117
118         /* switch Vcc if needed and possible */
119         if (cf->board->vcc_pin) {
120                 switch (s->Vcc) {
121                         case 0:
122                                 gpio_set_value(cf->board->vcc_pin, 0);
123                                 break;
124                         case 33:
125                                 gpio_set_value(cf->board->vcc_pin, 1);
126                                 break;
127                         default:
128                                 return -EINVAL;
129                 }
130         }
131
132         /* toggle reset if needed */
133         gpio_set_value(cf->board->rst_pin, s->flags & SS_RESET);
134
135         pr_debug("%s: Vcc %d, io_irq %d, flags %04x csc %04x\n",
136                 driver_name, s->Vcc, s->io_irq, s->flags, s->csc_mask);
137
138         return 0;
139 }
140
141 static int at91_cf_ss_suspend(struct pcmcia_socket *s)
142 {
143         return at91_cf_set_socket(s, &dead_socket);
144 }
145
146 /* we already mapped the I/O region */
147 static int at91_cf_set_io_map(struct pcmcia_socket *s, struct pccard_io_map *io)
148 {
149         struct at91_cf_socket   *cf;
150         u32                     csr;
151
152         cf = container_of(s, struct at91_cf_socket, socket);
153         io->flags &= (MAP_ACTIVE | MAP_16BIT | MAP_AUTOSZ);
154
155         /*
156          * Use 16 bit accesses unless/until we need 8-bit i/o space.
157          */
158         csr = at91_sys_read(AT91_SMC_CSR(cf->board->chipselect)) & ~AT91_SMC_DBW;
159
160         /*
161          * NOTE: this CF controller ignores IOIS16, so we can't really do
162          * MAP_AUTOSZ.  The 16bit mode allows single byte access on either
163          * D0-D7 (even addr) or D8-D15 (odd), so it's close enough for many
164          * purposes (and handles ide-cs).
165          *
166          * The 8bit mode is needed for odd byte access on D0-D7.  It seems
167          * some cards only like that way to get at the odd byte, despite
168          * CF 3.0 spec table 35 also giving the D8-D15 option.
169          */
170         if (!(io->flags & (MAP_16BIT | MAP_AUTOSZ))) {
171                 csr |= AT91_SMC_DBW_8;
172                 pr_debug("%s: 8bit i/o bus\n", driver_name);
173         } else {
174                 csr |= AT91_SMC_DBW_16;
175                 pr_debug("%s: 16bit i/o bus\n", driver_name);
176         }
177         at91_sys_write(AT91_SMC_CSR(cf->board->chipselect), csr);
178
179         io->start = cf->socket.io_offset;
180         io->stop = io->start + SZ_2K - 1;
181
182         return 0;
183 }
184
185 /* pcmcia layer maps/unmaps mem regions */
186 static int
187 at91_cf_set_mem_map(struct pcmcia_socket *s, struct pccard_mem_map *map)
188 {
189         struct at91_cf_socket   *cf;
190
191         if (map->card_start)
192                 return -EINVAL;
193
194         cf = container_of(s, struct at91_cf_socket, socket);
195
196         map->flags &= (MAP_ACTIVE | MAP_ATTRIB | MAP_16BIT);
197         if (map->flags & MAP_ATTRIB)
198                 map->static_start = cf->phys_baseaddr + CF_ATTR_PHYS;
199         else
200                 map->static_start = cf->phys_baseaddr + CF_MEM_PHYS;
201
202         return 0;
203 }
204
205 static struct pccard_operations at91_cf_ops = {
206         .init                   = at91_cf_ss_init,
207         .suspend                = at91_cf_ss_suspend,
208         .get_status             = at91_cf_get_status,
209         .set_socket             = at91_cf_set_socket,
210         .set_io_map             = at91_cf_set_io_map,
211         .set_mem_map            = at91_cf_set_mem_map,
212 };
213
214 /*--------------------------------------------------------------------------*/
215
216 static int __init at91_cf_probe(struct platform_device *pdev)
217 {
218         struct at91_cf_socket   *cf;
219         struct at91_cf_data     *board = pdev->dev.platform_data;
220         struct resource         *io;
221         int                     status;
222
223         if (!board || !board->det_pin || !board->rst_pin)
224                 return -ENODEV;
225
226         io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
227         if (!io)
228                 return -ENODEV;
229
230         cf = kzalloc(sizeof *cf, GFP_KERNEL);
231         if (!cf)
232                 return -ENOMEM;
233
234         cf->board = board;
235         cf->pdev = pdev;
236         cf->phys_baseaddr = io->start;
237         platform_set_drvdata(pdev, cf);
238
239         /* must be a GPIO; ergo must trigger on both edges */
240         status = gpio_request(board->det_pin, "cf_det");
241         if (status < 0)
242                 goto fail0;
243         status = request_irq(board->det_pin, at91_cf_irq, 0, driver_name, cf);
244         if (status < 0)
245                 goto fail00;
246         device_init_wakeup(&pdev->dev, 1);
247
248         status = gpio_request(board->rst_pin, "cf_rst");
249         if (status < 0)
250                 goto fail0a;
251
252         if (board->vcc_pin) {
253                 status = gpio_request(board->vcc_pin, "cf_vcc");
254                 if (status < 0)
255                         goto fail0b;
256         }
257
258         /*
259          * The card driver will request this irq later as needed.
260          * but it causes lots of "irqNN: nobody cared" messages
261          * unless we report that we handle everything (sigh).
262          * (Note:  DK board doesn't wire the IRQ pin...)
263          */
264         if (board->irq_pin) {
265                 status = gpio_request(board->irq_pin, "cf_irq");
266                 if (status < 0)
267                         goto fail0c;
268                 status = request_irq(board->irq_pin, at91_cf_irq,
269                                 IRQF_SHARED, driver_name, cf);
270                 if (status < 0)
271                         goto fail0d;
272                 cf->socket.pci_irq = board->irq_pin;
273         } else
274                 cf->socket.pci_irq = nr_irqs + 1;
275
276         /* pcmcia layer only remaps "real" memory not iospace */
277         cf->socket.io_offset = (unsigned long)
278                         ioremap(cf->phys_baseaddr + CF_IO_PHYS, SZ_2K);
279         if (!cf->socket.io_offset) {
280                 status = -ENXIO;
281                 goto fail1;
282         }
283
284         /* reserve chip-select regions */
285         if (!request_mem_region(io->start, io->end + 1 - io->start,
286                                 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, io->end + 1 - io->start);
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
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, io->end + 1 - io->start);
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
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         pcmcia_socket_dev_suspend(&pdev->dev);
365         if (device_may_wakeup(&pdev->dev)) {
366                 enable_irq_wake(board->det_pin);
367                 if (board->irq_pin)
368                         enable_irq_wake(board->irq_pin);
369         }
370         return 0;
371 }
372
373 static int at91_cf_resume(struct platform_device *pdev)
374 {
375         struct at91_cf_socket   *cf = platform_get_drvdata(pdev);
376         struct at91_cf_data     *board = cf->board;
377
378         if (device_may_wakeup(&pdev->dev)) {
379                 disable_irq_wake(board->det_pin);
380                 if (board->irq_pin)
381                         disable_irq_wake(board->irq_pin);
382         }
383
384         pcmcia_socket_dev_resume(&pdev->dev);
385         return 0;
386 }
387
388 #else
389 #define at91_cf_suspend         NULL
390 #define at91_cf_resume          NULL
391 #endif
392
393 static struct platform_driver at91_cf_driver = {
394         .driver = {
395                 .name           = (char *) driver_name,
396                 .owner          = THIS_MODULE,
397         },
398         .remove         = __exit_p(at91_cf_remove),
399         .suspend        = at91_cf_suspend,
400         .resume         = at91_cf_resume,
401 };
402
403 /*--------------------------------------------------------------------------*/
404
405 static int __init at91_cf_init(void)
406 {
407         return platform_driver_probe(&at91_cf_driver, at91_cf_probe);
408 }
409 module_init(at91_cf_init);
410
411 static void __exit at91_cf_exit(void)
412 {
413         platform_driver_unregister(&at91_cf_driver);
414 }
415 module_exit(at91_cf_exit);
416
417 MODULE_DESCRIPTION("AT91 Compact Flash Driver");
418 MODULE_AUTHOR("David Brownell");
419 MODULE_LICENSE("GPL");
420 MODULE_ALIAS("platform:at91_cf");