2 * PCMCIA socket code for the Alchemy Db1xxx/Pb1xxx boards.
4 * Copyright (c) 2009 Manuel Lauss <manuel.lauss@gmail.com>
8 /* This is a fairly generic PCMCIA socket driver suitable for the
9 * following Alchemy Development boards:
10 * Db1000, Db/Pb1500, Db/Pb1100, Db/Pb1550, Db/Pb1200.
12 * The Db1000 is used as a reference: Per-socket card-, carddetect- and
13 * statuschange IRQs connected to SoC GPIOs, control and status register
14 * bits arranged in per-socket groups in an external PLD. All boards
15 * listed here use this layout, including bit positions and meanings.
16 * Of course there are exceptions in later boards:
18 * - Pb1100/Pb1500: single socket only; voltage key bits VS are
19 * at STATUS[5:4] (instead of STATUS[1:0]).
20 * - Au1200-based: additional card-eject irqs, irqs not gpios!
23 #include <linux/delay.h>
24 #include <linux/gpio.h>
25 #include <linux/interrupt.h>
27 #include <linux/platform_device.h>
28 #include <linux/resource.h>
29 #include <linux/spinlock.h>
31 #include <pcmcia/cs_types.h>
32 #include <pcmcia/ss.h>
34 #include <asm/mach-au1x00/au1000.h>
35 #include <asm/mach-db1x00/bcsr.h>
37 #define MEM_MAP_SIZE 0x400000
38 #define IO_MAP_SIZE 0x1000
40 struct db1x_pcmcia_sock
{
41 struct pcmcia_socket socket
;
42 int nr
; /* socket number */
46 phys_addr_t phys_attr
;
49 /* previous flags for set_socket() */
50 unsigned int old_flags
;
52 /* interrupt sources: linux irq numbers! */
53 int insert_irq
; /* default carddetect irq */
54 int stschg_irq
; /* card-status-change irq */
55 int card_irq
; /* card irq */
56 int eject_irq
; /* db1200/pb1200 have these */
58 #define BOARD_TYPE_DEFAULT 0 /* most boards */
59 #define BOARD_TYPE_DB1200 1 /* IRQs aren't gpios */
60 #define BOARD_TYPE_PB1100 2 /* VS bits slightly different */
64 #define to_db1x_socket(x) container_of(x, struct db1x_pcmcia_sock, socket)
66 /* DB/PB1200: check CPLD SIGSTATUS register bit 10/12 */
67 static int db1200_card_inserted(struct db1x_pcmcia_sock
*sock
)
69 unsigned short sigstat
;
71 sigstat
= bcsr_read(BCSR_SIGSTAT
);
72 return sigstat
& 1 << (8 + 2 * sock
->nr
);
75 /* carddetect gpio: low-active */
76 static int db1000_card_inserted(struct db1x_pcmcia_sock
*sock
)
78 return !gpio_get_value(irq_to_gpio(sock
->insert_irq
));
81 static int db1x_card_inserted(struct db1x_pcmcia_sock
*sock
)
83 switch (sock
->board_type
) {
84 case BOARD_TYPE_DB1200
:
85 return db1200_card_inserted(sock
);
87 return db1000_card_inserted(sock
);
91 /* STSCHG tends to bounce heavily when cards are inserted/ejected.
92 * To avoid this, the interrupt is normally disabled and only enabled
93 * after reset to a card has been de-asserted.
95 static inline void set_stschg(struct db1x_pcmcia_sock
*sock
, int en
)
97 if (sock
->stschg_irq
!= -1) {
99 enable_irq(sock
->stschg_irq
);
101 disable_irq(sock
->stschg_irq
);
105 static irqreturn_t
db1000_pcmcia_cdirq(int irq
, void *data
)
107 struct db1x_pcmcia_sock
*sock
= data
;
109 pcmcia_parse_events(&sock
->socket
, SS_DETECT
);
114 static irqreturn_t
db1000_pcmcia_stschgirq(int irq
, void *data
)
116 struct db1x_pcmcia_sock
*sock
= data
;
118 pcmcia_parse_events(&sock
->socket
, SS_STSCHG
);
123 static irqreturn_t
db1200_pcmcia_cdirq(int irq
, void *data
)
125 struct db1x_pcmcia_sock
*sock
= data
;
127 /* Db/Pb1200 have separate per-socket insertion and ejection
128 * interrupts which stay asserted as long as the card is
129 * inserted/missing. The one which caused us to be called
130 * needs to be disabled and the other one enabled.
132 if (irq
== sock
->insert_irq
) {
133 disable_irq_nosync(sock
->insert_irq
);
134 enable_irq(sock
->eject_irq
);
136 disable_irq_nosync(sock
->eject_irq
);
137 enable_irq(sock
->insert_irq
);
140 pcmcia_parse_events(&sock
->socket
, SS_DETECT
);
145 static int db1x_pcmcia_setup_irqs(struct db1x_pcmcia_sock
*sock
)
150 if (sock
->stschg_irq
!= -1) {
151 ret
= request_irq(sock
->stschg_irq
, db1000_pcmcia_stschgirq
,
152 0, "pcmcia_stschg", sock
);
157 /* Db/Pb1200 have separate per-socket insertion and ejection
158 * interrupts, which should show edge behaviour but don't.
159 * So interrupts are disabled until both insertion and
160 * ejection handler have been registered and the currently
161 * active one disabled.
163 if (sock
->board_type
== BOARD_TYPE_DB1200
) {
164 local_irq_save(flags
);
166 ret
= request_irq(sock
->insert_irq
, db1200_pcmcia_cdirq
,
167 IRQF_DISABLED
, "pcmcia_insert", sock
);
171 ret
= request_irq(sock
->eject_irq
, db1200_pcmcia_cdirq
,
172 IRQF_DISABLED
, "pcmcia_eject", sock
);
174 free_irq(sock
->insert_irq
, sock
);
175 local_irq_restore(flags
);
179 /* disable the currently active one */
180 if (db1200_card_inserted(sock
))
181 disable_irq_nosync(sock
->insert_irq
);
183 disable_irq_nosync(sock
->eject_irq
);
185 local_irq_restore(flags
);
187 /* all other (older) Db1x00 boards use a GPIO to show
188 * card detection status: use both-edge triggers.
190 set_irq_type(sock
->insert_irq
, IRQ_TYPE_EDGE_BOTH
);
191 ret
= request_irq(sock
->insert_irq
, db1000_pcmcia_cdirq
,
192 0, "pcmcia_carddetect", sock
);
198 return 0; /* all done */
201 if (sock
->stschg_irq
!= -1)
202 free_irq(sock
->stschg_irq
, sock
);
207 static void db1x_pcmcia_free_irqs(struct db1x_pcmcia_sock
*sock
)
209 if (sock
->stschg_irq
!= -1)
210 free_irq(sock
->stschg_irq
, sock
);
212 free_irq(sock
->insert_irq
, sock
);
213 if (sock
->eject_irq
!= -1)
214 free_irq(sock
->eject_irq
, sock
);
218 * configure a PCMCIA socket on the Db1x00 series of boards (and
221 * 2 external registers are involved:
222 * pcmcia_status (offset 0x04): bits [0:1/2:3]: read card voltage id
223 * pcmcia_control(offset 0x10):
224 * bits[0:1] set vcc for card
225 * bits[2:3] set vpp for card
226 * bit 4: enable data buffers
227 * bit 7: reset# for card
228 * add 8 for second socket.
230 static int db1x_pcmcia_configure(struct pcmcia_socket
*skt
,
231 struct socket_state_t
*state
)
233 struct db1x_pcmcia_sock
*sock
= to_db1x_socket(skt
);
234 unsigned short cr_clr
, cr_set
;
235 unsigned int changed
;
238 /* card voltage setup */
239 cr_clr
= (0xf << (sock
->nr
* 8)); /* clear voltage settings */
243 switch (state
->Vcc
) {
251 printk(KERN_INFO
"pcmcia%d unsupported Vcc %d\n",
252 sock
->nr
, state
->Vcc
);
255 switch (state
->Vpp
) {
264 printk(KERN_INFO
"pcmcia%d unsupported Vpp %d\n",
265 sock
->nr
, state
->Vpp
);
268 /* sanity check: Vpp must be 0, 12, or Vcc */
269 if (((state
->Vcc
== 33) && (state
->Vpp
== 50)) ||
270 ((state
->Vcc
== 50) && (state
->Vpp
== 33))) {
271 printk(KERN_INFO
"pcmcia%d bad Vcc/Vpp combo (%d %d)\n",
272 sock
->nr
, state
->Vcc
, state
->Vpp
);
277 /* create new voltage code */
278 cr_set
|= ((v
<< 2) | p
) << (sock
->nr
* 8);
280 changed
= state
->flags
^ sock
->old_flags
;
282 if (changed
& SS_RESET
) {
283 if (state
->flags
& SS_RESET
) {
285 /* assert reset, disable io buffers */
286 cr_clr
|= (1 << (7 + (sock
->nr
* 8)));
287 cr_clr
|= (1 << (4 + (sock
->nr
* 8)));
289 /* de-assert reset, enable io buffers */
290 cr_set
|= 1 << (7 + (sock
->nr
* 8));
291 cr_set
|= 1 << (4 + (sock
->nr
* 8));
295 /* update PCMCIA configuration */
296 bcsr_mod(BCSR_PCMCIA
, cr_clr
, cr_set
);
298 sock
->old_flags
= state
->flags
;
300 /* reset was taken away: give card time to initialize properly */
301 if ((changed
& SS_RESET
) && !(state
->flags
& SS_RESET
)) {
309 /* VCC bits at [3:2]/[11:10] */
310 #define GET_VCC(cr, socknr) \
311 ((((cr) >> 2) >> ((socknr) * 8)) & 3)
313 /* VS bits at [0:1]/[3:2] */
314 #define GET_VS(sr, socknr) \
315 (((sr) >> (2 * (socknr))) & 3)
317 /* reset bits at [7]/[15] */
318 #define GET_RESET(cr, socknr) \
319 ((cr) & (1 << (7 + (8 * (socknr)))))
321 static int db1x_pcmcia_get_status(struct pcmcia_socket
*skt
,
324 struct db1x_pcmcia_sock
*sock
= to_db1x_socket(skt
);
325 unsigned short cr
, sr
;
328 status
= db1x_card_inserted(sock
) ? SS_DETECT
: 0;
330 cr
= bcsr_read(BCSR_PCMCIA
);
331 sr
= bcsr_read(BCSR_STATUS
);
333 /* PB1100/PB1500: voltage key bits are at [5:4] */
334 if (sock
->board_type
== BOARD_TYPE_PB1100
)
337 /* determine card type */
338 switch (GET_VS(sr
, sock
->nr
)) {
341 status
|= SS_3VCARD
; /* 3V card */
343 break; /* 5V card: set nothing */
345 status
|= SS_XVCARD
; /* treated as unsupported in core */
348 /* if Vcc is not zero, we have applied power to a card */
349 status
|= GET_VCC(cr
, sock
->nr
) ? SS_POWERON
: 0;
351 /* reset de-asserted? then we're ready */
352 status
|= (GET_RESET(cr
, sock
->nr
)) ? SS_READY
: SS_RESET
;
359 static int db1x_pcmcia_sock_init(struct pcmcia_socket
*skt
)
364 static int db1x_pcmcia_sock_suspend(struct pcmcia_socket
*skt
)
369 static int au1x00_pcmcia_set_io_map(struct pcmcia_socket
*skt
,
370 struct pccard_io_map
*map
)
372 struct db1x_pcmcia_sock
*sock
= to_db1x_socket(skt
);
374 map
->start
= (u32
)sock
->virt_io
;
375 map
->stop
= map
->start
+ IO_MAP_SIZE
;
380 static int au1x00_pcmcia_set_mem_map(struct pcmcia_socket
*skt
,
381 struct pccard_mem_map
*map
)
383 struct db1x_pcmcia_sock
*sock
= to_db1x_socket(skt
);
385 if (map
->flags
& MAP_ATTRIB
)
386 map
->static_start
= sock
->phys_attr
+ map
->card_start
;
388 map
->static_start
= sock
->phys_mem
+ map
->card_start
;
393 static struct pccard_operations db1x_pcmcia_operations
= {
394 .init
= db1x_pcmcia_sock_init
,
395 .suspend
= db1x_pcmcia_sock_suspend
,
396 .get_status
= db1x_pcmcia_get_status
,
397 .set_socket
= db1x_pcmcia_configure
,
398 .set_io_map
= au1x00_pcmcia_set_io_map
,
399 .set_mem_map
= au1x00_pcmcia_set_mem_map
,
402 static int __devinit
db1x_pcmcia_socket_probe(struct platform_device
*pdev
)
404 struct db1x_pcmcia_sock
*sock
;
408 sock
= kzalloc(sizeof(struct db1x_pcmcia_sock
), GFP_KERNEL
);
414 bid
= BCSR_WHOAMI_BOARD(bcsr_read(BCSR_WHOAMI
));
416 case BCSR_WHOAMI_PB1500
:
417 case BCSR_WHOAMI_PB1500R2
:
418 case BCSR_WHOAMI_PB1100
:
419 sock
->board_type
= BOARD_TYPE_PB1100
;
421 case BCSR_WHOAMI_DB1000
... BCSR_WHOAMI_PB1550_SDR
:
422 sock
->board_type
= BOARD_TYPE_DEFAULT
;
424 case BCSR_WHOAMI_PB1200
... BCSR_WHOAMI_DB1200
:
425 sock
->board_type
= BOARD_TYPE_DB1200
;
428 printk(KERN_INFO
"db1xxx-ss: unknown board %d!\n", bid
);
434 * gather resources necessary and optional nice-to-haves to
436 * This includes IRQs for Carddetection/ejection, the card
437 * itself and optional status change detection.
438 * Also, the memory areas covered by a socket. For these
439 * we require the real 36bit addresses (see the au1000.h
440 * header for more information).
443 /* card: irq assigned to the card itself. */
444 r
= platform_get_resource_byname(pdev
, IORESOURCE_IRQ
, "card");
445 sock
->card_irq
= r
? r
->start
: 0;
447 /* insert: irq which triggers on card insertion/ejection */
448 r
= platform_get_resource_byname(pdev
, IORESOURCE_IRQ
, "insert");
449 sock
->insert_irq
= r
? r
->start
: -1;
451 /* stschg: irq which trigger on card status change (optional) */
452 r
= platform_get_resource_byname(pdev
, IORESOURCE_IRQ
, "stschg");
453 sock
->stschg_irq
= r
? r
->start
: -1;
455 /* eject: irq which triggers on ejection (DB1200/PB1200 only) */
456 r
= platform_get_resource_byname(pdev
, IORESOURCE_IRQ
, "eject");
457 sock
->eject_irq
= r
? r
->start
: -1;
461 /* 36bit PCMCIA Attribute area address */
462 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "pcmcia-attr");
464 printk(KERN_ERR
"pcmcia%d has no 'pseudo-attr' resource!\n",
468 sock
->phys_attr
= r
->start
;
470 /* 36bit PCMCIA Memory area address */
471 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "pcmcia-mem");
473 printk(KERN_ERR
"pcmcia%d has no 'pseudo-mem' resource!\n",
477 sock
->phys_mem
= r
->start
;
479 /* 36bit PCMCIA IO area address */
480 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "pcmcia-io");
482 printk(KERN_ERR
"pcmcia%d has no 'pseudo-io' resource!\n",
486 sock
->phys_io
= r
->start
;
489 * PCMCIA client drivers use the inb/outb macros to access
490 * the IO registers. Since mips_io_port_base is added
491 * to the access address of the mips implementation of
492 * inb/outb, we need to subtract it here because we want
493 * to access the I/O or MEM address directly, without
494 * going through this "mips_io_port_base" mechanism.
496 sock
->virt_io
= (void *)(ioremap(sock
->phys_io
, IO_MAP_SIZE
) -
499 if (!sock
->virt_io
) {
500 printk(KERN_ERR
"pcmcia%d: cannot remap IO area\n",
506 sock
->socket
.ops
= &db1x_pcmcia_operations
;
507 sock
->socket
.owner
= THIS_MODULE
;
508 sock
->socket
.pci_irq
= sock
->card_irq
;
509 sock
->socket
.features
= SS_CAP_STATIC_MAP
| SS_CAP_PCCARD
;
510 sock
->socket
.map_size
= MEM_MAP_SIZE
;
511 sock
->socket
.io_offset
= (unsigned long)sock
->virt_io
;
512 sock
->socket
.dev
.parent
= &pdev
->dev
;
513 sock
->socket
.resource_ops
= &pccard_static_ops
;
515 platform_set_drvdata(pdev
, sock
);
517 ret
= db1x_pcmcia_setup_irqs(sock
);
519 printk(KERN_ERR
"pcmcia%d cannot setup interrupts\n",
526 ret
= pcmcia_register_socket(&sock
->socket
);
528 printk(KERN_ERR
"pcmcia%d failed to register\n", sock
->nr
);
532 printk(KERN_INFO
"Alchemy Db/Pb1xxx pcmcia%d @ io/attr/mem %09llx"
533 "(%p) %09llx %09llx card/insert/stschg/eject irqs @ %d "
534 "%d %d %d\n", sock
->nr
, sock
->phys_io
, sock
->virt_io
,
535 sock
->phys_attr
, sock
->phys_mem
, sock
->card_irq
,
536 sock
->insert_irq
, sock
->stschg_irq
, sock
->eject_irq
);
541 db1x_pcmcia_free_irqs(sock
);
543 iounmap((void *)(sock
->virt_io
+ (u32
)mips_io_port_base
));
549 static int __devexit
db1x_pcmcia_socket_remove(struct platform_device
*pdev
)
551 struct db1x_pcmcia_sock
*sock
= platform_get_drvdata(pdev
);
553 db1x_pcmcia_free_irqs(sock
);
554 pcmcia_unregister_socket(&sock
->socket
);
555 iounmap((void *)(sock
->virt_io
+ (u32
)mips_io_port_base
));
561 static struct platform_driver db1x_pcmcia_socket_driver
= {
563 .name
= "db1xxx_pcmcia",
564 .owner
= THIS_MODULE
,
566 .probe
= db1x_pcmcia_socket_probe
,
567 .remove
= __devexit_p(db1x_pcmcia_socket_remove
),
570 int __init
db1x_pcmcia_socket_load(void)
572 return platform_driver_register(&db1x_pcmcia_socket_driver
);
575 void __exit
db1x_pcmcia_socket_unload(void)
577 platform_driver_unregister(&db1x_pcmcia_socket_driver
);
580 module_init(db1x_pcmcia_socket_load
);
581 module_exit(db1x_pcmcia_socket_unload
);
583 MODULE_LICENSE("GPL");
584 MODULE_DESCRIPTION("PCMCIA Socket Services for Alchemy Db/Pb1x00 boards");
585 MODULE_AUTHOR("Manuel Lauss");