From: "David E. Box" <david.e....@linux.intel.com>

Current Intel SOC cores use a MailBox Interface (MBI) to provide access to unit
devices connected to the system fabric. This driver implements the API required
for other kernel drivers to configure the unit registers accessible through this
interface. Drivers that will require access to the MBI include but are not
limited to, RAPL, DPTF, as well as future drivers. Serialized access is handled
by all exported routines with spinlocks.

The API includes 3 functions for access to unit registers:

u32 iosf_mbi_read(u8 port, u8 opcode, u32 offset)
void iosf_mbi_write(u8 port, u8 opcode, u32 offset, u32 mdr)
void iosf_mbi_modify(u8 port, u8 opcode, u32 offset, u32 mdr, u32 mask)

port:   indicating the unit being accessed
opcode: the read or write port specific opcode
offset: the register offset within the port
mdr:    the register data to be written, or modified
mask:   bit locations in mdr to change

Note: GPU code handles access to the GFX unit. Therefore access to that unit
with this driver is disallowed to avoid conflicts.

Signed-off-by: David E. Box <david.e....@linux.intel.com>
---
 arch/x86/Kconfig                |    8 ++
 arch/x86/include/asm/iosf_mbi.h |   89 ++++++++++++++++++++++
 arch/x86/kernel/Makefile        |    1 +
 arch/x86/kernel/iosf_mbi.c      |  160 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 258 insertions(+)
 create mode 100644 arch/x86/include/asm/iosf_mbi.h
 create mode 100644 arch/x86/kernel/Module.symvers
 create mode 100644 arch/x86/kernel/iosf_mbi.c

diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
index ee2fb9d..4d1b365 100644
--- a/arch/x86/Kconfig
+++ b/arch/x86/Kconfig
@@ -1113,6 +1113,14 @@ config X86_CPUID
          with major 203 and minors 0 to 31 for /dev/cpu/0/cpuid to
          /dev/cpu/31/cpuid.
 
+config X86_IOSF_MBI
+       bool "IOSF-SB MailBox Interface access support for Intel SOC's"
+       ---help---
+         This device provides access to the Intel On-Chip System Fabric
+         Sideband MailBox Interface required for configuration of unit
+         devices connected to the fabric. Drivers that require access to the
+         MBI include but are not limited to RAPL and DPTF.
+
 choice
        prompt "High Memory Support"
        default HIGHMEM64G if X86_NUMAQ
