1 /*======================================================================
3 Common support code for the PCMCIA control functionality of
4 integrated SOCs like the SA-11x0 and PXA2xx microprocessors.
6 The contents of this file are subject to the Mozilla Public
7 License Version 1.1 (the "License"); you may not use this file
8 except in compliance with the License. You may obtain a copy of
9 the License at http://www.mozilla.org/MPL/
11 Software distributed under the License is distributed on an "AS
12 IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
13 implied. See the License for the specific language governing
14 rights and limitations under the License.
16 The initial developer of the original code is John G. Dorsey
17 <john+@cs.cmu.edu>. Portions created by John G. Dorsey are
18 Copyright (C) 1999 John G. Dorsey. All Rights Reserved.
20 Alternatively, the contents of this file may be used under the
21 terms of the GNU Public License version 2 (the "GPL"), in which
22 case the provisions of the GPL are applicable instead of the
23 above. If you wish to allow the use of your version of this file
24 only under the terms of the GPL and not to allow others to use
25 your version of this file under the MPL, indicate your decision
26 by deleting the provisions above and replace them with the notice
27 and other provisions required by the GPL. If you do not delete
28 the provisions above, a recipient may use your version of this
29 file under either the MPL or the GPL.
31 ======================================================================*/
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/init.h>
37 #include <linux/kernel.h>
38 #include <linux/timer.h>
40 #include <linux/mutex.h>
41 #include <linux/interrupt.h>
42 #include <linux/irq.h>
43 #include <linux/spinlock.h>
44 #include <linux/cpufreq.h>
46 #include <mach/hardware.h>
48 #include <asm/system.h>
50 #include "soc_common.h"
52 #ifdef CONFIG_PCMCIA_DEBUG
55 module_param(pc_debug, int, 0644);
57 void soc_pcmcia_debug(struct soc_pcmcia_socket *skt, const char *func,
58 int lvl, const char *fmt, ...)
62 printk(KERN_DEBUG "skt%u: %s: ", skt->nr, func);
71 #define to_soc_pcmcia_socket(x) container_of(x, struct soc_pcmcia_socket, socket)
74 calc_speed(unsigned short *spds, int num, unsigned short dflt)
76 unsigned short speed = 0;
79 for (i = 0; i < num; i++)
88 void soc_common_pcmcia_get_timing(struct soc_pcmcia_socket *skt, struct soc_pcmcia_timing *timing)
90 timing->io = calc_speed(skt->spd_io, MAX_IO_WIN, SOC_PCMCIA_IO_ACCESS);
91 timing->mem = calc_speed(skt->spd_mem, MAX_WIN, SOC_PCMCIA_3V_MEM_ACCESS);
92 timing->attr = calc_speed(skt->spd_attr, MAX_WIN, SOC_PCMCIA_3V_MEM_ACCESS);
94 EXPORT_SYMBOL(soc_common_pcmcia_get_timing);
96 static unsigned int soc_common_pcmcia_skt_state(struct soc_pcmcia_socket *skt)
98 struct pcmcia_state state;
101 memset(&state, 0, sizeof(struct pcmcia_state));
103 skt->ops->socket_state(skt, &state);
105 stat = state.detect ? SS_DETECT : 0;
106 stat |= state.ready ? SS_READY : 0;
107 stat |= state.wrprot ? SS_WRPROT : 0;
108 stat |= state.vs_3v ? SS_3VCARD : 0;
109 stat |= state.vs_Xv ? SS_XVCARD : 0;
111 /* The power status of individual sockets is not available
112 * explicitly from the hardware, so we just remember the state
113 * and regurgitate it upon request:
115 stat |= skt->cs_state.Vcc ? SS_POWERON : 0;
117 if (skt->cs_state.flags & SS_IOCARD)
118 stat |= state.bvd1 ? SS_STSCHG : 0;
122 else if (state.bvd2 == 0)
129 * soc_common_pcmcia_config_skt
130 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
132 * Convert PCMCIA socket state to our socket configure structure.
135 soc_common_pcmcia_config_skt(struct soc_pcmcia_socket *skt, socket_state_t *state)
139 ret = skt->ops->configure_socket(skt, state);
142 * This really needs a better solution. The IRQ
143 * may or may not be claimed by the driver.
145 if (skt->irq_state != 1 && state->io_irq) {
147 set_irq_type(skt->irq, IRQ_TYPE_EDGE_FALLING);
148 } else if (skt->irq_state == 1 && state->io_irq == 0) {
150 set_irq_type(skt->irq, IRQ_TYPE_NONE);
153 skt->cs_state = *state;
157 printk(KERN_ERR "soc_common_pcmcia: unable to configure "
158 "socket %d\n", skt->nr);
163 /* soc_common_pcmcia_sock_init()
164 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166 * (Re-)Initialise the socket, turning on status interrupts
167 * and PCMCIA bus. This must wait for power to stabilise
168 * so that the card status signals report correctly.
172 static int soc_common_pcmcia_sock_init(struct pcmcia_socket *sock)
174 struct soc_pcmcia_socket *skt = to_soc_pcmcia_socket(sock);
176 debug(skt, 2, "initializing socket\n");
178 skt->ops->socket_init(skt);
184 * soc_common_pcmcia_suspend()
185 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^
187 * Remove power on the socket, disable IRQs from the card.
188 * Turn off status interrupts, and disable the PCMCIA bus.
192 static int soc_common_pcmcia_suspend(struct pcmcia_socket *sock)
194 struct soc_pcmcia_socket *skt = to_soc_pcmcia_socket(sock);
196 debug(skt, 2, "suspending socket\n");
198 skt->ops->socket_suspend(skt);
203 static DEFINE_SPINLOCK(status_lock);
205 static void soc_common_check_status(struct soc_pcmcia_socket *skt)
209 debug(skt, 4, "entering PCMCIA monitoring thread\n");
215 status = soc_common_pcmcia_skt_state(skt);
217 spin_lock_irqsave(&status_lock, flags);
218 events = (status ^ skt->status) & skt->cs_state.csc_mask;
219 skt->status = status;
220 spin_unlock_irqrestore(&status_lock, flags);
222 debug(skt, 4, "events: %s%s%s%s%s%s\n",
223 events == 0 ? "<NONE>" : "",
224 events & SS_DETECT ? "DETECT " : "",
225 events & SS_READY ? "READY " : "",
226 events & SS_BATDEAD ? "BATDEAD " : "",
227 events & SS_BATWARN ? "BATWARN " : "",
228 events & SS_STSCHG ? "STSCHG " : "");
231 pcmcia_parse_events(&skt->socket, events);
235 /* Let's poll for events in addition to IRQs since IRQ only is unreliable... */
236 static void soc_common_pcmcia_poll_event(unsigned long dummy)
238 struct soc_pcmcia_socket *skt = (struct soc_pcmcia_socket *)dummy;
239 debug(skt, 4, "polling for events\n");
241 mod_timer(&skt->poll_timer, jiffies + SOC_PCMCIA_POLL_PERIOD);
243 soc_common_check_status(skt);
248 * Service routine for socket driver interrupts (requested by the
249 * low-level PCMCIA init() operation via soc_common_pcmcia_thread()).
250 * The actual interrupt-servicing work is performed by
251 * soc_common_pcmcia_thread(), largely because the Card Services event-
252 * handling code performs scheduling operations which cannot be
253 * executed from within an interrupt context.
255 static irqreturn_t soc_common_pcmcia_interrupt(int irq, void *dev)
257 struct soc_pcmcia_socket *skt = dev;
259 debug(skt, 3, "servicing IRQ %d\n", irq);
261 soc_common_check_status(skt);
268 * Implements the get_status() operation for the in-kernel PCMCIA
269 * service (formerly SS_GetStatus in Card Services). Essentially just
270 * fills in bits in `status' according to internal driver state or
271 * the value of the voltage detect chipselect register.
273 * As a debugging note, during card startup, the PCMCIA core issues
274 * three set_socket() commands in a row the first with RESET deasserted,
275 * the second with RESET asserted, and the last with RESET deasserted
276 * again. Following the third set_socket(), a get_status() command will
277 * be issued. The kernel is looking for the SS_READY flag (see
278 * setup_socket(), reset_socket(), and unreset_socket() in cs.c).
283 soc_common_pcmcia_get_status(struct pcmcia_socket *sock, unsigned int *status)
285 struct soc_pcmcia_socket *skt = to_soc_pcmcia_socket(sock);
287 skt->status = soc_common_pcmcia_skt_state(skt);
288 *status = skt->status;
295 * Implements the set_socket() operation for the in-kernel PCMCIA
296 * service (formerly SS_SetSocket in Card Services). We more or
297 * less punt all of this work and let the kernel handle the details
298 * of power configuration, reset, &c. We also record the value of
299 * `state' in order to regurgitate it to the PCMCIA core later.
302 soc_common_pcmcia_set_socket(struct pcmcia_socket *sock, socket_state_t *state)
304 struct soc_pcmcia_socket *skt = to_soc_pcmcia_socket(sock);
306 debug(skt, 2, "mask: %s%s%s%s%s%sflags: %s%s%s%s%s%sVcc %d Vpp %d irq %d\n",
307 (state->csc_mask==0)?"<NONE> ":"",
308 (state->csc_mask&SS_DETECT)?"DETECT ":"",
309 (state->csc_mask&SS_READY)?"READY ":"",
310 (state->csc_mask&SS_BATDEAD)?"BATDEAD ":"",
311 (state->csc_mask&SS_BATWARN)?"BATWARN ":"",
312 (state->csc_mask&SS_STSCHG)?"STSCHG ":"",
313 (state->flags==0)?"<NONE> ":"",
314 (state->flags&SS_PWR_AUTO)?"PWR_AUTO ":"",
315 (state->flags&SS_IOCARD)?"IOCARD ":"",
316 (state->flags&SS_RESET)?"RESET ":"",
317 (state->flags&SS_SPKR_ENA)?"SPKR_ENA ":"",
318 (state->flags&SS_OUTPUT_ENA)?"OUTPUT_ENA ":"",
319 state->Vcc, state->Vpp, state->io_irq);
321 return soc_common_pcmcia_config_skt(skt, state);
326 * Implements the set_io_map() operation for the in-kernel PCMCIA
327 * service (formerly SS_SetIOMap in Card Services). We configure
328 * the map speed as requested, but override the address ranges
329 * supplied by Card Services.
331 * Returns: 0 on success, -1 on error
334 soc_common_pcmcia_set_io_map(struct pcmcia_socket *sock, struct pccard_io_map *map)
336 struct soc_pcmcia_socket *skt = to_soc_pcmcia_socket(sock);
337 unsigned short speed = map->speed;
339 debug(skt, 2, "map %u speed %u start 0x%08x stop 0x%08x\n",
340 map->map, map->speed, map->start, map->stop);
341 debug(skt, 2, "flags: %s%s%s%s%s%s%s%s\n",
342 (map->flags==0)?"<NONE>":"",
343 (map->flags&MAP_ACTIVE)?"ACTIVE ":"",
344 (map->flags&MAP_16BIT)?"16BIT ":"",
345 (map->flags&MAP_AUTOSZ)?"AUTOSZ ":"",
346 (map->flags&MAP_0WS)?"0WS ":"",
347 (map->flags&MAP_WRPROT)?"WRPROT ":"",
348 (map->flags&MAP_USE_WAIT)?"USE_WAIT ":"",
349 (map->flags&MAP_PREFETCH)?"PREFETCH ":"");
351 if (map->map >= MAX_IO_WIN) {
352 printk(KERN_ERR "%s(): map (%d) out of range\n", __func__,
357 if (map->flags & MAP_ACTIVE) {
359 speed = SOC_PCMCIA_IO_ACCESS;
364 skt->spd_io[map->map] = speed;
365 skt->ops->set_timing(skt);
368 map->stop = PAGE_SIZE-1;
370 map->stop -= map->start;
371 map->stop += skt->socket.io_offset;
372 map->start = skt->socket.io_offset;
379 * Implements the set_mem_map() operation for the in-kernel PCMCIA
380 * service (formerly SS_SetMemMap in Card Services). We configure
381 * the map speed as requested, but override the address ranges
382 * supplied by Card Services.
384 * Returns: 0 on success, -ERRNO on error
387 soc_common_pcmcia_set_mem_map(struct pcmcia_socket *sock, struct pccard_mem_map *map)
389 struct soc_pcmcia_socket *skt = to_soc_pcmcia_socket(sock);
390 struct resource *res;
391 unsigned short speed = map->speed;
393 debug(skt, 2, "map %u speed %u card_start %08x\n",
394 map->map, map->speed, map->card_start);
395 debug(skt, 2, "flags: %s%s%s%s%s%s%s%s\n",
396 (map->flags==0)?"<NONE>":"",
397 (map->flags&MAP_ACTIVE)?"ACTIVE ":"",
398 (map->flags&MAP_16BIT)?"16BIT ":"",
399 (map->flags&MAP_AUTOSZ)?"AUTOSZ ":"",
400 (map->flags&MAP_0WS)?"0WS ":"",
401 (map->flags&MAP_WRPROT)?"WRPROT ":"",
402 (map->flags&MAP_ATTRIB)?"ATTRIB ":"",
403 (map->flags&MAP_USE_WAIT)?"USE_WAIT ":"");
405 if (map->map >= MAX_WIN)
408 if (map->flags & MAP_ACTIVE) {
415 if (map->flags & MAP_ATTRIB) {
416 res = &skt->res_attr;
417 skt->spd_attr[map->map] = speed;
418 skt->spd_mem[map->map] = 0;
421 skt->spd_attr[map->map] = 0;
422 skt->spd_mem[map->map] = speed;
425 skt->ops->set_timing(skt);
427 map->static_start = res->start + map->card_start;
437 static struct bittbl status_bits[] = {
438 { SS_WRPROT, "SS_WRPROT" },
439 { SS_BATDEAD, "SS_BATDEAD" },
440 { SS_BATWARN, "SS_BATWARN" },
441 { SS_READY, "SS_READY" },
442 { SS_DETECT, "SS_DETECT" },
443 { SS_POWERON, "SS_POWERON" },
444 { SS_STSCHG, "SS_STSCHG" },
445 { SS_3VCARD, "SS_3VCARD" },
446 { SS_XVCARD, "SS_XVCARD" },
449 static struct bittbl conf_bits[] = {
450 { SS_PWR_AUTO, "SS_PWR_AUTO" },
451 { SS_IOCARD, "SS_IOCARD" },
452 { SS_RESET, "SS_RESET" },
453 { SS_DMA_MODE, "SS_DMA_MODE" },
454 { SS_SPKR_ENA, "SS_SPKR_ENA" },
455 { SS_OUTPUT_ENA, "SS_OUTPUT_ENA" },
459 dump_bits(char **p, const char *prefix, unsigned int val, struct bittbl *bits, int sz)
464 b += sprintf(b, "%-9s:", prefix);
465 for (i = 0; i < sz; i++)
466 if (val & bits[i].mask)
467 b += sprintf(b, " %s", bits[i].name);
473 * Implements the /sys/class/pcmcia_socket/??/status file.
475 * Returns: the number of characters added to the buffer
477 static ssize_t show_status(struct device *dev, struct device_attribute *attr, char *buf)
479 struct soc_pcmcia_socket *skt =
480 container_of(dev, struct soc_pcmcia_socket, socket.dev);
483 p+=sprintf(p, "slot : %d\n", skt->nr);
485 dump_bits(&p, "status", skt->status,
486 status_bits, ARRAY_SIZE(status_bits));
487 dump_bits(&p, "csc_mask", skt->cs_state.csc_mask,
488 status_bits, ARRAY_SIZE(status_bits));
489 dump_bits(&p, "cs_flags", skt->cs_state.flags,
490 conf_bits, ARRAY_SIZE(conf_bits));
492 p+=sprintf(p, "Vcc : %d\n", skt->cs_state.Vcc);
493 p+=sprintf(p, "Vpp : %d\n", skt->cs_state.Vpp);
494 p+=sprintf(p, "IRQ : %d (%d)\n", skt->cs_state.io_irq, skt->irq);
495 if (skt->ops->show_timing)
496 p+=skt->ops->show_timing(skt, p);
500 static DEVICE_ATTR(status, S_IRUGO, show_status, NULL);
503 static struct pccard_operations soc_common_pcmcia_operations = {
504 .init = soc_common_pcmcia_sock_init,
505 .suspend = soc_common_pcmcia_suspend,
506 .get_status = soc_common_pcmcia_get_status,
507 .set_socket = soc_common_pcmcia_set_socket,
508 .set_io_map = soc_common_pcmcia_set_io_map,
509 .set_mem_map = soc_common_pcmcia_set_mem_map,
513 int soc_pcmcia_request_irqs(struct soc_pcmcia_socket *skt,
514 struct pcmcia_irqs *irqs, int nr)
518 for (i = 0; i < nr; i++) {
519 if (irqs[i].sock != skt->nr)
521 res = request_irq(irqs[i].irq, soc_common_pcmcia_interrupt,
522 IRQF_DISABLED, irqs[i].str, skt);
525 set_irq_type(irqs[i].irq, IRQ_TYPE_NONE);
529 printk(KERN_ERR "PCMCIA: request for IRQ%d failed (%d)\n",
533 if (irqs[i].sock == skt->nr)
534 free_irq(irqs[i].irq, skt);
538 EXPORT_SYMBOL(soc_pcmcia_request_irqs);
540 void soc_pcmcia_free_irqs(struct soc_pcmcia_socket *skt,
541 struct pcmcia_irqs *irqs, int nr)
545 for (i = 0; i < nr; i++)
546 if (irqs[i].sock == skt->nr)
547 free_irq(irqs[i].irq, skt);
549 EXPORT_SYMBOL(soc_pcmcia_free_irqs);
551 void soc_pcmcia_disable_irqs(struct soc_pcmcia_socket *skt,
552 struct pcmcia_irqs *irqs, int nr)
556 for (i = 0; i < nr; i++)
557 if (irqs[i].sock == skt->nr)
558 set_irq_type(irqs[i].irq, IRQ_TYPE_NONE);
560 EXPORT_SYMBOL(soc_pcmcia_disable_irqs);
562 void soc_pcmcia_enable_irqs(struct soc_pcmcia_socket *skt,
563 struct pcmcia_irqs *irqs, int nr)
567 for (i = 0; i < nr; i++)
568 if (irqs[i].sock == skt->nr) {
569 set_irq_type(irqs[i].irq, IRQ_TYPE_EDGE_RISING);
570 set_irq_type(irqs[i].irq, IRQ_TYPE_EDGE_BOTH);
573 EXPORT_SYMBOL(soc_pcmcia_enable_irqs);
576 LIST_HEAD(soc_pcmcia_sockets);
577 static DEFINE_MUTEX(soc_pcmcia_sockets_lock);
579 #ifdef CONFIG_CPU_FREQ
581 soc_pcmcia_notifier(struct notifier_block *nb, unsigned long val, void *data)
583 struct soc_pcmcia_socket *skt;
584 struct cpufreq_freqs *freqs = data;
587 mutex_lock(&soc_pcmcia_sockets_lock);
588 list_for_each_entry(skt, &soc_pcmcia_sockets, node)
589 if ( skt->ops->frequency_change )
590 ret += skt->ops->frequency_change(skt, val, freqs);
591 mutex_unlock(&soc_pcmcia_sockets_lock);
596 static struct notifier_block soc_pcmcia_notifier_block = {
597 .notifier_call = soc_pcmcia_notifier
600 static int soc_pcmcia_cpufreq_register(void)
604 ret = cpufreq_register_notifier(&soc_pcmcia_notifier_block,
605 CPUFREQ_TRANSITION_NOTIFIER);
607 printk(KERN_ERR "Unable to register CPU frequency change "
608 "notifier for PCMCIA (%d)\n", ret);
612 static void soc_pcmcia_cpufreq_unregister(void)
614 cpufreq_unregister_notifier(&soc_pcmcia_notifier_block, CPUFREQ_TRANSITION_NOTIFIER);
618 static int soc_pcmcia_cpufreq_register(void) { return 0; }
619 static void soc_pcmcia_cpufreq_unregister(void) {}
622 int soc_common_drv_pcmcia_probe(struct device *dev, struct pcmcia_low_level *ops,
623 struct skt_dev_info *sinfo)
625 struct soc_pcmcia_socket *skt;
628 mutex_lock(&soc_pcmcia_sockets_lock);
631 * Initialise the per-socket structure.
633 for (i = 0; i < sinfo->nskt; i++) {
634 skt = &sinfo->skt[i];
636 skt->socket.ops = &soc_common_pcmcia_operations;
637 skt->socket.owner = ops->owner;
638 skt->socket.dev.parent = dev;
640 init_timer(&skt->poll_timer);
641 skt->poll_timer.function = soc_common_pcmcia_poll_event;
642 skt->poll_timer.data = (unsigned long)skt;
643 skt->poll_timer.expires = jiffies + SOC_PCMCIA_POLL_PERIOD;
648 ret = request_resource(&iomem_resource, &skt->res_skt);
652 ret = request_resource(&skt->res_skt, &skt->res_io);
656 ret = request_resource(&skt->res_skt, &skt->res_mem);
660 ret = request_resource(&skt->res_skt, &skt->res_attr);
664 skt->virt_io = ioremap(skt->res_io.start, 0x10000);
665 if (skt->virt_io == NULL) {
670 if (list_empty(&soc_pcmcia_sockets))
671 soc_pcmcia_cpufreq_register();
673 list_add(&skt->node, &soc_pcmcia_sockets);
676 * We initialize default socket timing here, because
677 * we are not guaranteed to see a SetIOMap operation at
680 ops->set_timing(skt);
682 ret = ops->hw_init(skt);
686 skt->socket.features = SS_CAP_STATIC_MAP|SS_CAP_PCCARD;
687 skt->socket.resource_ops = &pccard_static_ops;
688 skt->socket.irq_mask = 0;
689 skt->socket.map_size = PAGE_SIZE;
690 skt->socket.pci_irq = skt->irq;
691 skt->socket.io_offset = (unsigned long)skt->virt_io;
693 skt->status = soc_common_pcmcia_skt_state(skt);
695 ret = pcmcia_register_socket(&skt->socket);
699 WARN_ON(skt->socket.sock != i);
701 add_timer(&skt->poll_timer);
703 ret = device_create_file(&skt->socket.dev, &dev_attr_status);
708 dev_set_drvdata(dev, sinfo);
713 skt = &sinfo->skt[i];
715 device_remove_file(&skt->socket.dev, &dev_attr_status);
717 del_timer_sync(&skt->poll_timer);
718 pcmcia_unregister_socket(&skt->socket);
721 flush_scheduled_work();
723 ops->hw_shutdown(skt);
725 list_del(&skt->node);
726 iounmap(skt->virt_io);
728 release_resource(&skt->res_attr);
730 release_resource(&skt->res_mem);
732 release_resource(&skt->res_io);
734 release_resource(&skt->res_skt);
742 mutex_unlock(&soc_pcmcia_sockets_lock);
746 int soc_common_drv_pcmcia_remove(struct device *dev)
748 struct skt_dev_info *sinfo = dev_get_drvdata(dev);
751 dev_set_drvdata(dev, NULL);
753 mutex_lock(&soc_pcmcia_sockets_lock);
754 for (i = 0; i < sinfo->nskt; i++) {
755 struct soc_pcmcia_socket *skt = &sinfo->skt[i];
757 del_timer_sync(&skt->poll_timer);
759 pcmcia_unregister_socket(&skt->socket);
761 flush_scheduled_work();
763 skt->ops->hw_shutdown(skt);
765 soc_common_pcmcia_config_skt(skt, &dead_socket);
767 list_del(&skt->node);
768 iounmap(skt->virt_io);
770 release_resource(&skt->res_attr);
771 release_resource(&skt->res_mem);
772 release_resource(&skt->res_io);
773 release_resource(&skt->res_skt);
775 if (list_empty(&soc_pcmcia_sockets))
776 soc_pcmcia_cpufreq_unregister();
778 mutex_unlock(&soc_pcmcia_sockets_lock);
784 EXPORT_SYMBOL(soc_common_drv_pcmcia_remove);