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 "ssb_private.h"
13 #include <linux/ssb/ssb.h>
14 #include <linux/delay.h>
16 #include <linux/etherdevice.h>
18 #include <pcmcia/cistpl.h>
19 #include <pcmcia/ciscode.h>
20 #include <pcmcia/ds.h>
21 #include <pcmcia/cisreg.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 pr_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 pr_info("Switching to %s core, index %d\n",
156 ssb_core_name(dev->id.coreid), dev->core_index);
159 err = ssb_pcmcia_switch_coreidx(bus, dev->core_index);
161 bus->mapped_device = dev;
166 int ssb_pcmcia_switch_segment(struct ssb_bus *bus, u8 seg)
172 WARN_ON((seg != 0) && (seg != 1));
174 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_MEMSEG, seg);
177 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_MEMSEG, &val);
184 if (unlikely(attempts++ > SSB_BAR0_MAX_RETRIES))
188 bus->mapped_pcmcia_seg = seg;
192 pr_err("Failed to switch pcmcia segment\n");
196 static int select_core_and_segment(struct ssb_device *dev,
199 struct ssb_bus *bus = dev->bus;
203 if (*offset >= 0x800) {
209 if (unlikely(dev != bus->mapped_device)) {
210 err = ssb_pcmcia_switch_core(bus, dev);
214 if (unlikely(need_segment != bus->mapped_pcmcia_seg)) {
215 err = ssb_pcmcia_switch_segment(bus, need_segment);
223 static u8 ssb_pcmcia_read8(struct ssb_device *dev, u16 offset)
225 struct ssb_bus *bus = dev->bus;
230 spin_lock_irqsave(&bus->bar_lock, flags);
231 err = select_core_and_segment(dev, &offset);
233 value = readb(bus->mmio + offset);
234 spin_unlock_irqrestore(&bus->bar_lock, flags);
239 static u16 ssb_pcmcia_read16(struct ssb_device *dev, u16 offset)
241 struct ssb_bus *bus = dev->bus;
246 spin_lock_irqsave(&bus->bar_lock, flags);
247 err = select_core_and_segment(dev, &offset);
249 value = readw(bus->mmio + offset);
250 spin_unlock_irqrestore(&bus->bar_lock, flags);
255 static u32 ssb_pcmcia_read32(struct ssb_device *dev, u16 offset)
257 struct ssb_bus *bus = dev->bus;
260 u32 lo = 0xFFFFFFFF, hi = 0xFFFFFFFF;
262 spin_lock_irqsave(&bus->bar_lock, flags);
263 err = select_core_and_segment(dev, &offset);
265 lo = readw(bus->mmio + offset);
266 hi = readw(bus->mmio + offset + 2);
268 spin_unlock_irqrestore(&bus->bar_lock, flags);
270 return (lo | (hi << 16));
273 #ifdef CONFIG_SSB_BLOCKIO
274 static void ssb_pcmcia_block_read(struct ssb_device *dev, void *buffer,
275 size_t count, u16 offset, u8 reg_width)
277 struct ssb_bus *bus = dev->bus;
279 void __iomem *addr = bus->mmio + offset;
282 spin_lock_irqsave(&bus->bar_lock, flags);
283 err = select_core_and_segment(dev, &offset);
285 memset(buffer, 0xFF, count);
293 *buf = __raw_readb(addr);
300 __le16 *buf = buffer;
304 *buf = (__force __le16)__raw_readw(addr);
311 __le16 *buf = buffer;
315 *buf = (__force __le16)__raw_readw(addr);
317 *buf = (__force __le16)__raw_readw(addr + 2);
327 spin_unlock_irqrestore(&bus->bar_lock, flags);
329 #endif /* CONFIG_SSB_BLOCKIO */
331 static void ssb_pcmcia_write8(struct ssb_device *dev, u16 offset, u8 value)
333 struct ssb_bus *bus = dev->bus;
337 spin_lock_irqsave(&bus->bar_lock, flags);
338 err = select_core_and_segment(dev, &offset);
340 writeb(value, bus->mmio + offset);
341 spin_unlock_irqrestore(&bus->bar_lock, flags);
344 static void ssb_pcmcia_write16(struct ssb_device *dev, u16 offset, u16 value)
346 struct ssb_bus *bus = dev->bus;
350 spin_lock_irqsave(&bus->bar_lock, flags);
351 err = select_core_and_segment(dev, &offset);
353 writew(value, bus->mmio + offset);
354 spin_unlock_irqrestore(&bus->bar_lock, flags);
357 static void ssb_pcmcia_write32(struct ssb_device *dev, u16 offset, u32 value)
359 struct ssb_bus *bus = dev->bus;
363 spin_lock_irqsave(&bus->bar_lock, flags);
364 err = select_core_and_segment(dev, &offset);
366 writew((value & 0x0000FFFF), bus->mmio + offset);
367 writew(((value & 0xFFFF0000) >> 16), bus->mmio + offset + 2);
369 spin_unlock_irqrestore(&bus->bar_lock, flags);
372 #ifdef CONFIG_SSB_BLOCKIO
373 static void ssb_pcmcia_block_write(struct ssb_device *dev, const void *buffer,
374 size_t count, u16 offset, u8 reg_width)
376 struct ssb_bus *bus = dev->bus;
378 void __iomem *addr = bus->mmio + offset;
381 spin_lock_irqsave(&bus->bar_lock, flags);
382 err = select_core_and_segment(dev, &offset);
387 const u8 *buf = buffer;
390 __raw_writeb(*buf, addr);
397 const __le16 *buf = buffer;
401 __raw_writew((__force u16)(*buf), addr);
408 const __le16 *buf = buffer;
412 __raw_writew((__force u16)(*buf), addr);
414 __raw_writew((__force u16)(*buf), addr + 2);
424 spin_unlock_irqrestore(&bus->bar_lock, flags);
426 #endif /* CONFIG_SSB_BLOCKIO */
428 /* Not "static", as it's used in main.c */
429 const struct ssb_bus_ops ssb_pcmcia_ops = {
430 .read8 = ssb_pcmcia_read8,
431 .read16 = ssb_pcmcia_read16,
432 .read32 = ssb_pcmcia_read32,
433 .write8 = ssb_pcmcia_write8,
434 .write16 = ssb_pcmcia_write16,
435 .write32 = ssb_pcmcia_write32,
436 #ifdef CONFIG_SSB_BLOCKIO
437 .block_read = ssb_pcmcia_block_read,
438 .block_write = ssb_pcmcia_block_write,
442 static int ssb_pcmcia_sprom_command(struct ssb_bus *bus, u8 command)
448 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROMCTL, command);
451 for (i = 0; i < 1000; i++) {
452 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROMCTL, &value);
455 if (value & SSB_PCMCIA_SPROMCTL_DONE)
463 /* offset is the 16bit word offset */
464 static int ssb_pcmcia_sprom_read(struct ssb_bus *bus, u16 offset, u16 *value)
469 offset *= 2; /* Make byte offset */
471 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRLO,
475 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRHI,
476 (offset & 0xFF00) >> 8);
479 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_READ);
482 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROM_DATALO, &lo);
485 err = ssb_pcmcia_cfg_read(bus, SSB_PCMCIA_SPROM_DATAHI, &hi);
488 *value = (lo | (((u16)hi) << 8));
493 /* offset is the 16bit word offset */
494 static int ssb_pcmcia_sprom_write(struct ssb_bus *bus, u16 offset, u16 value)
498 offset *= 2; /* Make byte offset */
500 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRLO,
504 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_ADDRHI,
505 (offset & 0xFF00) >> 8);
508 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_DATALO,
512 err = ssb_pcmcia_cfg_write(bus, SSB_PCMCIA_SPROM_DATAHI,
513 (value & 0xFF00) >> 8);
516 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITE);
524 /* Read the SPROM image. bufsize is in 16bit words. */
525 static int ssb_pcmcia_sprom_read_all(struct ssb_bus *bus, u16 *sprom)
529 for (i = 0; i < SSB_PCMCIA_SPROM_SIZE; i++) {
530 err = ssb_pcmcia_sprom_read(bus, i, &sprom[i]);
538 /* Write the SPROM image. size is in 16bit words. */
539 static int ssb_pcmcia_sprom_write_all(struct ssb_bus *bus, const u16 *sprom)
543 size_t size = SSB_PCMCIA_SPROM_SIZE;
545 pr_notice("Writing SPROM. Do NOT turn off the power! Please stand by...\n");
546 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITEEN);
548 pr_notice("Could not enable SPROM write access\n");
553 for (i = 0; i < size; i++) {
556 else if (i == size / 2)
558 else if (i == (size * 3) / 4)
562 err = ssb_pcmcia_sprom_write(bus, i, sprom[i]);
564 pr_notice("Failed to write to SPROM\n");
569 err = ssb_pcmcia_sprom_command(bus, SSB_PCMCIA_SPROMCTL_WRITEDIS);
571 pr_notice("Could not disable SPROM write access\n");
576 pr_cont("100%% ]\n");
577 pr_notice("SPROM written\n");
580 return failed ? -EBUSY : 0;
583 static int ssb_pcmcia_sprom_check_crc(const u16 *sprom, size_t size)
589 #define GOTO_ERROR_ON(condition, description) do { \
590 if (unlikely(condition)) { \
591 error_description = description; \
596 static int ssb_pcmcia_get_mac(struct pcmcia_device *p_dev,
600 struct ssb_sprom *sprom = priv;
602 if (tuple->TupleData[0] != CISTPL_FUNCE_LAN_NODE_ID)
604 if (tuple->TupleDataLen != ETH_ALEN + 2)
606 if (tuple->TupleData[1] != ETH_ALEN)
608 memcpy(sprom->il0mac, &tuple->TupleData[2], ETH_ALEN);
612 static int ssb_pcmcia_do_get_invariants(struct pcmcia_device *p_dev,
616 struct ssb_init_invariants *iv = priv;
617 struct ssb_sprom *sprom = &iv->sprom;
618 struct ssb_boardinfo *bi = &iv->boardinfo;
619 const char *error_description;
621 GOTO_ERROR_ON(tuple->TupleDataLen < 1, "VEN tpl < 1");
622 switch (tuple->TupleData[0]) {
623 case SSB_PCMCIA_CIS_ID:
624 GOTO_ERROR_ON((tuple->TupleDataLen != 5) &&
625 (tuple->TupleDataLen != 7),
627 bi->vendor = tuple->TupleData[1] |
628 ((u16)tuple->TupleData[2] << 8);
630 case SSB_PCMCIA_CIS_BOARDREV:
631 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
632 "boardrev tpl size");
633 sprom->board_rev = tuple->TupleData[1];
635 case SSB_PCMCIA_CIS_PA:
636 GOTO_ERROR_ON((tuple->TupleDataLen != 9) &&
637 (tuple->TupleDataLen != 10),
639 sprom->pa0b0 = tuple->TupleData[1] |
640 ((u16)tuple->TupleData[2] << 8);
641 sprom->pa0b1 = tuple->TupleData[3] |
642 ((u16)tuple->TupleData[4] << 8);
643 sprom->pa0b2 = tuple->TupleData[5] |
644 ((u16)tuple->TupleData[6] << 8);
645 sprom->itssi_a = tuple->TupleData[7];
646 sprom->itssi_bg = tuple->TupleData[7];
647 sprom->maxpwr_a = tuple->TupleData[8];
648 sprom->maxpwr_bg = tuple->TupleData[8];
650 case SSB_PCMCIA_CIS_OEMNAME:
651 /* We ignore this. */
653 case SSB_PCMCIA_CIS_CCODE:
654 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
656 sprom->country_code = tuple->TupleData[1];
658 case SSB_PCMCIA_CIS_ANTENNA:
659 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
661 sprom->ant_available_a = tuple->TupleData[1];
662 sprom->ant_available_bg = tuple->TupleData[1];
664 case SSB_PCMCIA_CIS_ANTGAIN:
665 GOTO_ERROR_ON(tuple->TupleDataLen != 2,
667 sprom->antenna_gain.a0 = tuple->TupleData[1];
668 sprom->antenna_gain.a1 = tuple->TupleData[1];
669 sprom->antenna_gain.a2 = tuple->TupleData[1];
670 sprom->antenna_gain.a3 = tuple->TupleData[1];
672 case SSB_PCMCIA_CIS_BFLAGS:
673 GOTO_ERROR_ON((tuple->TupleDataLen != 3) &&
674 (tuple->TupleDataLen != 5),
676 sprom->boardflags_lo = tuple->TupleData[1] |
677 ((u16)tuple->TupleData[2] << 8);
679 case SSB_PCMCIA_CIS_LEDS:
680 GOTO_ERROR_ON(tuple->TupleDataLen != 5,
682 sprom->gpio0 = tuple->TupleData[1];
683 sprom->gpio1 = tuple->TupleData[2];
684 sprom->gpio2 = tuple->TupleData[3];
685 sprom->gpio3 = tuple->TupleData[4];
688 return -ENOSPC; /* continue with next entry */
691 pr_err("PCMCIA: Failed to fetch device invariants: %s\n",
697 int ssb_pcmcia_get_invariants(struct ssb_bus *bus,
698 struct ssb_init_invariants *iv)
700 struct ssb_sprom *sprom = &iv->sprom;
703 memset(sprom, 0xFF, sizeof(*sprom));
705 sprom->boardflags_lo = 0;
706 sprom->boardflags_hi = 0;
708 /* First fetch the MAC address. */
709 res = pcmcia_loop_tuple(bus->host_pcmcia, CISTPL_FUNCE,
710 ssb_pcmcia_get_mac, sprom);
712 pr_err("PCMCIA: Failed to fetch MAC address\n");
716 /* Fetch the vendor specific tuples. */
717 res = pcmcia_loop_tuple(bus->host_pcmcia, SSB_PCMCIA_CIS,
718 ssb_pcmcia_do_get_invariants, iv);
719 if ((res == 0) || (res == -ENOSPC))
722 pr_err("PCMCIA: Failed to fetch device invariants\n");
726 static ssize_t ssb_sprom_show(struct device *pcmciadev,
727 struct device_attribute *attr,
730 struct pcmcia_device *pdev =
731 container_of(pcmciadev, struct pcmcia_device, dev);
734 bus = ssb_pcmcia_dev_to_bus(pdev);
738 return ssb_attr_sprom_show(bus, buf,
739 ssb_pcmcia_sprom_read_all);
742 static ssize_t ssb_sprom_store(struct device *pcmciadev,
743 struct device_attribute *attr,
744 const char *buf, size_t count)
746 struct pcmcia_device *pdev =
747 container_of(pcmciadev, struct pcmcia_device, dev);
750 bus = ssb_pcmcia_dev_to_bus(pdev);
754 return ssb_attr_sprom_store(bus, buf, count,
755 ssb_pcmcia_sprom_check_crc,
756 ssb_pcmcia_sprom_write_all);
759 static DEVICE_ATTR_ADMIN_RW(ssb_sprom);
761 static int ssb_pcmcia_cor_setup(struct ssb_bus *bus, u8 cor)
766 err = ssb_pcmcia_cfg_read(bus, cor, &val);
769 val &= ~COR_SOFT_RESET;
770 val |= COR_FUNC_ENA | COR_IREQ_ENA | COR_LEVEL_REQ;
771 err = ssb_pcmcia_cfg_write(bus, cor, val);
779 /* Initialize the PCMCIA hardware. This is called on Init and Resume. */
780 int ssb_pcmcia_hardware_setup(struct ssb_bus *bus)
784 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
787 /* Switch segment to a known state and sync
788 * bus->mapped_pcmcia_seg with hardware state. */
789 ssb_pcmcia_switch_segment(bus, 0);
790 /* Init the COR register. */
791 err = ssb_pcmcia_cor_setup(bus, CISREG_COR);
794 /* Some cards also need this register to get poked. */
795 err = ssb_pcmcia_cor_setup(bus, CISREG_COR + 0x80);
802 void ssb_pcmcia_exit(struct ssb_bus *bus)
804 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
807 device_remove_file(&bus->host_pcmcia->dev, &dev_attr_ssb_sprom);
810 int ssb_pcmcia_init(struct ssb_bus *bus)
814 if (bus->bustype != SSB_BUSTYPE_PCMCIA)
817 err = ssb_pcmcia_hardware_setup(bus);
821 bus->sprom_size = SSB_PCMCIA_SPROM_SIZE;
822 mutex_init(&bus->sprom_mutex);
823 err = device_create_file(&bus->host_pcmcia->dev, &dev_attr_ssb_sprom);
829 pr_err("Failed to initialize PCMCIA host device\n");