diff --git a/arch/x86/include/asm/iosf_mbi.h b/arch/x86/include/asm/iosf_mbi.h
new file mode 100644
index 0000000..861834f
--- /dev/null
+++ b/arch/x86/include/asm/iosf_mbi.h
@@ -0,0 +1,89 @@
+/*
+ * iosf_mbi.h: IOSF MailBox Interface access for Intel SOC's.
+ */
+
+#ifndef INTEL_IOSF_MBI_SYMS_H
+#define INTEL_IOSF_MBI_SYMS_H
+
+#define IOSF_MBI_MCR_OFFSET    0x0
+#define IOSF_MBI_MDR_OFFSET    0x4
+#define IOSF_MBI_MCRX_OFFSET   0x8
+
+#define IOSF_MBI_RD_MASK       0xFEFFFFFF
+#define IOSF_MBI_WR_MASK       0X01000000
+
+#define IOSF_MBI_MASK_HI       0xFFFFFF00
+#define IOSF_MBI_MASK_LO       0x000000FF
+#define IOSF_MBI_ENABLE                0xF0
+
+#define IOSF_MBI_MAX_PORTS     0xFF
+
+/* IOSF-SB unit access methods */
+#define IOSF_MBI_UNIT_AUNIT    0x00
+#define IOSF_MBI_UNIT_SMC      0x01
+#define IOSF_MBI_UNIT_CPU      0x02
+#define IOSF_MBI_UNIT_BUNIT    0x03
+#define IOSF_MBI_UNIT_PMC      0x04
+#define IOSF_MBI_UNIT_GFX      0x06
+#define IOSF_MBI_UNIT_SMI      0x0C
+#define IOSF_MBI_UNIT_USB      0x43
+#define IOSF_MBI_UNIT_SATA     0xA3
+#define IOSF_MBI_UNIT_PCIE     0xA6
+
+/* Read/write opcodes */
+#define IOSF_MBI_AUNIT_READ    0x10
+#define IOSF_MBI_AUNIT_WRITE   0x11
+#define IOSF_MBI_SMC_READ      0x10
+#define IOSF_MBI_SMC_WRITE     0x11
+#define IOSF_MBI_CPU_READ      0x10
+#define IOSF_MBI_CPU_WRITE     0x11
+#define IOSF_MBI_BUNIT_READ    0x10
+#define IOSF_MBI_BUNIT_WRITE   0x11
+#define IOSF_MBI_PMC_READ      0x06
+#define IOSF_MBI_PMC_WRITE     0x07
+#define IOSF_MBI_GFX_READ      0x00
+#define IOSF_MBI_GFX_WRITE     0x01
+#define IOSF_MBI_SMIO_READ     0x06
+#define IOSF_MBI_SMIO_WRITE    0x07
+#define IOSF_MBI_USB_READ      0x06
+#define IOSF_MBI_USB_WRITE     0x07
+#define IOSF_MBI_SATA_READ     0x00
+#define IOSF_MBI_SATA_WRITE    0x01
+#define IOSF_MBI_PCIE_READ     0x00
+#define IOSF_MBI_PCIE_WRITE    0x01
+
+/**
+ * iosf_mbi_read() - IOSF MailBox Interface read command
+ * @port:      port indicating subunit being accessed
+ * @opcode:    port specific read or write opcode
+ * @offset:    register address offset
+ *
+ * Locking is handled by spinlock - cannot sleep.
+ * Return: 32 bit value of mdr register
+ */
+u32 iosf_mbi_read(u8 port, u8 opcode, u32 offset);
+
+/**
+ * iosf_mbi_write() - IOSF MailBox unmasked write command
+ * @port:      port indicating subunit being accessed
+ * @opcode:    port specific read or write opcode
+ * @offset:    register address offset
+ * @mdr:       register data to be written
+ *
+ * Locking is handled by spinlock - cannot sleep.
+ */
+void iosf_mbi_write(u8 port, u8 opcode, u32 offset, u32 mdr);
+
+/**
+ * iosf_mbi_modify() - IOSF MailBox maksed write command
+ * @port:      port indicating subunit being accessed
+ * @opcode:    port specific read or write opcode
+ * @offset:    register address offset
+ * @mdr:       register data being modified
+ * @mask:      mask indicating bits in mdr to be modified
+ *
+ * Locking is handled by spinlock - cannot sleep.
+ */
+void iosf_mbi_modify(u8 port, u8 opcode, u32 offset, u32 mdr, u32 mask);
+
+#endif /* INTEL_IOSF_MBI_SYMS_H */
diff --git a/arch/x86/kernel/Makefile b/arch/x86/kernel/Makefile
index a5408b9..6d1e9ab 100644
--- a/arch/x86/kernel/Makefile
+++ b/arch/x86/kernel/Makefile
@@ -50,6 +50,7 @@ obj-y                         += acpi/
 obj-y                          += reboot.o
 obj-$(CONFIG_X86_MSR)          += msr.o
 obj-$(CONFIG_X86_CPUID)                += cpuid.o
+obj-$(CONFIG_X86_IOSF_MBI)     += iosf_mbi.o
 obj-$(CONFIG_PCI)              += early-quirks.o
 apm-y                          := apm_32.o
 obj-$(CONFIG_APM)              += apm.o
