ieee802154: add documentation about our stack
[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 #define SZ_2K                   (2 * SZ_1K)
56
57 static inline int at91_cf_present(struct at91_cf_socket *cf)
58 {
59         return !gpio_get_value(cf->board->det_pin);
60 }
61
62 /*--------------------------------------------------------------------------*/
63
64 static int at91_cf_ss_init(struct pcmcia_socket *s)
65 {
66         return 0;
67 }
68
69 static 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
88 static 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 || gpio_get_value(rdy))
104                         *sp |= SS_READY;
105                 if (!vcc || gpio_get_value(vcc))
106                         *sp |= SS_POWERON;
107         } else
108                 *sp = 0;
109
110         return 0;
111 }
112
113 static int
114 at91_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                                 gpio_set_value(cf->board->vcc_pin, 0);
125                                 break;
126                         case 33:
127                                 gpio_set_value(cf->board->vcc_pin, 1);
128                                 break;
129                         default:
130                                 return -EINVAL;
131                 }
132         }
133
134         /* toggle reset if needed */
135         gpio_set_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
143 static 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 */
149 static 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 */
188 static int
189 at91_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
207 static 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
218 static 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 = gpio_request(board->det_pin, "cf_det");
243         if (status < 0)
244                 goto fail0;
245         status = request_irq(board->det_pin, at91_cf_irq, 0, driver_name, cf);
246         if (status < 0)
247                 goto fail00;
248         device_init_wakeup(&pdev->dev, 1);
249
250         status = gpio_request(board->rst_pin, "cf_rst");
251         if (status < 0)
252                 goto fail0a;
253
254         if (board->vcc_pin) {
255                 status = gpio_request(board->vcc_pin, "cf_vcc");
256                 if (status < 0)
257                         goto fail0b;
258         }
259
260         /*
261          * The card driver will request this irq later as needed.
262          * but it causes lots of "irqNN: nobody cared" messages
263          * unless we report that we handle everything (sigh).
264          * (Note:  DK board doesn't wire the IRQ pin...)
265          */
266         if (board->irq_pin) {
267                 status = gpio_request(board->irq_pin, "cf_irq");
268                 if (status < 0)
269                         goto fail0c;
270                 status = request_irq(board->irq_pin, at91_cf_irq,
271                                 IRQF_SHARED, driver_name, cf);
272                 if (status < 0)
273                         goto fail0d;
274                 cf->socket.pci_irq = board->irq_pin;
275         } else
276                 cf->socket.pci_irq = nr_irqs + 1;
277
278         /* pcmcia layer only remaps "real" memory not iospace */
279         cf->socket.io_offset = (unsigned long)
280                         ioremap(cf->phys_baseaddr + CF_IO_PHYS, SZ_2K);
281         if (!cf->socket.io_offset) {
282                 status = -ENXIO;
283                 goto fail1;
284         }
285
286         /* reserve chip-select regions */
287         if (!request_mem_region(io->start, io->end + 1 - io->start,
288                                 driver_name)) {
289                 status = -ENXIO;
290                 goto fail1;
291         }
292
293         pr_info("%s: irqs det #%d, io #%d\n", driver_name,
294                 board->det_pin, board->irq_pin);
295
296         cf->socket.owner = THIS_MODULE;
297         cf->socket.dev.parent = &pdev->dev;
298         cf->socket.ops = &at91_cf_ops;
299         cf->socket.resource_ops = &pccard_static_ops;
300         cf->socket.features = SS_CAP_PCCARD | SS_CAP_STATIC_MAP
301                                 | SS_CAP_MEM_ALIGN;
302         cf->socket.map_size = SZ_2K;
303         cf->socket.io[0].res = io;
304
305         status = pcmcia_register_socket(&cf->socket);
306         if (status < 0)
307                 goto fail2;
308
309         return 0;
310
311 fail2:
312         release_mem_region(io->start, io->end + 1 - io->start);
313 fail1:
314         if (cf->socket.io_offset)
315                 iounmap((void __iomem *) cf->socket.io_offset);
316         if (board->irq_pin) {
317                 free_irq(board->irq_pin, cf);
318 fail0d:
319                 gpio_free(board->irq_pin);
320         }
321 fail0c:
322         if (board->vcc_pin)
323                 gpio_free(board->vcc_pin);
324 fail0b:
325         gpio_free(board->rst_pin);
326 fail0a:
327         device_init_wakeup(&pdev->dev, 0);
328         free_irq(board->det_pin, cf);
329 fail00:
330         gpio_free(board->det_pin);
331 fail0:
332         kfree(cf);
333         return status;
334 }
335
336 static int __exit at91_cf_remove(struct platform_device *pdev)
337 {
338         struct at91_cf_socket   *cf = platform_get_drvdata(pdev);
339         struct at91_cf_data     *board = cf->board;
340         struct resource         *io = cf->socket.io[0].res;
341
342         pcmcia_unregister_socket(&cf->socket);
343         release_mem_region(io->start, io->end + 1 - io->start);
344         iounmap((void __iomem *) cf->socket.io_offset);
345         if (board->irq_pin) {
346                 free_irq(board->irq_pin, cf);
347                 gpio_free(board->irq_pin);
348         }
349         if (board->vcc_pin)
350                 gpio_free(board->vcc_pin);
351         gpio_free(board->rst_pin);
352         device_init_wakeup(&pdev->dev, 0);
353         free_irq(board->det_pin, cf);
354         gpio_free(board->det_pin);
355         kfree(cf);
356         return 0;
357 }
358
359 #ifdef  CONFIG_PM
360
361 static int at91_cf_suspend(struct platform_device *pdev, pm_message_t mesg)
362 {
363         struct at91_cf_socket   *cf = platform_get_drvdata(pdev);
364         struct at91_cf_data     *board = cf->board;
365
366         pcmcia_socket_dev_suspend(&pdev->dev, mesg);
367         if (device_may_wakeup(&pdev->dev)) {
368                 enable_irq_wake(board->det_pin);
369                 if (board->irq_pin)
370                         enable_irq_wake(board->irq_pin);
371         }
372         return 0;
373 }
374
375 static int at91_cf_resume(struct platform_device *pdev)
376 {
377         struct at91_cf_socket   *cf = platform_get_drvdata(pdev);
378         struct at91_cf_data     *board = cf->board;
379
380         if (device_may_wakeup(&pdev->dev)) {
381                 disable_irq_wake(board->det_pin);
382                 if (board->irq_pin)
383                         disable_irq_wake(board->irq_pin);
384         }
385
386         pcmcia_socket_dev_resume(&pdev->dev);
387         return 0;
388 }
389
390 #else
391 #define at91_cf_suspend         NULL
392 #define at91_cf_resume          NULL
393 #endif
394
395 static struct platform_driver at91_cf_driver = {
396         .driver = {
397                 .name           = (char *) driver_name,
398                 .owner          = THIS_MODULE,
399         },
400         .remove         = __exit_p(at91_cf_remove),
401         .suspend        = at91_cf_suspend,
402         .resume         = at91_cf_resume,
403 };
404
405 /*--------------------------------------------------------------------------*/
406
407 static int __init at91_cf_init(void)
408 {
409         return platform_driver_probe(&at91_cf_driver, at91_cf_probe);
410 }
411 module_init(at91_cf_init);
412
413 static void __exit at91_cf_exit(void)
414 {
415         platform_driver_unregister(&at91_cf_driver);
416 }
417 module_exit(at91_cf_exit);
418
419 MODULE_DESCRIPTION("AT91 Compact Flash Driver");
420 MODULE_AUTHOR("David Brownell");
421 MODULE_LICENSE("GPL");
422 MODULE_ALIAS("platform:at91_cf");