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 static int ssb_pcmcia_switch_core(struct ssb_bus *bus, struct ssb_device *dev)
154 #if SSB_VERBOSE_PCMCIACORESWITCH_DEBUG
155 ssb_info("Switching to %s core, index %d\n",
156 ssb_core_name(dev->id.coreid),
160 err = ssb_pcmcia_switch_coreidx(bus, dev->core_index);
162 bus->mapped_device = dev;
167 int ssb_pcmcia_switch_segment(struct ssb_bus *bus, u8 seg)
173 SSB_WARN_ON((seg != 0) && (seg != 1));
175 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_MEMSEG, seg);
178 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_MEMSEG, &val);
185 if (unlikely(attempts++ > SSB_BAR0_MAX_RETRIES))
189 bus->mapped_pcmcia_seg = seg;
193 ssb_err("Failed to switch pcmcia segment\n");
197 static int select_core_and_segment(struct ssb_device *dev,
200 struct ssb_bus *bus = dev->bus;
204 if (*offset >= 0x800) {
210 if (unlikely(dev != bus->mapped_device)) {
211 err = ssb_pcmcia_switch_core(bus, dev);
215 if (unlikely(need_segment != bus->mapped_pcmcia_seg)) {
216 err = ssb_pcmcia_switch_segment(bus, need_segment);
224 static u8 ssb_pcmcia_read8(struct ssb_device *dev, u16 offset)
226 struct ssb_bus *bus = dev->bus;
231 spin_lock_irqsave(&bus->bar_lock, flags);
232 err = select_core_and_segment(dev, &offset);
234 value = readb(bus->mmio + offset);
235 spin_unlock_irqrestore(&bus->bar_lock, flags);
240 static u16 ssb_pcmcia_read16(struct ssb_device *dev, u16 offset)
242 struct ssb_bus *bus = dev->bus;
247 spin_lock_irqsave(&bus->bar_lock, flags);
248 err = select_core_and_segment(dev, &offset);
250 value = readw(bus->mmio + offset);
251 spin_unlock_irqrestore(&bus->bar_lock, flags);
256 static u32 ssb_pcmcia_read32(struct ssb_device *dev, u16 offset)
258 struct ssb_bus *bus = dev->bus;
261 u32 lo = 0xFFFFFFFF, hi = 0xFFFFFFFF;
263 spin_lock_irqsave(&bus->bar_lock, flags);
264 err = select_core_and_segment(dev, &offset);
266 lo = readw(bus->mmio + offset);
267 hi = readw(bus->mmio + offset + 2);
269 spin_unlock_irqrestore(&bus->bar_lock, flags);
271 return (lo | (hi << 16));
274 #ifdef CONFIG_SSB_BLOCKIO
275 static void ssb_pcmcia_block_read(struct ssb_device *dev, void *buffer,
276 size_t count, u16 offset, u8 reg_width)
278 struct ssb_bus *bus = dev->bus;
280 void __iomem *addr = bus->mmio + offset;
283 spin_lock_irqsave(&bus->bar_lock, flags);
284 err = select_core_and_segment(dev, &offset);
286 memset(buffer, 0xFF, count);
294 *buf = __raw_readb(addr);
301 __le16 *buf = buffer;
303 SSB_WARN_ON(count & 1);
305 *buf = (__force __le16)__raw_readw(addr);
312 __le16 *buf = buffer;
314 SSB_WARN_ON(count & 3);
316 *buf = (__force __le16)__raw_readw(addr);
318 *buf = (__force __le16)__raw_readw(addr + 2);
328 spin_unlock_irqrestore(&bus->bar_lock, flags);
330 #endif /* CONFIG_SSB_BLOCKIO */
332 static void ssb_pcmcia_write8(struct ssb_device *dev, u16 offset, u8 value)
334 struct ssb_bus *bus = dev->bus;
338 spin_lock_irqsave(&bus->bar_lock, flags);
339 err = select_core_and_segment(dev, &offset);
341 writeb(value, bus->mmio + offset);
343 spin_unlock_irqrestore(&bus->bar_lock, flags);
346 static void ssb_pcmcia_write16(struct ssb_device *dev, u16 offset, u16 value)
348 struct ssb_bus *bus = dev->bus;
352 spin_lock_irqsave(&bus->bar_lock, flags);
353 err = select_core_and_segment(dev, &offset);
355 writew(value, bus->mmio + offset);
357 spin_unlock_irqrestore(&bus->bar_lock, flags);
360 static void ssb_pcmcia_write32(struct ssb_device *dev, u16 offset, u32 value)
362 struct ssb_bus *bus = dev->bus;
366 spin_lock_irqsave(&bus->bar_lock, flags);
367 err = select_core_and_segment(dev, &offset);
369 writew((value & 0x0000FFFF), bus->mmio + offset);
370 writew(((value & 0xFFFF0000) >> 16), bus->mmio + offset + 2);
373 spin_unlock_irqrestore(&bus->bar_lock, flags);
376 #ifdef CONFIG_SSB_BLOCKIO
377 static void ssb_pcmcia_block_write(struct ssb_device *dev, const void *buffer,
378 size_t count, u16 offset, u8 reg_width)
380 struct ssb_bus *bus = dev->bus;
382 void __iomem *addr = bus->mmio + offset;
385 spin_lock_irqsave(&bus->bar_lock, flags);
386 err = select_core_and_segment(dev, &offset);
391 const u8 *buf = buffer;
394 __raw_writeb(*buf, addr);
401 const __le16 *buf = buffer;
403 SSB_WARN_ON(count & 1);
405 __raw_writew((__force u16)(*buf), addr);
412 const __le16 *buf = buffer;
414 SSB_WARN_ON(count & 3);
416 __raw_writew((__force u16)(*buf), addr);
418 __raw_writew((__force u16)(*buf), addr + 2);
429 spin_unlock_irqrestore(&bus->bar_lock, flags);
431 #endif /* CONFIG_SSB_BLOCKIO */
433 /* Not "static", as it's used in main.c */
434 const struct ssb_bus_ops ssb_pcmcia_ops = {
435 .read8 = ssb_pcmcia_read8,
436 .read16 = ssb_pcmcia_read16,
437 .read32 = ssb_pcmcia_read32,
438 .write8 = ssb_pcmcia_write8,
439 .write16 = ssb_pcmcia_write16,
440 .write32 = ssb_pcmcia_write32,
441 #ifdef CONFIG_SSB_BLOCKIO
442 .block_read = ssb_pcmcia_block_read,
443 .block_write = ssb_pcmcia_block_write,
447 static int ssb_pcmcia_sprom_command(struct ssb_bus *bus, u8 command)
453 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROMCTL, command);
456 for (i = 0; i < 1000; i++) {
457 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROMCTL, &value);
460 if (value & SSB_PCMCIA_SPROMCTL_DONE)
468 /* offset is the 16bit word offset */
469 static int ssb_pcmcia_sprom_read(struct ssb_bus *bus, u16 offset, u16 *value)
474 offset *= 2; /* Make byte offset */
476 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRLO,
480 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRHI,
481 (offset & 0xFF00) >> 8);
484 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_READ);
487 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROM_DATALO, &lo);
490 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROM_DATAHI, &hi);
493 *value = (lo | (((u16)hi) << 8));
498 /* offset is the 16bit word offset */
499 static int ssb_pcmcia_sprom_write(struct ssb_bus *bus, u16 offset, u16 value)
503 offset *= 2; /* Make byte offset */
505 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRLO,
509 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRHI,
510 (offset & 0xFF00) >> 8);
513 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_DATALO,
517 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_DATAHI,
518 (value & 0xFF00) >> 8);
521 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITE);
529 /* Read the SPROM image. bufsize is in 16bit words. */
530 static int ssb_pcmcia_sprom_read_all(struct ssb_bus *bus, u16 *sprom)
534 for (i = 0; i < SSB_PCMCIA_SPROM_SIZE; i++) {
535 err = ssb_pcmcia_sprom_read(bus, i, &sprom[i]);
543 /* Write the SPROM image. size is in 16bit words. */
544 static int ssb_pcmcia_sprom_write_all(struct ssb_bus *bus, const u16 *sprom)
548 size_t size = SSB_PCMCIA_SPROM_SIZE;
550 ssb_notice("Writing SPROM. Do NOT turn off the power! Please stand by...\n");
551 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITEEN);
553 ssb_notice("Could not enable SPROM write access\n");
558 for (i = 0; i < size; i++) {
561 else if (i == size / 2)
563 else if (i == (size * 3) / 4)
567 err = ssb_pcmcia_sprom_write(bus, i, sprom[i]);
569 ssb_notice("Failed to write to SPROM\n");
574 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITEDIS);
576 ssb_notice("Could not disable SPROM write access\n");
581 ssb_cont("100%% ]\n");
582 ssb_notice("SPROM written\n");
585 return failed ? -EBUSY : 0;
588 static int ssb_pcmcia_sprom_check_crc(const u16 *sprom, size_t size)
594 #define GOTO_ERROR_ON(condition, description) do { \
595 if (unlikely(condition)) { \
596 error_description = description; \
601 static int ssb_pcmcia_get_mac(struct pcmcia_device *p_dev,
605 struct ssb_sprom *sprom = priv;
607 if (tuple->TupleData[0] != CISTPL_FUNCE_LAN_NODE_ID)
609 if (tuple->TupleDataLen != ETH_ALEN + 2)
611 if (tuple->TupleData[1] != ETH_ALEN)
613 memcpy(sprom->il0mac, &tuple->TupleData[2], ETH_ALEN);
617 static int ssb_pcmcia_do_get_invariants(struct pcmcia_device *p_dev,
621 struct ssb_init_invariants *iv = priv;
622 struct ssb_sprom *sprom = &iv->sprom;
623 struct ssb_boardinfo *bi = &iv->boardinfo;
624 const char *error_description;
626 GOTO_ERROR_ON(tuple->TupleDataLen < 1, "VEN tpl < 1");
627 switch (tuple->TupleData[0]) {
628 case SSB_PCMCIA_CIS_ID:
629 GOTO_ERROR_ON((tuple->TupleDataLen != 5) &&
630 (tuple->TupleDataLen != 7),
632 bi->vendor = tuple->TupleData[1] |
633 ((u16)tuple->TupleData[2] << 8);
635 case SSB_PCMCIA_CIS_BOARDREV:
636 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
637 "boardrev tpl size");
638 sprom->board_rev = tuple->TupleData[1];
640 case SSB_PCMCIA_CIS_PA:
641 GOTO_ERROR_ON((tuple->TupleDataLen != 9) &&
642 (tuple->TupleDataLen != 10),
644 sprom->pa0b0 = tuple->TupleData[1] |
645 ((u16)tuple->TupleData[2] << 8);
646 sprom->pa0b1 = tuple->TupleData[3] |
647 ((u16)tuple->TupleData[4] << 8);
648 sprom->pa0b2 = tuple->TupleData[5] |
649 ((u16)tuple->TupleData[6] << 8);
650 sprom->itssi_a = tuple->TupleData[7];
651 sprom->itssi_bg = tuple->TupleData[7];
652 sprom->maxpwr_a = tuple->TupleData[8];
653 sprom->maxpwr_bg = tuple->TupleData[8];
655 case SSB_PCMCIA_CIS_OEMNAME:
656 /* We ignore this. */
658 case SSB_PCMCIA_CIS_CCODE:
659 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
661 sprom->country_code = tuple->TupleData[1];
663 case SSB_PCMCIA_CIS_ANTENNA:
664 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
666 sprom->ant_available_a = tuple->TupleData[1];
667 sprom->ant_available_bg = tuple->TupleData[1];
669 case SSB_PCMCIA_CIS_ANTGAIN:
670 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
672 sprom->antenna_gain.a0 = tuple->TupleData[1];
673 sprom->antenna_gain.a1 = tuple->TupleData[1];
674 sprom->antenna_gain.a2 = tuple->TupleData[1];
675 sprom->antenna_gain.a3 = tuple->TupleData[1];
677 case SSB_PCMCIA_CIS_BFLAGS:
678 GOTO_ERROR_ON((tuple->TupleDataLen != 3) &&
679 (tuple->TupleDataLen != 5),
681 sprom->boardflags_lo = tuple->TupleData[1] |
682 ((u16)tuple->TupleData[2] << 8);
684 case SSB_PCMCIA_CIS_LEDS:
685 GOTO_ERROR_ON(tuple->TupleDataLen != 5,
687 sprom->gpio0 = tuple->TupleData[1];
688 sprom->gpio1 = tuple->TupleData[2];
689 sprom->gpio2 = tuple->TupleData[3];
690 sprom->gpio3 = tuple->TupleData[4];
693 return -ENOSPC; /* continue with next entry */
697 "PCMCIA: Failed to fetch device invariants: %s\n",
703 int ssb_pcmcia_get_invariants(struct ssb_bus *bus,
704 struct ssb_init_invariants *iv)
706 struct ssb_sprom *sprom = &iv->sprom;
709 memset(sprom, 0xFF, sizeof(*sprom));
711 sprom->boardflags_lo = 0;
712 sprom->boardflags_hi = 0;
714 /* First fetch the MAC address. */
715 res = pcmcia_loop_tuple(bus->host_pcmcia, CISTPL_FUNCE,
716 ssb_pcmcia_get_mac, sprom);
719 "PCMCIA: Failed to fetch MAC address\n");
723 /* Fetch the vendor specific tuples. */
724 res = pcmcia_loop_tuple(bus->host_pcmcia, SSB_PCMCIA_CIS,
725 ssb_pcmcia_do_get_invariants, iv);
726 if ((res == 0) || (res == -ENOSPC))
730 "PCMCIA: Failed to fetch device invariants\n");
734 static ssize_t ssb_pcmcia_attr_sprom_show(struct device *pcmciadev,
735 struct device_attribute *attr,
738 struct pcmcia_device *pdev =
739 container_of(pcmciadev, struct pcmcia_device, dev);
742 bus = ssb_pcmcia_dev_to_bus(pdev);
746 return ssb_attr_sprom_show(bus, buf,
747 ssb_pcmcia_sprom_read_all);
750 static ssize_t ssb_pcmcia_attr_sprom_store(struct device *pcmciadev,
751 struct device_attribute *attr,
752 const char *buf, size_t count)
754 struct pcmcia_device *pdev =
755 container_of(pcmciadev, struct pcmcia_device, dev);
758 bus = ssb_pcmcia_dev_to_bus(pdev);
762 return ssb_attr_sprom_store(bus, buf, count,
763 ssb_pcmcia_sprom_check_crc,
764 ssb_pcmcia_sprom_write_all);
767 static DEVICE_ATTR(ssb_sprom, 0600,
768 ssb_pcmcia_attr_sprom_show,
769 ssb_pcmcia_attr_sprom_store);
771 static int ssb_pcmcia_cor_setup(struct ssb_bus *bus, u8 cor)
776 err = ssb_pcmcia_cfg_read(bus, cor, &val);
779 val &= ~COR_SOFT_RESET;
780 val |= COR_FUNC_ENA | COR_IREQ_ENA | COR_LEVEL_REQ;
781 err = ssb_pcmcia_cfg_write(bus, cor, val);
789 /* Initialize the PCMCIA hardware. This is called on Init and Resume. */
790 int ssb_pcmcia_hardware_setup(struct ssb_bus *bus)
794 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
797 /* Switch segment to a known state and sync
798 * bus->mapped_pcmcia_seg with hardware state. */
799 ssb_pcmcia_switch_segment(bus, 0);
800 /* Init the COR register. */
801 err = ssb_pcmcia_cor_setup(bus, CISREG_COR);
804 /* Some cards also need this register to get poked. */
805 err = ssb_pcmcia_cor_setup(bus, CISREG_COR + 0x80);
812 void ssb_pcmcia_exit(struct ssb_bus *bus)
814 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
817 device_remove_file(&bus->host_pcmcia->dev, &dev_attr_ssb_sprom);
820 int ssb_pcmcia_init(struct ssb_bus *bus)
824 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
827 err = ssb_pcmcia_hardware_setup(bus);
831 bus->sprom_size = SSB_PCMCIA_SPROM_SIZE;
832 mutex_init(&bus->sprom_mutex);
833 err = device_create_file(&bus->host_pcmcia->dev, &dev_attr_ssb_sprom);
839 ssb_err("Failed to initialize PCMCIA host device\n");