diff --git a/arch/x86/kernel/Module.symvers b/arch/x86/kernel/Module.symvers
new file mode 100644
index 0000000..e69de29
diff --git a/arch/x86/kernel/iosf_mbi.c b/arch/x86/kernel/iosf_mbi.c
new file mode 100644
index 0000000..d2e990e
--- /dev/null
+++ b/arch/x86/kernel/iosf_mbi.c
@@ -0,0 +1,160 @@
+/*
+ * IOSF-SB MailBox Interface Driver
+ * Copyright (c) 2013, Intel Corporation.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ *
+ * The IOSF-SB is a fabric bus available on Atom based SOC's that uses a
+ * mailbox interface (MBI) to communicate with mutiple devices. This
+ * driver implements access to this interface.
+ */
+
+#include <linux/module.h>
+#include <linux/device.h>
+#include <linux/init.h>
+#include <linux/spinlock.h>
+#include <linux/types.h>
+#include <linux/acpi.h>
+#include <linux/platform_device.h>
+
+#include <asm/iosf_mbi.h>
+
+static DEFINE_SPINLOCK(iosf_mbi_lock);
+
+static inline u32 iosf_mbi_form_mcr(u8 op, u8 port, u8 offset)
+{
+       return (op << 24) | (port << 16) | (offset << 8) | IOSF_MBI_ENABLE;
+}
+
+static struct acpi_device_id iosf_mbi_priv_ids[] = {
+       { "INT33BD", 0},
+       { "", 0},
+};
+MODULE_DEVICE_TABLE(acpi, iosf_mbi_priv_ids);
+
+static struct {
+       void __iomem *addr;
+} iosf_mbi_data;
+
+/* Hold lock before calling */
+static u32 iosf_mbi_read_mdr(u32 mcrx, u32 mcr, void __iomem *addr)
+{
+       if (mcrx)
+               iowrite32(mcrx, addr + IOSF_MBI_MCRX_OFFSET);
+       iowrite32(mcr, addr + IOSF_MBI_MCR_OFFSET);
+       return ioread32(addr + IOSF_MBI_MDR_OFFSET);
+}
+
+/* Hold lock before calling */
+static void iosf_mbi_write_mdr(u32 mcrx, u32 mcr, u32 mdr, void __iomem *addr)
+{
+
+       iowrite32(mdr, addr + IOSF_MBI_MDR_OFFSET);
+       if (mcrx)
+               iowrite32(mcrx, addr + IOSF_MBI_MCRX_OFFSET);
+       iowrite32(mcr, addr + IOSF_MBI_MCR_OFFSET);
+}
+
+u32 iosf_mbi_read(u8 port, u8 opcode, u32 offset)
+{
+       u32 mcr, mcrx;
+       u32 ret;
+       unsigned long flags;
+
+       /*Access to the GFX unit is handled by GPU code */
+       BUG_ON(port == IOSF_MBI_UNIT_GFX);
+
+       mcr = iosf_mbi_form_mcr(opcode, port, offset & IOSF_MBI_MASK_LO);
+       mcrx = offset & IOSF_MBI_MASK_HI;
+
+       spin_lock_irqsave(&iosf_mbi_lock, flags);
+       ret = iosf_mbi_read_mdr(mcrx, mcr, iosf_mbi_data.addr);
+       spin_unlock_irqrestore(&iosf_mbi_lock, flags);
+
+       return ret;
+}
+EXPORT_SYMBOL(iosf_mbi_read);
+
+void iosf_mbi_write(u8 port, u8 opcode, u32 offset, u32 mdr)
+{
+       u32 mcr, mcrx;
+       unsigned long flags;
+
+       /*Access to the GFX unit is handled by GPU code */
+       BUG_ON(port == IOSF_MBI_UNIT_GFX);
+
+       mcr = iosf_mbi_form_mcr(opcode, port, offset & IOSF_MBI_MASK_LO);
+       mcrx = offset & IOSF_MBI_MASK_HI;
+
+       spin_lock_irqsave(&iosf_mbi_lock, flags);
+       iosf_mbi_write_mdr(mcrx, mcr, mdr, iosf_mbi_data.addr);
+       spin_unlock_irqrestore(&iosf_mbi_lock, flags);
+}
+EXPORT_SYMBOL(iosf_mbi_write);
+
+void iosf_mbi_modify(u8 port, u8 opcode, u32 offset, u32 mdr, u32 mask)
+{
+       u32 mcr, mcrx;
+       u32 value;
+       unsigned long flags;
+
+       /*Access to the GFX unit is handled by GPU code */
+       BUG_ON(port == IOSF_MBI_UNIT_GFX);
+
+       mcr = iosf_mbi_form_mcr(opcode, port, offset & IOSF_MBI_MASK_LO);
+       mcrx = offset & IOSF_MBI_MASK_HI;
+
+       spin_lock_irqsave(&iosf_mbi_lock, flags);
+
+       /* Read current mdr value */
+       value = iosf_mbi_read_mdr(mcrx, mcr & IOSF_MBI_RD_MASK,
+                                 iosf_mbi_data.addr);
+
+       /* Apply mask */
+       value &= ~mask;
+       mdr &= mask;
+       value |= mdr;
+
+       /* Write back */
+       iosf_mbi_write_mdr(mcrx, mcr | IOSF_MBI_WR_MASK, value,
+                          iosf_mbi_data.addr);
+
+       spin_unlock_irqrestore(&iosf_mbi_lock, flags);
+}
+EXPORT_SYMBOL(iosf_mbi_modify);
+
+static int iosf_mbi_probe(struct platform_device *pdev)
+{
+       struct resource *mem;
+
+       /* Get and map MBI address space */
+       mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+       iosf_mbi_data.addr = devm_ioremap_resource(&pdev->dev, mem);
+       if (IS_ERR(iosf_mbi_data.addr))
+               return PTR_ERR(iosf_mbi_data.addr);
+
+       return 0;
+}
+
+static struct platform_driver iosf_mbi_driver = {
+       .driver         = {
+               .name   = "iosf_mbi",
+               .owner  = THIS_MODULE,
+               .acpi_match_table = ACPI_PTR(iosf_mbi_priv_ids),
+               },
+       .probe          = iosf_mbi_probe,
+};
+
+module_platform_driver(iosf_mbi_driver);
+
+MODULE_AUTHOR("David Box");
+MODULE_DESCRIPTION("IOSF-SB Message Bus Interface accessor");
+MODULE_LICENSE("GPL v2");
-- 
1.7.10.4

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Reply via email to