2 * Sonics Silicon Backplane
3 * PCMCIA-Hostbus related functions
5 * Copyright 2006 Johannes Berg <johannes@sipsolutions.net>
6 * Copyright 2007-2008 Michael Buesch <m@bues.ch>
8 * Licensed under the GNU/GPL. See COPYING for details.
11 #include <linux/ssb/ssb.h>
12 #include <linux/delay.h>
14 #include <linux/etherdevice.h>
16 #include <pcmcia/cistpl.h>
17 #include <pcmcia/ciscode.h>
18 #include <pcmcia/ds.h>
19 #include <pcmcia/cisreg.h>
21 #include "ssb_private.h"
24 /* Define the following to 1 to enable a printk on each coreswitch. */
25 #define SSB_VERBOSE_PCMCIACORESWITCH_DEBUG 0
28 /* PCMCIA configuration registers */
29 #define SSB_PCMCIA_ADDRESS0 0x2E
30 #define SSB_PCMCIA_ADDRESS1 0x30
31 #define SSB_PCMCIA_ADDRESS2 0x32
32 #define SSB_PCMCIA_MEMSEG 0x34
33 #define SSB_PCMCIA_SPROMCTL 0x36
34 #define SSB_PCMCIA_SPROMCTL_IDLE 0
35 #define SSB_PCMCIA_SPROMCTL_WRITE 1
36 #define SSB_PCMCIA_SPROMCTL_READ 2
37 #define SSB_PCMCIA_SPROMCTL_WRITEEN 4
38 #define SSB_PCMCIA_SPROMCTL_WRITEDIS 7
39 #define SSB_PCMCIA_SPROMCTL_DONE 8
40 #define SSB_PCMCIA_SPROM_DATALO 0x38
41 #define SSB_PCMCIA_SPROM_DATAHI 0x3A
42 #define SSB_PCMCIA_SPROM_ADDRLO 0x3C
43 #define SSB_PCMCIA_SPROM_ADDRHI 0x3E
45 /* Hardware invariants CIS tuples */
46 #define SSB_PCMCIA_CIS 0x80
47 #define SSB_PCMCIA_CIS_ID 0x01
48 #define SSB_PCMCIA_CIS_BOARDREV 0x02
49 #define SSB_PCMCIA_CIS_PA 0x03
50 #define SSB_PCMCIA_CIS_PA_PA0B0_LO 0
51 #define SSB_PCMCIA_CIS_PA_PA0B0_HI 1
52 #define SSB_PCMCIA_CIS_PA_PA0B1_LO 2
53 #define SSB_PCMCIA_CIS_PA_PA0B1_HI 3
54 #define SSB_PCMCIA_CIS_PA_PA0B2_LO 4
55 #define SSB_PCMCIA_CIS_PA_PA0B2_HI 5
56 #define SSB_PCMCIA_CIS_PA_ITSSI 6
57 #define SSB_PCMCIA_CIS_PA_MAXPOW 7
58 #define SSB_PCMCIA_CIS_OEMNAME 0x04
59 #define SSB_PCMCIA_CIS_CCODE 0x05
60 #define SSB_PCMCIA_CIS_ANTENNA 0x06
61 #define SSB_PCMCIA_CIS_ANTGAIN 0x07
62 #define SSB_PCMCIA_CIS_BFLAGS 0x08
63 #define SSB_PCMCIA_CIS_LEDS 0x09
65 /* PCMCIA SPROM size. */
66 #define SSB_PCMCIA_SPROM_SIZE 256
67 #define SSB_PCMCIA_SPROM_SIZE_BYTES (SSB_PCMCIA_SPROM_SIZE * sizeof(u16))
70 /* Write to a PCMCIA configuration register. */
71 static int ssb_pcmcia_cfg_write(struct ssb_bus *bus, u8 offset, u8 value)
75 res = pcmcia_write_config_byte(bus->host_pcmcia, offset, value);
76 if (unlikely(res != 0))
82 /* Read from a PCMCIA configuration register. */
83 static int ssb_pcmcia_cfg_read(struct ssb_bus *bus, u8 offset, u8 *value)
87 res = pcmcia_read_config_byte(bus->host_pcmcia, offset, value);
88 if (unlikely(res != 0))
94 int ssb_pcmcia_switch_coreidx(struct ssb_bus *bus,
104 addr = (coreidx * SSB_CORE_SIZE) + SSB_ENUM_BASE;
106 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_ADDRESS0,
107 (addr & 0x0000F000) >> 12);
110 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_ADDRESS1,
111 (addr & 0x00FF0000) >> 16);
114 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_ADDRESS2,
115 (addr & 0xFF000000) >> 24);
121 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_ADDRESS0, &val);
124 read_addr |= ((u32)(val & 0x0F)) << 12;
125 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_ADDRESS1, &val);
128 read_addr |= ((u32)val) << 16;
129 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_ADDRESS2, &val);
132 read_addr |= ((u32)val) << 24;
134 cur_core = (read_addr - SSB_ENUM_BASE) / SSB_CORE_SIZE;
135 if (cur_core == coreidx)
139 if (attempts++ > SSB_BAR0_MAX_RETRIES)
146 ssb_err("Failed to switch to core %u\n", coreidx);
150 int ssb_pcmcia_switch_core(struct ssb_bus *bus,
151 struct ssb_device *dev)
155 #if SSB_VERBOSE_PCMCIACORESWITCH_DEBUG
156 ssb_info("Switching to %s core, index %d\n",
157 ssb_core_name(dev->id.coreid),
161 err = ssb_pcmcia_switch_coreidx(bus, dev->core_index);
163 bus->mapped_device = dev;
168 int ssb_pcmcia_switch_segment(struct ssb_bus *bus, u8 seg)
174 SSB_WARN_ON((seg != 0) && (seg != 1));
176 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_MEMSEG, seg);
179 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_MEMSEG, &val);
186 if (unlikely(attempts++ > SSB_BAR0_MAX_RETRIES))
190 bus->mapped_pcmcia_seg = seg;
194 ssb_err("Failed to switch pcmcia segment\n");
198 static int select_core_and_segment(struct ssb_device *dev,
201 struct ssb_bus *bus = dev->bus;
205 if (*offset >= 0x800) {
211 if (unlikely(dev != bus->mapped_device)) {
212 err = ssb_pcmcia_switch_core(bus, dev);
216 if (unlikely(need_segment != bus->mapped_pcmcia_seg)) {
217 err = ssb_pcmcia_switch_segment(bus, need_segment);
225 static u8 ssb_pcmcia_read8(struct ssb_device *dev, u16 offset)
227 struct ssb_bus *bus = dev->bus;
232 spin_lock_irqsave(&bus->bar_lock, flags);
233 err = select_core_and_segment(dev, &offset);
235 value = readb(bus->mmio + offset);
236 spin_unlock_irqrestore(&bus->bar_lock, flags);
241 static u16 ssb_pcmcia_read16(struct ssb_device *dev, u16 offset)
243 struct ssb_bus *bus = dev->bus;
248 spin_lock_irqsave(&bus->bar_lock, flags);
249 err = select_core_and_segment(dev, &offset);
251 value = readw(bus->mmio + offset);
252 spin_unlock_irqrestore(&bus->bar_lock, flags);
257 static u32 ssb_pcmcia_read32(struct ssb_device *dev, u16 offset)
259 struct ssb_bus *bus = dev->bus;
262 u32 lo = 0xFFFFFFFF, hi = 0xFFFFFFFF;
264 spin_lock_irqsave(&bus->bar_lock, flags);
265 err = select_core_and_segment(dev, &offset);
267 lo = readw(bus->mmio + offset);
268 hi = readw(bus->mmio + offset + 2);
270 spin_unlock_irqrestore(&bus->bar_lock, flags);
272 return (lo | (hi << 16));
275 #ifdef CONFIG_SSB_BLOCKIO
276 static void ssb_pcmcia_block_read(struct ssb_device *dev, void *buffer,
277 size_t count, u16 offset, u8 reg_width)
279 struct ssb_bus *bus = dev->bus;
281 void __iomem *addr = bus->mmio + offset;
284 spin_lock_irqsave(&bus->bar_lock, flags);
285 err = select_core_and_segment(dev, &offset);
287 memset(buffer, 0xFF, count);
295 *buf = __raw_readb(addr);
302 __le16 *buf = buffer;
304 SSB_WARN_ON(count & 1);
306 *buf = (__force __le16)__raw_readw(addr);
313 __le16 *buf = buffer;
315 SSB_WARN_ON(count & 3);
317 *buf = (__force __le16)__raw_readw(addr);
319 *buf = (__force __le16)__raw_readw(addr + 2);
329 spin_unlock_irqrestore(&bus->bar_lock, flags);
331 #endif /* CONFIG_SSB_BLOCKIO */
333 static void ssb_pcmcia_write8(struct ssb_device *dev, u16 offset, u8 value)
335 struct ssb_bus *bus = dev->bus;
339 spin_lock_irqsave(&bus->bar_lock, flags);
340 err = select_core_and_segment(dev, &offset);
342 writeb(value, bus->mmio + offset);
344 spin_unlock_irqrestore(&bus->bar_lock, flags);
347 static void ssb_pcmcia_write16(struct ssb_device *dev, u16 offset, u16 value)
349 struct ssb_bus *bus = dev->bus;
353 spin_lock_irqsave(&bus->bar_lock, flags);
354 err = select_core_and_segment(dev, &offset);
356 writew(value, bus->mmio + offset);
358 spin_unlock_irqrestore(&bus->bar_lock, flags);
361 static void ssb_pcmcia_write32(struct ssb_device *dev, u16 offset, u32 value)
363 struct ssb_bus *bus = dev->bus;
367 spin_lock_irqsave(&bus->bar_lock, flags);
368 err = select_core_and_segment(dev, &offset);
370 writew((value & 0x0000FFFF), bus->mmio + offset);
371 writew(((value & 0xFFFF0000) >> 16), bus->mmio + offset + 2);
374 spin_unlock_irqrestore(&bus->bar_lock, flags);
377 #ifdef CONFIG_SSB_BLOCKIO
378 static void ssb_pcmcia_block_write(struct ssb_device *dev, const void *buffer,
379 size_t count, u16 offset, u8 reg_width)
381 struct ssb_bus *bus = dev->bus;
383 void __iomem *addr = bus->mmio + offset;
386 spin_lock_irqsave(&bus->bar_lock, flags);
387 err = select_core_and_segment(dev, &offset);
392 const u8 *buf = buffer;
395 __raw_writeb(*buf, addr);
402 const __le16 *buf = buffer;
404 SSB_WARN_ON(count & 1);
406 __raw_writew((__force u16)(*buf), addr);
413 const __le16 *buf = buffer;
415 SSB_WARN_ON(count & 3);
417 __raw_writew((__force u16)(*buf), addr);
419 __raw_writew((__force u16)(*buf), addr + 2);
430 spin_unlock_irqrestore(&bus->bar_lock, flags);
432 #endif /* CONFIG_SSB_BLOCKIO */
434 /* Not "static", as it's used in main.c */
435 const struct ssb_bus_ops ssb_pcmcia_ops = {
436 .read8 = ssb_pcmcia_read8,
437 .read16 = ssb_pcmcia_read16,
438 .read32 = ssb_pcmcia_read32,
439 .write8 = ssb_pcmcia_write8,
440 .write16 = ssb_pcmcia_write16,
441 .write32 = ssb_pcmcia_write32,
442 #ifdef CONFIG_SSB_BLOCKIO
443 .block_read = ssb_pcmcia_block_read,
444 .block_write = ssb_pcmcia_block_write,
448 static int ssb_pcmcia_sprom_command(struct ssb_bus *bus, u8 command)
454 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROMCTL, command);
457 for (i = 0; i < 1000; i++) {
458 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROMCTL, &value);
461 if (value & SSB_PCMCIA_SPROMCTL_DONE)
469 /* offset is the 16bit word offset */
470 static int ssb_pcmcia_sprom_read(struct ssb_bus *bus, u16 offset, u16 *value)
475 offset *= 2; /* Make byte offset */
477 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRLO,
481 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRHI,
482 (offset & 0xFF00) >> 8);
485 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_READ);
488 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROM_DATALO, &lo);
491 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROM_DATAHI, &hi);
494 *value = (lo | (((u16)hi) << 8));
499 /* offset is the 16bit word offset */
500 static int ssb_pcmcia_sprom_write(struct ssb_bus *bus, u16 offset, u16 value)
504 offset *= 2; /* Make byte offset */
506 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRLO,
510 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRHI,
511 (offset & 0xFF00) >> 8);
514 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_DATALO,
518 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_DATAHI,
519 (value & 0xFF00) >> 8);
522 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITE);
530 /* Read the SPROM image. bufsize is in 16bit words. */
531 static int ssb_pcmcia_sprom_read_all(struct ssb_bus *bus, u16 *sprom)
535 for (i = 0; i < SSB_PCMCIA_SPROM_SIZE; i++) {
536 err = ssb_pcmcia_sprom_read(bus, i, &sprom[i]);
544 /* Write the SPROM image. size is in 16bit words. */
545 static int ssb_pcmcia_sprom_write_all(struct ssb_bus *bus, const u16 *sprom)
549 size_t size = SSB_PCMCIA_SPROM_SIZE;
551 ssb_notice("Writing SPROM. Do NOT turn off the power! Please stand by...\n");
552 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITEEN);
554 ssb_notice("Could not enable SPROM write access\n");
559 for (i = 0; i < size; i++) {
562 else if (i == size / 2)
564 else if (i == (size * 3) / 4)
568 err = ssb_pcmcia_sprom_write(bus, i, sprom[i]);
570 ssb_notice("Failed to write to SPROM\n");
575 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITEDIS);
577 ssb_notice("Could not disable SPROM write access\n");
582 ssb_cont("100%% ]\n");
583 ssb_notice("SPROM written\n");
586 return failed ? -EBUSY : 0;
589 static int ssb_pcmcia_sprom_check_crc(const u16 *sprom, size_t size)
595 #define GOTO_ERROR_ON(condition, description) do { \
596 if (unlikely(condition)) { \
597 error_description = description; \
602 static int ssb_pcmcia_get_mac(struct pcmcia_device *p_dev,
606 struct ssb_sprom *sprom = priv;
608 if (tuple->TupleData[0] != CISTPL_FUNCE_LAN_NODE_ID)
610 if (tuple->TupleDataLen != ETH_ALEN + 2)
612 if (tuple->TupleData[1] != ETH_ALEN)
614 memcpy(sprom->il0mac, &tuple->TupleData[2], ETH_ALEN);
618 static int ssb_pcmcia_do_get_invariants(struct pcmcia_device *p_dev,
622 struct ssb_init_invariants *iv = priv;
623 struct ssb_sprom *sprom = &iv->sprom;
624 struct ssb_boardinfo *bi = &iv->boardinfo;
625 const char *error_description;
627 GOTO_ERROR_ON(tuple->TupleDataLen < 1, "VEN tpl < 1");
628 switch (tuple->TupleData[0]) {
629 case SSB_PCMCIA_CIS_ID:
630 GOTO_ERROR_ON((tuple->TupleDataLen != 5) &&
631 (tuple->TupleDataLen != 7),
633 bi->vendor = tuple->TupleData[1] |
634 ((u16)tuple->TupleData[2] << 8);
636 case SSB_PCMCIA_CIS_BOARDREV:
637 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
638 "boardrev tpl size");
639 sprom->board_rev = tuple->TupleData[1];
641 case SSB_PCMCIA_CIS_PA:
642 GOTO_ERROR_ON((tuple->TupleDataLen != 9) &&
643 (tuple->TupleDataLen != 10),
645 sprom->pa0b0 = tuple->TupleData[1] |
646 ((u16)tuple->TupleData[2] << 8);
647 sprom->pa0b1 = tuple->TupleData[3] |
648 ((u16)tuple->TupleData[4] << 8);
649 sprom->pa0b2 = tuple->TupleData[5] |
650 ((u16)tuple->TupleData[6] << 8);
651 sprom->itssi_a = tuple->TupleData[7];
652 sprom->itssi_bg = tuple->TupleData[7];
653 sprom->maxpwr_a = tuple->TupleData[8];
654 sprom->maxpwr_bg = tuple->TupleData[8];
656 case SSB_PCMCIA_CIS_OEMNAME:
657 /* We ignore this. */
659 case SSB_PCMCIA_CIS_CCODE:
660 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
662 sprom->country_code = tuple->TupleData[1];
664 case SSB_PCMCIA_CIS_ANTENNA:
665 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
667 sprom->ant_available_a = tuple->TupleData[1];
668 sprom->ant_available_bg = tuple->TupleData[1];
670 case SSB_PCMCIA_CIS_ANTGAIN:
671 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
673 sprom->antenna_gain.a0 = tuple->TupleData[1];
674 sprom->antenna_gain.a1 = tuple->TupleData[1];
675 sprom->antenna_gain.a2 = tuple->TupleData[1];
676 sprom->antenna_gain.a3 = tuple->TupleData[1];
678 case SSB_PCMCIA_CIS_BFLAGS:
679 GOTO_ERROR_ON((tuple->TupleDataLen != 3) &&
680 (tuple->TupleDataLen != 5),
682 sprom->boardflags_lo = tuple->TupleData[1] |
683 ((u16)tuple->TupleData[2] << 8);
685 case SSB_PCMCIA_CIS_LEDS:
686 GOTO_ERROR_ON(tuple->TupleDataLen != 5,
688 sprom->gpio0 = tuple->TupleData[1];
689 sprom->gpio1 = tuple->TupleData[2];
690 sprom->gpio2 = tuple->TupleData[3];
691 sprom->gpio3 = tuple->TupleData[4];
694 return -ENOSPC; /* continue with next entry */
698 "PCMCIA: Failed to fetch device invariants: %s\n",
704 int ssb_pcmcia_get_invariants(struct ssb_bus *bus,
705 struct ssb_init_invariants *iv)
707 struct ssb_sprom *sprom = &iv->sprom;
710 memset(sprom, 0xFF, sizeof(*sprom));
712 sprom->boardflags_lo = 0;
713 sprom->boardflags_hi = 0;
715 /* First fetch the MAC address. */
716 res = pcmcia_loop_tuple(bus->host_pcmcia, CISTPL_FUNCE,
717 ssb_pcmcia_get_mac, sprom);
720 "PCMCIA: Failed to fetch MAC address\n");
724 /* Fetch the vendor specific tuples. */
725 res = pcmcia_loop_tuple(bus->host_pcmcia, SSB_PCMCIA_CIS,
726 ssb_pcmcia_do_get_invariants, iv);
727 if ((res == 0) || (res == -ENOSPC))
731 "PCMCIA: Failed to fetch device invariants\n");
735 static ssize_t ssb_pcmcia_attr_sprom_show(struct device *pcmciadev,
736 struct device_attribute *attr,
739 struct pcmcia_device *pdev =
740 container_of(pcmciadev, struct pcmcia_device, dev);
743 bus = ssb_pcmcia_dev_to_bus(pdev);
747 return ssb_attr_sprom_show(bus, buf,
748 ssb_pcmcia_sprom_read_all);
751 static ssize_t ssb_pcmcia_attr_sprom_store(struct device *pcmciadev,
752 struct device_attribute *attr,
753 const char *buf, size_t count)
755 struct pcmcia_device *pdev =
756 container_of(pcmciadev, struct pcmcia_device, dev);
759 bus = ssb_pcmcia_dev_to_bus(pdev);
763 return ssb_attr_sprom_store(bus, buf, count,
764 ssb_pcmcia_sprom_check_crc,
765 ssb_pcmcia_sprom_write_all);
768 static DEVICE_ATTR(ssb_sprom, 0600,
769 ssb_pcmcia_attr_sprom_show,
770 ssb_pcmcia_attr_sprom_store);
772 static int ssb_pcmcia_cor_setup(struct ssb_bus *bus, u8 cor)
777 err = ssb_pcmcia_cfg_read(bus, cor, &val);
780 val &= ~COR_SOFT_RESET;
781 val |= COR_FUNC_ENA | COR_IREQ_ENA | COR_LEVEL_REQ;
782 err = ssb_pcmcia_cfg_write(bus, cor, val);
790 /* Initialize the PCMCIA hardware. This is called on Init and Resume. */
791 int ssb_pcmcia_hardware_setup(struct ssb_bus *bus)
795 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
798 /* Switch segment to a known state and sync
799 * bus->mapped_pcmcia_seg with hardware state. */
800 ssb_pcmcia_switch_segment(bus, 0);
801 /* Init the COR register. */
802 err = ssb_pcmcia_cor_setup(bus, CISREG_COR);
805 /* Some cards also need this register to get poked. */
806 err = ssb_pcmcia_cor_setup(bus, CISREG_COR + 0x80);
813 void ssb_pcmcia_exit(struct ssb_bus *bus)
815 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
818 device_remove_file(&bus->host_pcmcia->dev, &dev_attr_ssb_sprom);
821 int ssb_pcmcia_init(struct ssb_bus *bus)
825 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
828 err = ssb_pcmcia_hardware_setup(bus);
832 bus->sprom_size = SSB_PCMCIA_SPROM_SIZE;
833 mutex_init(&bus->sprom_mutex);
834 err = device_create_file(&bus->host_pcmcia->dev, &dev_attr_ssb_sprom);
840 ssb_err("Failed to initialize PCMCIA host device\n");