2014-07-30 18:16:27

by Thor Thayer

[permalink] [raw]
Subject: [PATCHv9 0/3] Addition of Altera EDAC support.

From: Thor Thayer <[email protected]>

The Altera SDRAM controller and EDAC support are added in this
patch series. The SDRAM controller is an MFD so that multiple
drivers can access it's registers.

Thor Thayer (3):
mfd: altera: Add Altera SDRAM Controller
edac: altera: Add Altera EDAC support.
arm: dts: Add Altera SDRAM controller bindings

.../devicetree/bindings/arm/altera/socfpga-sdr.txt | 13 +
MAINTAINERS | 6 +
arch/arm/boot/dts/socfpga.dtsi | 10 +
drivers/edac/Kconfig | 10 +
drivers/edac/Makefile | 2 +
drivers/edac/altera_edac.c | 293 ++++++++++++++++++++
drivers/mfd/Kconfig | 7 +
drivers/mfd/Makefile | 1 +
drivers/mfd/altera-sdr.c | 162 +++++++++++
include/linux/mfd/altera-sdr.h | 102 +++++++
10 files changed, 606 insertions(+)
create mode 100644 Documentation/devicetree/bindings/arm/altera/socfpga-sdr.txt
create mode 100644 drivers/edac/altera_edac.c
create mode 100644 drivers/mfd/altera-sdr.c
create mode 100644 include/linux/mfd/altera-sdr.h

--
1.7.9.5


2014-07-30 18:16:57

by Thor Thayer

[permalink] [raw]
Subject: [PATCHv9 2/3] edac: altera: Add Altera EDAC support.

From: Thor Thayer <[email protected]>

This patch adds support for the CycloneV and ArriaV SDRAM controllers.
Correction and reporting of SBEs, Panic on DBEs.

Signed-off-by: Thor Thayer <[email protected]>
---
v2: Use the SDRAM controller registers to calculate memory size
instead of the Device Tree. Update To & Cc list. Add maintainer
information.

v3: EDAC driver cleanup based on comments from Mailing list.

v4: Panic on DBE. Add macro around inject-error reads to prevent
them from being optimized out. Remove of_match_ptr since this
will always use Device Tree.

v5: Addition of printk to trigger function to ensure read vars
are not optimized out.

v6: Changes to split out shared SDRAM controller reg (offset 0x00)
as a syscon device and allocate ECC specific SDRAM registers
to EDAC.

v7: No changes. Bump for consistency.

v8: Alphabetize headers.

v9: Move Altera EDAC driver to use SDRAM MFD device since controller
registers are shared between different drivers.
---
MAINTAINERS | 1 +
drivers/edac/Kconfig | 10 ++
drivers/edac/Makefile | 2 +
drivers/edac/altera_edac.c | 293 ++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 306 insertions(+)
create mode 100644 drivers/edac/altera_edac.c

diff --git a/MAINTAINERS b/MAINTAINERS
index 48a8923..7fde28b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1344,6 +1344,7 @@ ARM/SOCFPGA SDRAM CONTROLLER SUPPORT
M: Thor Thayer <[email protected]>
S: Maintained
F: drivers/mfd/altera-sdr.c
+F: drivers/edac/altera_edac.c

ARM/STI ARCHITECTURE
M: Srinivas Kandagatla <[email protected]>
diff --git a/drivers/edac/Kconfig b/drivers/edac/Kconfig
index 878f090..429e244 100644
--- a/drivers/edac/Kconfig
+++ b/drivers/edac/Kconfig
@@ -368,4 +368,14 @@ config EDAC_OCTEON_PCI
Support for error detection and correction on the
Cavium Octeon family of SOCs.

+config EDAC_ALTERA_MC
+ bool "Altera SDRAM Memory Controller EDAC"
+ depends on EDAC_MM_EDAC && ARCH_SOCFPGA
+ select MFD_ALTERA_SDR
+ help
+ Support for error detection and correction on the
+ Altera SDRAM memory controller. Note that the
+ preloader must initialize the SDRAM before loading
+ the kernel.
+
endif # EDAC
diff --git a/drivers/edac/Makefile b/drivers/edac/Makefile
index 4154ed6..70845c4 100644
--- a/drivers/edac/Makefile
+++ b/drivers/edac/Makefile
@@ -64,3 +64,5 @@ obj-$(CONFIG_EDAC_OCTEON_PC) += octeon_edac-pc.o
obj-$(CONFIG_EDAC_OCTEON_L2C) += octeon_edac-l2c.o
obj-$(CONFIG_EDAC_OCTEON_LMC) += octeon_edac-lmc.o
obj-$(CONFIG_EDAC_OCTEON_PCI) += octeon_edac-pci.o
+
+obj-$(CONFIG_EDAC_ALTERA_MC) += altera_edac.o
diff --git a/drivers/edac/altera_edac.c b/drivers/edac/altera_edac.c
new file mode 100644
index 0000000..602ae62
--- /dev/null
+++ b/drivers/edac/altera_edac.c
@@ -0,0 +1,293 @@
+/*
+ * Copyright Altera Corporation (C) 2014. All rights reserved.
+ * Copyright 2011-2012 Calxeda, Inc.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Adapted from the highbank_mc_edac driver.
+ */
+
+#include <linux/ctype.h>
+#include <linux/edac.h>
+#include <linux/interrupt.h>
+#include <linux/kernel.h>
+#include <linux/mfd/altera-sdr.h>
+#include <linux/of_platform.h>
+#include <linux/platform_device.h>
+#include <linux/types.h>
+#include <linux/uaccess.h>
+#include "edac_core.h"
+#include "edac_module.h"
+
+#define EDAC_MOD_STR "altera_edac"
+#define EDAC_VERSION "1"
+
+/* Altera SDRAM Memory Controller data */
+struct altr_sdram_mc_data {
+ struct altera_sdr *sdr;
+};
+
+static irqreturn_t altr_sdram_mc_err_handler(int irq, void *dev_id)
+{
+ struct mem_ctl_info *mci = dev_id;
+ struct altr_sdram_mc_data *drvdata = mci->pvt_info;
+ u32 status, err_count, err_addr;
+
+ /* Error Address is shared by both SBE & DBE */
+ err_addr = altera_sdr_readl(drvdata->sdr, SDR_ERRADDR_OFST);
+ status = altera_sdr_readl(drvdata->sdr, SDR_DRAMSTS_OFST);
+
+ if (status & SDR_DRAMSTS_DBEERR) {
+ err_count = altera_sdr_readl(drvdata->sdr, SDR_DBECOUNT_OFST);
+ panic("\nEDAC: [%d Uncorrectable errors @ 0x%08X]\n",
+ err_count, err_addr);
+ }
+ if (status & SDR_DRAMSTS_SBEERR) {
+ err_count = altera_sdr_readl(drvdata->sdr, SDR_SBECOUNT_OFST);
+ edac_mc_handle_error(HW_EVENT_ERR_CORRECTED, mci, err_count,
+ err_addr >> PAGE_SHIFT,
+ err_addr & ~PAGE_MASK, 0,
+ 0, 0, -1, mci->ctl_name, "");
+ }
+
+ altera_sdr_writel(drvdata->sdr,
+ SDR_DRAMINTR_OFST,
+ SDR_DRAMINTR_INTRCLR | SDR_DRAMINTR_INTREN);
+
+ return IRQ_HANDLED;
+}
+
+#ifdef CONFIG_EDAC_DEBUG
+static ssize_t altr_sdr_mc_err_inject_write(struct file *file,
+ const char __user *data,
+ size_t count, loff_t *ppos)
+{
+ struct mem_ctl_info *mci = file->private_data;
+ struct altr_sdram_mc_data *drvdata = mci->pvt_info;
+ u32 *ptemp;
+ dma_addr_t dma_handle;
+ u32 reg, read_reg;
+
+ mci->pdev->coherent_dma_mask = ~0;
+ ptemp = dma_alloc_coherent(mci->pdev, 16, &dma_handle, GFP_KERNEL);
+
+ if (!ptemp) {
+ edac_printk(KERN_ERR, EDAC_MC,
+ "Inject: Buffer Allocation error\n");
+ return -ENOMEM;
+ }
+
+ read_reg = altera_sdr_readl(drvdata->sdr, SDR_CTLCFG_OFST);
+ read_reg &= ~(SDR_CTLCFG_GEN_SB_ERR | SDR_CTLCFG_GEN_DB_ERR);
+
+ /* Error are injected by writing a word while the SBE or DBE
+ * bit in the CTLCFG register is set. Reading the word will
+ * trigger the SBE or DBE error and the corresponding IRQ.
+ */
+ if (count == 3) {
+ edac_printk(KERN_ALERT, EDAC_MC,
+ "Inject Double bit error\n");
+ altera_sdr_writel(drvdata->sdr, SDR_CTLCFG_OFST,
+ (read_reg | SDR_CTLCFG_GEN_DB_ERR));
+ } else {
+ edac_printk(KERN_ALERT, EDAC_MC,
+ "Inject Single bit error\n");
+ altera_sdr_writel(drvdata->sdr, SDR_CTLCFG_OFST,
+ (read_reg | SDR_CTLCFG_GEN_SB_ERR));
+ }
+
+ ptemp[0] = 0x5A5A5A5A;
+ ptemp[1] = 0xA5A5A5A5;
+
+ /* Clear the error injection bits */
+ altera_sdr_writel(drvdata->sdr, SDR_CTLCFG_OFST, read_reg);
+ /* Ensure it has been written out */
+ wmb();
+
+ /*
+ * To trigger the error, we need to read the data back
+ * (the data was written with errors above).
+ * The ACCESS_ONCE macros and printk are used to prevent the
+ * the compiler optimizing these reads out.
+ */
+ reg = ACCESS_ONCE(ptemp[0]);
+ read_reg = ACCESS_ONCE(ptemp[1]);
+ /* Force Read */
+ rmb();
+
+ edac_printk(KERN_ALERT, EDAC_MC, "Read Data [0x%X, 0x%X]\n",
+ reg, read_reg);
+
+ dma_free_coherent(mci->pdev, 16, ptemp, dma_handle);
+
+ return count;
+}
+
+static const struct file_operations altr_sdr_mc_debug_inject_fops = {
+ .open = simple_open,
+ .write = altr_sdr_mc_err_inject_write,
+ .llseek = generic_file_llseek,
+};
+
+static void altr_sdr_mc_create_debugfs_nodes(struct mem_ctl_info *mci)
+{
+ if (mci->debugfs)
+ debugfs_create_file("inject_ctrl", S_IWUSR, mci->debugfs, mci,
+ &altr_sdr_mc_debug_inject_fops);
+}
+#else
+static void altr_sdr_mc_create_debugfs_nodes(struct mem_ctl_info *mci)
+{}
+#endif
+
+static int altr_sdram_probe(struct platform_device *pdev)
+{
+ struct altera_sdr *sdr = dev_get_drvdata(pdev->dev.parent);
+ struct edac_mc_layer layers[2];
+ struct mem_ctl_info *mci;
+ struct altr_sdram_mc_data *drvdata;
+ struct dimm_info *dimm;
+ u32 read_reg, mem_size;
+ int irq;
+ int res = 0;
+
+ /* Validate the SDRAM controller has ECC enabled */
+ read_reg = altera_sdr_readl(sdr, SDR_CTLCFG_OFST);
+ if ((read_reg & SDR_CTLCFG_ECC_AUTO_EN) != SDR_CTLCFG_ECC_AUTO_EN) {
+ edac_printk(KERN_ERR, EDAC_MC,
+ "No ECC/ECC disabled [0x%08X]\n", read_reg);
+ return -ENODEV;
+ }
+
+ /* Grab memory size from device tree. */
+ mem_size = altera_sdr_mem_size(sdr);
+ edac_printk(KERN_DEBUG, EDAC_MC, "Memory Size = 0x%08x\n", mem_size);
+ if (mem_size <= 0) {
+ edac_printk(KERN_ERR, EDAC_MC,
+ "Unable to calculate memory size\n");
+ return -ENODEV;
+ }
+
+ /* Ensure the SDRAM Interrupt is disabled and cleared */
+ altera_sdr_writel(sdr, SDR_DRAMINTR_OFST, SDR_DRAMINTR_INTRCLR);
+
+ irq = platform_get_irq(pdev, 0);
+ if (irq < 0) {
+ edac_printk(KERN_ERR, EDAC_MC,
+ "No irq %d in DT\n", irq);
+ return -ENODEV;
+ }
+
+ layers[0].type = EDAC_MC_LAYER_CHIP_SELECT;
+ layers[0].size = 1;
+ layers[0].is_virt_csrow = true;
+ layers[1].type = EDAC_MC_LAYER_CHANNEL;
+ layers[1].size = 1;
+ layers[1].is_virt_csrow = false;
+ mci = edac_mc_alloc(0, ARRAY_SIZE(layers), layers,
+ sizeof(struct altr_sdram_mc_data));
+ if (!mci)
+ return -ENOMEM;
+
+ mci->pdev = &pdev->dev;
+ drvdata = mci->pvt_info;
+ drvdata->sdr = sdr;
+ platform_set_drvdata(pdev, mci);
+
+ if (!devres_open_group(&pdev->dev, NULL, GFP_KERNEL)) {
+ res = -ENOMEM;
+ goto free;
+ }
+
+ mci->mtype_cap = MEM_FLAG_DDR3;
+ mci->edac_ctl_cap = EDAC_FLAG_NONE | EDAC_FLAG_SECDED;
+ mci->edac_cap = EDAC_FLAG_SECDED;
+ mci->mod_name = EDAC_MOD_STR;
+ mci->mod_ver = EDAC_VERSION;
+ mci->ctl_name = dev_name(&pdev->dev);
+ mci->scrub_mode = SCRUB_SW_SRC;
+ mci->dev_name = dev_name(&pdev->dev);
+
+ dimm = *mci->dimms;
+ dimm->nr_pages = ((mem_size - 1) >> PAGE_SHIFT) + 1;
+ dimm->grain = 8;
+ dimm->dtype = DEV_X8;
+ dimm->mtype = MEM_DDR3;
+ dimm->edac_mode = EDAC_SECDED;
+
+ res = edac_mc_add_mc(mci);
+ if (res < 0)
+ goto err;
+
+ res = devm_request_irq(&pdev->dev, irq, altr_sdram_mc_err_handler,
+ 0, dev_name(&pdev->dev), mci);
+ if (res < 0) {
+ edac_mc_printk(mci, KERN_ERR,
+ "Unable to request irq %d\n", irq);
+ res = -ENODEV;
+ goto err2;
+ }
+
+ altera_sdr_writel(drvdata->sdr,
+ SDR_DRAMINTR_OFST,
+ SDR_DRAMINTR_INTRCLR | SDR_DRAMINTR_INTREN);
+
+ altr_sdr_mc_create_debugfs_nodes(mci);
+
+ devres_close_group(&pdev->dev, NULL);
+
+ return 0;
+
+err2:
+ edac_mc_del_mc(&pdev->dev);
+err:
+ devres_release_group(&pdev->dev, NULL);
+free:
+ edac_mc_free(mci);
+ edac_printk(KERN_ERR, EDAC_MC,
+ "EDAC Probe Failed; Error %d\n", res);
+
+ return res;
+}
+
+static int altr_sdram_remove(struct platform_device *pdev)
+{
+ struct mem_ctl_info *mci = platform_get_drvdata(pdev);
+
+ edac_mc_del_mc(&pdev->dev);
+ edac_mc_free(mci);
+ platform_set_drvdata(pdev, NULL);
+
+ return 0;
+}
+
+static const struct of_device_id altr_sdram_ctrl_of_match[] = {
+ { .compatible = "altr,sdram-edac", },
+ {},
+};
+MODULE_DEVICE_TABLE(of, altr_sdram_ctrl_of_match);
+
+static struct platform_driver altr_sdram_edac_driver = {
+ .probe = altr_sdram_probe,
+ .remove = altr_sdram_remove,
+ .driver = {
+ .name = "altr_sdram_edac",
+ .of_match_table = altr_sdram_ctrl_of_match,
+ },
+};
+
+module_platform_driver(altr_sdram_edac_driver);
+
+MODULE_LICENSE("GPL v2");
+MODULE_AUTHOR("Altera Corporation");
+MODULE_DESCRIPTION("EDAC Driver for Altera SDRAM Controller");
--
1.7.9.5

2014-07-30 18:16:56

by Thor Thayer

[permalink] [raw]
Subject: [PATCHv9 1/3] mfd: altera: Add Altera SDRAM Controller

From: Thor Thayer <[email protected]>

Add a simple MFD for the Altera SDRAM Controller.

Signed-off-by: Alan Tull <[email protected]>
Signed-off-by: Thor Thayer <[email protected]>
---
v1-8: The MFD implementation was not included in the original series.

v9: New MFD implementation.
---
MAINTAINERS | 5 ++
drivers/mfd/Kconfig | 7 ++
drivers/mfd/Makefile | 1 +
drivers/mfd/altera-sdr.c | 162 ++++++++++++++++++++++++++++++++++++++++
include/linux/mfd/altera-sdr.h | 102 +++++++++++++++++++++++++
5 files changed, 277 insertions(+)
create mode 100644 drivers/mfd/altera-sdr.c
create mode 100644 include/linux/mfd/altera-sdr.h

diff --git a/MAINTAINERS b/MAINTAINERS
index 86efa7e..48a8923 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1340,6 +1340,11 @@ M: Dinh Nguyen <[email protected]>
S: Maintained
F: drivers/clk/socfpga/

+ARM/SOCFPGA SDRAM CONTROLLER SUPPORT
+M: Thor Thayer <[email protected]>
+S: Maintained
+F: drivers/mfd/altera-sdr.c
+
ARM/STI ARCHITECTURE
M: Srinivas Kandagatla <[email protected]>
M: Maxime Coquelin <[email protected]>
diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
index 6cc4b6a..8ce4961 100644
--- a/drivers/mfd/Kconfig
+++ b/drivers/mfd/Kconfig
@@ -719,6 +719,13 @@ config MFD_STMPE
Keypad: stmpe-keypad
Touchscreen: stmpe-ts

+config MFD_ALTERA_SDR
+ bool "Altera SDRAM Controller MFD"
+ depends on ARCH_SOCFPGA
+ select MFD_CORE
+ help
+ Support for Altera SDRAM Controller (SDR) MFD.
+
menu "STMicroelectronics STMPE Interface Drivers"
depends on MFD_STMPE

diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
index 8afedba..24cc2b7 100644
--- a/drivers/mfd/Makefile
+++ b/drivers/mfd/Makefile
@@ -169,3 +169,4 @@ obj-$(CONFIG_MFD_AS3711) += as3711.o
obj-$(CONFIG_MFD_AS3722) += as3722.o
obj-$(CONFIG_MFD_STW481X) += stw481x.o
obj-$(CONFIG_MFD_IPAQ_MICRO) += ipaq-micro.o
+obj-$(CONFIG_MFD_ALTERA_SDR) += altera-sdr.o
diff --git a/drivers/mfd/altera-sdr.c b/drivers/mfd/altera-sdr.c
new file mode 100644
index 0000000..b5c6646
--- /dev/null
+++ b/drivers/mfd/altera-sdr.c
@@ -0,0 +1,162 @@
+/*
+ * SDRAM Controller (SDR) MFD
+ *
+ * Copyright (C) 2014 Altera 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.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <linux/io.h>
+#include <linux/kernel.h>
+#include <linux/mfd/altera-sdr.h>
+#include <linux/mfd/core.h>
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/platform_device.h>
+
+static const struct mfd_cell altera_sdr_devs[] = {
+#if defined(CONFIG_EDAC_ALTERA_MC)
+ {
+ .name = "altr_sdram_edac",
+ .of_compatible = "altr,sdram-edac",
+ },
+#endif
+};
+
+u32 altera_sdr_readl(struct altera_sdr *sdr, u32 reg_offset)
+{
+ return readl(sdr->reg_base + reg_offset);
+}
+EXPORT_SYMBOL_GPL(altera_sdr_readl);
+
+void altera_sdr_writel(struct altera_sdr *sdr, u32 reg_offset, u32 value)
+{
+ writel(value, sdr->reg_base + reg_offset);
+}
+EXPORT_SYMBOL_GPL(altera_sdr_writel);
+
+/* Get total memory size in bytes */
+u32 altera_sdr_mem_size(struct altera_sdr *sdr)
+{
+ u32 size;
+ u32 read_reg, row, bank, col, cs, width;
+
+ read_reg = altera_sdr_readl(sdr, SDR_DRAMADDRW_OFST);
+ if (read_reg < 0)
+ return 0;
+
+ width = altera_sdr_readl(sdr, SDR_DRAMIFWIDTH_OFST);
+ if (width < 0)
+ return 0;
+
+ col = (read_reg & SDR_DRAMADDRW_COLBITS_MASK) >>
+ SDR_DRAMADDRW_COLBITS_LSB;
+ row = (read_reg & SDR_DRAMADDRW_ROWBITS_MASK) >>
+ SDR_DRAMADDRW_ROWBITS_LSB;
+ bank = (read_reg & SDR_DRAMADDRW_BANKBITS_MASK) >>
+ SDR_DRAMADDRW_BANKBITS_LSB;
+ cs = (read_reg & SDR_DRAMADDRW_CSBITS_MASK) >>
+ SDR_DRAMADDRW_CSBITS_LSB;
+
+ /* Correct for ECC as its not addressible */
+ if (width == SDR_DRAMIFWIDTH_32B_ECC)
+ width = 32;
+ if (width == SDR_DRAMIFWIDTH_16B_ECC)
+ width = 16;
+
+ /* calculate the SDRAM size base on this info */
+ size = 1 << (row + bank + col);
+ size = size * cs * (width / 8);
+ return size;
+}
+EXPORT_SYMBOL_GPL(altera_sdr_mem_size);
+
+static int altera_sdr_probe(struct platform_device *pdev)
+{
+ struct device *dev = &pdev->dev;
+ struct altera_sdr *sdr;
+ struct resource *res;
+ void __iomem *base;
+ int ret;
+
+ sdr = devm_kzalloc(dev, sizeof(*sdr), GFP_KERNEL);
+ if (!sdr)
+ return -ENOMEM;
+
+ res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+ if (!res)
+ return -ENOENT;
+
+ base = devm_ioremap(dev, res->start, resource_size(res));
+ if (!base)
+ return -ENOMEM;
+
+ sdr->dev = &pdev->dev;
+ sdr->reg_base = base;
+
+ ret = mfd_add_devices(sdr->dev, 0, altera_sdr_devs,
+ ARRAY_SIZE(altera_sdr_devs), NULL, 0, NULL);
+ if (ret)
+ dev_err(sdr->dev, "error adding devices");
+
+ platform_set_drvdata(pdev, sdr);
+
+ dev_dbg(dev, "Altera SDR MFD registered\n");
+
+ return 0;
+}
+
+static int altera_sdr_remove(struct platform_device *pdev)
+{
+ struct altera_sdr *sdr = platform_get_drvdata(pdev);
+
+ mfd_remove_devices(sdr->dev);
+
+ return 0;
+}
+
+static const struct of_device_id of_altera_sdr_match[] = {
+ { .compatible = "altr,sdr", },
+ { },
+};
+
+static const struct platform_device_id altera_sdr_ids[] = {
+ { "altera_sdr", },
+ { }
+};
+
+static struct platform_driver altera_sdr_driver = {
+ .driver = {
+ .name = "altera_sdr",
+ .owner = THIS_MODULE,
+ .of_match_table = of_altera_sdr_match,
+ },
+ .probe = altera_sdr_probe,
+ .remove = altera_sdr_remove,
+ .id_table = altera_sdr_ids,
+};
+
+static int __init altera_sdr_init(void)
+{
+ return platform_driver_register(&altera_sdr_driver);
+}
+postcore_initcall(altera_sdr_init);
+
+static void __exit altera_sdr_exit(void)
+{
+ platform_driver_unregister(&altera_sdr_driver);
+}
+module_exit(altera_sdr_exit);
+
+MODULE_AUTHOR("Alan Tull <[email protected]>");
+MODULE_DESCRIPTION("Altera SDRAM Controller (SDR) MFD");
+MODULE_LICENSE("GPL v2");
diff --git a/include/linux/mfd/altera-sdr.h b/include/linux/mfd/altera-sdr.h
new file mode 100644
index 0000000..a5f5c39
--- /dev/null
+++ b/include/linux/mfd/altera-sdr.h
@@ -0,0 +1,102 @@
+/*
+ * Copyright (C) 2014 Altera 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.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef __LINUX_MFD_ALTERA_SDR_H
+#define __LINUX_MFD_ALTERA_SDR_H
+
+/* SDRAM Controller register offsets */
+#define SDR_CTLCFG_OFST 0x00
+#define SDR_DRAMADDRW_OFST 0x2C
+#define SDR_DRAMIFWIDTH_OFST 0x30
+#define SDR_DRAMSTS_OFST 0x38
+#define SDR_DRAMINTR_OFST 0x3C
+#define SDR_SBECOUNT_OFST 0x40
+#define SDR_DBECOUNT_OFST 0x44
+#define SDR_ERRADDR_OFST 0x48
+#define SDR_DROPCOUNT_OFST 0x4C
+#define SDR_DROPADDR_OFST 0x50
+#define SDR_CTRLGRP_LOWPWREQ_OFST 0x54
+#define SDR_CTRLGRP_LOWPWRACK_OFST 0x58
+
+/* SDRAM Controller CtrlCfg Register Bit Masks */
+#define SDR_CTLCFG_ECC_EN 0x400
+#define SDR_CTLCFG_ECC_CORR_EN 0x800
+#define SDR_CTLCFG_GEN_SB_ERR 0x2000
+#define SDR_CTLCFG_GEN_DB_ERR 0x4000
+
+#define SDR_CTLCFG_ECC_AUTO_EN (SDR_CTLCFG_ECC_EN | \
+ SDR_CTLCFG_ECC_CORR_EN)
+
+/* SDRAM Controller Address Widths Field Register */
+#define SDR_DRAMADDRW_COLBITS_MASK 0x001F
+#define SDR_DRAMADDRW_COLBITS_LSB 0
+#define SDR_DRAMADDRW_ROWBITS_MASK 0x03E0
+#define SDR_DRAMADDRW_ROWBITS_LSB 5
+#define SDR_DRAMADDRW_BANKBITS_MASK 0x1C00
+#define SDR_DRAMADDRW_BANKBITS_LSB 10
+#define SDR_DRAMADDRW_CSBITS_MASK 0xE000
+#define SDR_DRAMADDRW_CSBITS_LSB 13
+
+/* SDRAM Controller Interface Data Width Defines */
+#define SDR_DRAMIFWIDTH_16B_ECC 24
+#define SDR_DRAMIFWIDTH_32B_ECC 40
+
+/* SDRAM Controller DRAM Status Register Bit Masks */
+#define SDR_DRAMSTS_SBEERR 0x04
+#define SDR_DRAMSTS_DBEERR 0x08
+#define SDR_DRAMSTS_CORR_DROP 0x10
+
+/* SDRAM Controller DRAM IRQ Register Bit Masks */
+#define SDR_DRAMINTR_INTREN 0x01
+#define SDR_DRAMINTR_SBEMASK 0x02
+#define SDR_DRAMINTR_DBEMASK 0x04
+#define SDR_DRAMINTR_CORRDROPMASK 0x08
+#define SDR_DRAMINTR_INTRCLR 0x10
+
+/* SDRAM Controller Single Bit Error Count Register Bit Masks */
+#define SDR_SBECOUNT_COUNT_MASK 0x0F
+
+/* SDRAM Controller Double Bit Error Count Register Bit Masks */
+#define SDR_DBECOUNT_COUNT_MASK 0x0F
+
+/* SDRAM Controller ECC Error Address Register Bit Masks */
+#define SDR_ERRADDR_ADDR_MASK 0xFFFFFFFF
+
+/* SDRAM Controller ECC Autocorrect Drop Count Register Bit Masks */
+#define SDR_DROPCOUNT_CORRMASK 0x0F
+
+/* SDRAM Controller ECC AutoCorrect Error Address Register Bit Masks */
+#define SDR_DROPADDR_ADDR_MASK 0xFFFFFFFF
+
+#define SELFRSHREQ_POS 3
+#define SELFRSHREQ_MASK 0x8
+
+#define SELFRFSHMASK_POS 4
+#define SELFRFSHMASK_MASK 0x30
+
+#define SELFRFSHACK_POS 1
+#define SELFRFSHACK_MASK 0x2
+
+struct altera_sdr {
+ struct device *dev;
+ void __iomem *reg_base;
+};
+
+/* Register access API */
+u32 altera_sdr_readl(struct altera_sdr *sdr, u32 reg_offset);
+void altera_sdr_writel(struct altera_sdr *sdr, u32 reg_offset, u32 value);
+u32 altera_sdr_mem_size(struct altera_sdr *sdr);
+
+#endif /* __LINUX_MFD_ALTERA_SDR_H */
--
1.7.9.5

2014-07-30 18:17:34

by Thor Thayer

[permalink] [raw]
Subject: [PATCHv9 3/3] arm: dts: Add Altera SDRAM controller bindings

From: Thor Thayer <[email protected]>

Add the Altera SDRAM controller bindings and device tree changes to the Altera SoC project.

Signed-off-by: Thor Thayer <[email protected]>
---
v2: Changes to SoC SDRAM EDAC code.

v3: Implement code suggestions for SDRAM EDAC code.

v4: Remove syscon from SDRAM controller bindings.

v5: No Change, bump version for consistency.

v6: Only map the ctrlcfg register as syscon.

v7: No change. Bump for consistency.

v8: No change. Bump for consistency.

v9: Changes to support a MFD SDRAM controller with nested EDAC.
---
.../devicetree/bindings/arm/altera/socfpga-sdr.txt | 13 +++++++++++++
arch/arm/boot/dts/socfpga.dtsi | 10 ++++++++++
2 files changed, 23 insertions(+)
create mode 100644 Documentation/devicetree/bindings/arm/altera/socfpga-sdr.txt

diff --git a/Documentation/devicetree/bindings/arm/altera/socfpga-sdr.txt b/Documentation/devicetree/bindings/arm/altera/socfpga-sdr.txt
new file mode 100644
index 0000000..2bb1ddf
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/altera/socfpga-sdr.txt
@@ -0,0 +1,13 @@
+Altera SOCFPGA SDRAM Controller
+The SDRAM controller is implemented as a MFD so various drivers may
+nest under this main SDRAM controller binding.
+
+Required properties:
+- compatible : "altr,sdr";
+- reg : Should contain 1 register range(address and length)
+
+Example:
+ sdr@0xffc25000 {
+ compatible = "altr,sdr";
+ reg = <0xffc25000 0x1000>;
+ };
diff --git a/arch/arm/boot/dts/socfpga.dtsi b/arch/arm/boot/dts/socfpga.dtsi
index 4676f25..ecb306d 100644
--- a/arch/arm/boot/dts/socfpga.dtsi
+++ b/arch/arm/boot/dts/socfpga.dtsi
@@ -603,6 +603,16 @@
};
};

+ sdr@0xffc25000 {
+ compatible = "altr,sdr";
+ reg = <0xffc25000 0x1000>;
+
+ sdramedac@0 {
+ compatible = "altr,sdram-edac";
+ interrupts = <0 39 4>;
+ };
+ };
+
L2: l2-cache@fffef000 {
compatible = "arm,pl310-cache";
reg = <0xfffef000 0x1000>;
--
1.7.9.5

2014-07-31 08:26:50

by Lee Jones

[permalink] [raw]
Subject: Re: [PATCHv9 1/3] mfd: altera: Add Altera SDRAM Controller

On Wed, 30 Jul 2014, [email protected] wrote:

> From: Thor Thayer <[email protected]>
>
> Add a simple MFD for the Altera SDRAM Controller.
>
> Signed-off-by: Alan Tull <[email protected]>
> Signed-off-by: Thor Thayer <[email protected]>
> ---
> v1-8: The MFD implementation was not included in the original series.
>
> v9: New MFD implementation.
> ---
> MAINTAINERS | 5 ++
> drivers/mfd/Kconfig | 7 ++
> drivers/mfd/Makefile | 1 +
> drivers/mfd/altera-sdr.c | 162 ++++++++++++++++++++++++++++++++++++++++
> include/linux/mfd/altera-sdr.h | 102 +++++++++++++++++++++++++
> 5 files changed, 277 insertions(+)
> create mode 100644 drivers/mfd/altera-sdr.c
> create mode 100644 include/linux/mfd/altera-sdr.h
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 86efa7e..48a8923 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1340,6 +1340,11 @@ M: Dinh Nguyen <[email protected]>
> S: Maintained
> F: drivers/clk/socfpga/
>
> +ARM/SOCFPGA SDRAM CONTROLLER SUPPORT
> +M: Thor Thayer <[email protected]>
> +S: Maintained
> +F: drivers/mfd/altera-sdr.c
> +
> ARM/STI ARCHITECTURE
> M: Srinivas Kandagatla <[email protected]>
> M: Maxime Coquelin <[email protected]>

This should be in a separate patch.

> diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
> index 6cc4b6a..8ce4961 100644
> --- a/drivers/mfd/Kconfig
> +++ b/drivers/mfd/Kconfig
> @@ -719,6 +719,13 @@ config MFD_STMPE
> Keypad: stmpe-keypad
> Touchscreen: stmpe-ts
>
> +config MFD_ALTERA_SDR
> + bool "Altera SDRAM Controller MFD"
> + depends on ARCH_SOCFPGA
> + select MFD_CORE
> + help
> + Support for Altera SDRAM Controller (SDR) MFD.
> +
> menu "STMicroelectronics STMPE Interface Drivers"
> depends on MFD_STMPE
>
> diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
> index 8afedba..24cc2b7 100644
> --- a/drivers/mfd/Makefile
> +++ b/drivers/mfd/Makefile
> @@ -169,3 +169,4 @@ obj-$(CONFIG_MFD_AS3711) += as3711.o
> obj-$(CONFIG_MFD_AS3722) += as3722.o
> obj-$(CONFIG_MFD_STW481X) += stw481x.o
> obj-$(CONFIG_MFD_IPAQ_MICRO) += ipaq-micro.o
> +obj-$(CONFIG_MFD_ALTERA_SDR) += altera-sdr.o
> diff --git a/drivers/mfd/altera-sdr.c b/drivers/mfd/altera-sdr.c
> new file mode 100644
> index 0000000..b5c6646
> --- /dev/null
> +++ b/drivers/mfd/altera-sdr.c
> @@ -0,0 +1,162 @@
> +/*
> + * SDRAM Controller (SDR) MFD
> + *
> + * Copyright (C) 2014 Altera 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.
> + *
> + * You should have received a copy of the GNU General Public License along with
> + * this program. If not, see <http://www.gnu.org/licenses/>.

Can you use the shorter version of the licence?

> + */

'\n' here.

> +#include <linux/io.h>
> +#include <linux/kernel.h>
> +#include <linux/mfd/altera-sdr.h>
> +#include <linux/mfd/core.h>
> +#include <linux/module.h>
> +#include <linux/of.h>
> +#include <linux/platform_device.h>
> +
> +static const struct mfd_cell altera_sdr_devs[] = {
> +#if defined(CONFIG_EDAC_ALTERA_MC)

No need to do this, as it will only be matched if the driver is
enabled. Please remove the #iffery.

> + {
> + .name = "altr_sdram_edac",
> + .of_compatible = "altr,sdram-edac",

What other devices will there be?

> + },
> +#endif
> +};
> +
> +u32 altera_sdr_readl(struct altera_sdr *sdr, u32 reg_offset)
> +{
> + return readl(sdr->reg_base + reg_offset);
> +}
> +EXPORT_SYMBOL_GPL(altera_sdr_readl);
> +
> +void altera_sdr_writel(struct altera_sdr *sdr, u32 reg_offset, u32 value)
> +{
> + writel(value, sdr->reg_base + reg_offset);
> +}
> +EXPORT_SYMBOL_GPL(altera_sdr_writel);

Why are you abstracting these?

Might be better to use Regmap even.

> +/* Get total memory size in bytes */
> +u32 altera_sdr_mem_size(struct altera_sdr *sdr)
> +{
> + u32 size;
> + u32 read_reg, row, bank, col, cs, width;

Weird that size is on its own. Either place on a single line or
separate them all.

> + read_reg = altera_sdr_readl(sdr, SDR_DRAMADDRW_OFST);
> + if (read_reg < 0)
> + return 0;
> +
> + width = altera_sdr_readl(sdr, SDR_DRAMIFWIDTH_OFST);
> + if (width < 0)
> + return 0;
> +
> + col = (read_reg & SDR_DRAMADDRW_COLBITS_MASK) >>
> + SDR_DRAMADDRW_COLBITS_LSB;
> + row = (read_reg & SDR_DRAMADDRW_ROWBITS_MASK) >>
> + SDR_DRAMADDRW_ROWBITS_LSB;
> + bank = (read_reg & SDR_DRAMADDRW_BANKBITS_MASK) >>
> + SDR_DRAMADDRW_BANKBITS_LSB;
> + cs = (read_reg & SDR_DRAMADDRW_CSBITS_MASK) >>
> + SDR_DRAMADDRW_CSBITS_LSB;

These would probably be better as macros.

> + /* Correct for ECC as its not addressible */
> + if (width == SDR_DRAMIFWIDTH_32B_ECC)
> + width = 32;
> + if (width == SDR_DRAMIFWIDTH_16B_ECC)
> + width = 16;
> +
> + /* calculate the SDRAM size base on this info */
> + size = 1 << (row + bank + col);
> + size = size * cs * (width / 8);
> + return size;
> +}
> +EXPORT_SYMBOL_GPL(altera_sdr_mem_size);

Should this really be done in here? Isn't this an SDRAM function?

> +static int altera_sdr_probe(struct platform_device *pdev)
> +{
> + struct device *dev = &pdev->dev;
> + struct altera_sdr *sdr;
> + struct resource *res;
> + void __iomem *base;
> + int ret;
> +
> + sdr = devm_kzalloc(dev, sizeof(*sdr), GFP_KERNEL);
> + if (!sdr)
> + return -ENOMEM;
> +
> + res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> + if (!res)
> + return -ENOENT;
> +
> + base = devm_ioremap(dev, res->start, resource_size(res));

Instead use devm_ioremap_resource(), then you can omit the error
checking of platform_get_resource().

> + if (!base)
> + return -ENOMEM;
> +
> + sdr->dev = &pdev->dev;

Either use 'dev' here, or remove the top line in this function and use
&pdev->dev everywhere. I personally prefer the latter.

> + sdr->reg_base = base;
> +
> + ret = mfd_add_devices(sdr->dev, 0, altera_sdr_devs,
> + ARRAY_SIZE(altera_sdr_devs), NULL, 0, NULL);
> + if (ret)
> + dev_err(sdr->dev, "error adding devices");
> +
> + platform_set_drvdata(pdev, sdr);
> +
> + dev_dbg(dev, "Altera SDR MFD registered\n");
> +
> + return 0;
> +}
> +
> +static int altera_sdr_remove(struct platform_device *pdev)
> +{
> + struct altera_sdr *sdr = platform_get_drvdata(pdev);

No need for this, just use &pdev->dev.

> + mfd_remove_devices(sdr->dev);
> +
> + return 0;
> +}
> +
> +static const struct of_device_id of_altera_sdr_match[] = {
> + { .compatible = "altr,sdr", },
> + { },
> +};
> +
> +static const struct platform_device_id altera_sdr_ids[] = {
> + { "altera_sdr", },
> + { }
> +};

What's this for?

> +static struct platform_driver altera_sdr_driver = {
> + .driver = {
> + .name = "altera_sdr",
> + .owner = THIS_MODULE,

You can remove this line, it's taken care of for you.

> + .of_match_table = of_altera_sdr_match,
> + },
> + .probe = altera_sdr_probe,
> + .remove = altera_sdr_remove,
> + .id_table = altera_sdr_ids,
> +};
> +
> +static int __init altera_sdr_init(void)
> +{
> + return platform_driver_register(&altera_sdr_driver);
> +}
> +postcore_initcall(altera_sdr_init);

Why was this chosen?

> +static void __exit altera_sdr_exit(void)
> +{
> + platform_driver_unregister(&altera_sdr_driver);
> +}
> +module_exit(altera_sdr_exit);
> +
> +MODULE_AUTHOR("Alan Tull <[email protected]>");
> +MODULE_DESCRIPTION("Altera SDRAM Controller (SDR) MFD");
> +MODULE_LICENSE("GPL v2");
> diff --git a/include/linux/mfd/altera-sdr.h b/include/linux/mfd/altera-sdr.h
> new file mode 100644
> index 0000000..a5f5c39
> --- /dev/null
> +++ b/include/linux/mfd/altera-sdr.h
> @@ -0,0 +1,102 @@
> +/*
> + * Copyright (C) 2014 Altera 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.
> + *
> + * You should have received a copy of the GNU General Public License along with
> + * this program. If not, see <http://www.gnu.org/licenses/>.

Use the short version.

> + */

'\n' here.

> +#ifndef __LINUX_MFD_ALTERA_SDR_H
> +#define __LINUX_MFD_ALTERA_SDR_H
> +
> +/* SDRAM Controller register offsets */
> +#define SDR_CTLCFG_OFST 0x00
> +#define SDR_DRAMADDRW_OFST 0x2C
> +#define SDR_DRAMIFWIDTH_OFST 0x30
> +#define SDR_DRAMSTS_OFST 0x38
> +#define SDR_DRAMINTR_OFST 0x3C
> +#define SDR_SBECOUNT_OFST 0x40
> +#define SDR_DBECOUNT_OFST 0x44
> +#define SDR_ERRADDR_OFST 0x48
> +#define SDR_DROPCOUNT_OFST 0x4C
> +#define SDR_DROPADDR_OFST 0x50
> +#define SDR_CTRLGRP_LOWPWREQ_OFST 0x54
> +#define SDR_CTRLGRP_LOWPWRACK_OFST 0x58
> +
> +/* SDRAM Controller CtrlCfg Register Bit Masks */
> +#define SDR_CTLCFG_ECC_EN 0x400
> +#define SDR_CTLCFG_ECC_CORR_EN 0x800
> +#define SDR_CTLCFG_GEN_SB_ERR 0x2000
> +#define SDR_CTLCFG_GEN_DB_ERR 0x4000
> +
> +#define SDR_CTLCFG_ECC_AUTO_EN (SDR_CTLCFG_ECC_EN | \
> + SDR_CTLCFG_ECC_CORR_EN)
> +
> +/* SDRAM Controller Address Widths Field Register */
> +#define SDR_DRAMADDRW_COLBITS_MASK 0x001F
> +#define SDR_DRAMADDRW_COLBITS_LSB 0
> +#define SDR_DRAMADDRW_ROWBITS_MASK 0x03E0
> +#define SDR_DRAMADDRW_ROWBITS_LSB 5
> +#define SDR_DRAMADDRW_BANKBITS_MASK 0x1C00
> +#define SDR_DRAMADDRW_BANKBITS_LSB 10
> +#define SDR_DRAMADDRW_CSBITS_MASK 0xE000
> +#define SDR_DRAMADDRW_CSBITS_LSB 13

We normally call _LSB, _SHIFT.

> +/* SDRAM Controller Interface Data Width Defines */
> +#define SDR_DRAMIFWIDTH_16B_ECC 24
> +#define SDR_DRAMIFWIDTH_32B_ECC 40
> +
> +/* SDRAM Controller DRAM Status Register Bit Masks */
> +#define SDR_DRAMSTS_SBEERR 0x04
> +#define SDR_DRAMSTS_DBEERR 0x08
> +#define SDR_DRAMSTS_CORR_DROP 0x10
> +
> +/* SDRAM Controller DRAM IRQ Register Bit Masks */
> +#define SDR_DRAMINTR_INTREN 0x01
> +#define SDR_DRAMINTR_SBEMASK 0x02
> +#define SDR_DRAMINTR_DBEMASK 0x04
> +#define SDR_DRAMINTR_CORRDROPMASK 0x08
> +#define SDR_DRAMINTR_INTRCLR 0x10
> +
> +/* SDRAM Controller Single Bit Error Count Register Bit Masks */
> +#define SDR_SBECOUNT_COUNT_MASK 0x0F
> +
> +/* SDRAM Controller Double Bit Error Count Register Bit Masks */
> +#define SDR_DBECOUNT_COUNT_MASK 0x0F
> +
> +/* SDRAM Controller ECC Error Address Register Bit Masks */
> +#define SDR_ERRADDR_ADDR_MASK 0xFFFFFFFF
> +
> +/* SDRAM Controller ECC Autocorrect Drop Count Register Bit Masks */
> +#define SDR_DROPCOUNT_CORRMASK 0x0F
> +
> +/* SDRAM Controller ECC AutoCorrect Error Address Register Bit Masks */
> +#define SDR_DROPADDR_ADDR_MASK 0xFFFFFFFF
> +
> +#define SELFRSHREQ_POS 3
> +#define SELFRSHREQ_MASK 0x8
> +
> +#define SELFRFSHMASK_POS 4
> +#define SELFRFSHMASK_MASK 0x30
> +
> +#define SELFRFSHACK_POS 1
> +#define SELFRFSHACK_MASK 0x2
> +
> +struct altera_sdr {
> + struct device *dev;
> + void __iomem *reg_base;
> +};
> +
> +/* Register access API */
> +u32 altera_sdr_readl(struct altera_sdr *sdr, u32 reg_offset);
> +void altera_sdr_writel(struct altera_sdr *sdr, u32 reg_offset, u32 value);

Regmap?

> +u32 altera_sdr_mem_size(struct altera_sdr *sdr);
> +
> +#endif /* __LINUX_MFD_ALTERA_SDR_H */

--
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog

2014-07-31 19:54:05

by Thor Thayer

[permalink] [raw]
Subject: Re: [PATCHv9 1/3] mfd: altera: Add Altera SDRAM Controller


On 07/31/2014 03:26 AM, Lee Jones wrote:
> On Wed, 30 Jul 2014, [email protected] wrote:
>
>> From: Thor Thayer <[email protected]>
>>
>> Add a simple MFD for the Altera SDRAM Controller.
>>
>> Signed-off-by: Alan Tull <[email protected]>
>> Signed-off-by: Thor Thayer <[email protected]>
>> ---
>> v1-8: The MFD implementation was not included in the original series.
>>
>> v9: New MFD implementation.
>> ---
>> MAINTAINERS | 5 ++
>> drivers/mfd/Kconfig | 7 ++
>> drivers/mfd/Makefile | 1 +
>> drivers/mfd/altera-sdr.c | 162 ++++++++++++++++++++++++++++++++++++++++
>> include/linux/mfd/altera-sdr.h | 102 +++++++++++++++++++++++++
>> 5 files changed, 277 insertions(+)
>> create mode 100644 drivers/mfd/altera-sdr.c
>> create mode 100644 include/linux/mfd/altera-sdr.h
>>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 86efa7e..48a8923 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -1340,6 +1340,11 @@ M: Dinh Nguyen <[email protected]>
>> S: Maintained
>> F: drivers/clk/socfpga/
>>
>> +ARM/SOCFPGA SDRAM CONTROLLER SUPPORT
>> +M: Thor Thayer <[email protected]>
>> +S: Maintained
>> +F: drivers/mfd/altera-sdr.c
>> +
>> ARM/STI ARCHITECTURE
>> M: Srinivas Kandagatla <[email protected]>
>> M: Maxime Coquelin <[email protected]>
> This should be in a separate patch.
OK. Thanks for your comments and for reviewing. I will move this into a
separate patch.
>> diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
>> index 6cc4b6a..8ce4961 100644
>> --- a/drivers/mfd/Kconfig
>> +++ b/drivers/mfd/Kconfig
>> @@ -719,6 +719,13 @@ config MFD_STMPE
>> Keypad: stmpe-keypad
>> Touchscreen: stmpe-ts
>>
>> +config MFD_ALTERA_SDR
>> + bool "Altera SDRAM Controller MFD"
>> + depends on ARCH_SOCFPGA
>> + select MFD_CORE
>> + help
>> + Support for Altera SDRAM Controller (SDR) MFD.
>> +
>> menu "STMicroelectronics STMPE Interface Drivers"
>> depends on MFD_STMPE
>>
>> diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
>> index 8afedba..24cc2b7 100644
>> --- a/drivers/mfd/Makefile
>> +++ b/drivers/mfd/Makefile
>> @@ -169,3 +169,4 @@ obj-$(CONFIG_MFD_AS3711) += as3711.o
>> obj-$(CONFIG_MFD_AS3722) += as3722.o
>> obj-$(CONFIG_MFD_STW481X) += stw481x.o
>> obj-$(CONFIG_MFD_IPAQ_MICRO) += ipaq-micro.o
>> +obj-$(CONFIG_MFD_ALTERA_SDR) += altera-sdr.o
>> diff --git a/drivers/mfd/altera-sdr.c b/drivers/mfd/altera-sdr.c
>> new file mode 100644
>> index 0000000..b5c6646
>> --- /dev/null
>> +++ b/drivers/mfd/altera-sdr.c
>> @@ -0,0 +1,162 @@
>> +/*
>> + * SDRAM Controller (SDR) MFD
>> + *
>> + * Copyright (C) 2014 Altera 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.
>> + *
>> + * You should have received a copy of the GNU General Public License along with
>> + * this program. If not, see <http://www.gnu.org/licenses/>.
> Can you use the shorter version of the licence?
Hi. This seems to be the shorter version of the license agreement and is
fairly common in the kernel, right?
>> + */
> '\n' here.
OK.
>> +#include <linux/io.h>
>> +#include <linux/kernel.h>
>> +#include <linux/mfd/altera-sdr.h>
>> +#include <linux/mfd/core.h>
>> +#include <linux/module.h>
>> +#include <linux/of.h>
>> +#include <linux/platform_device.h>
>> +
>> +static const struct mfd_cell altera_sdr_devs[] = {
>> +#if defined(CONFIG_EDAC_ALTERA_MC)
> No need to do this, as it will only be matched if the driver is
> enabled. Please remove the #iffery.
OK. Will remove.
>> + {
>> + .name = "altr_sdram_edac",
>> + .of_compatible = "altr,sdram-edac",
> What other devices will there be?
>
There will be an FPGA bridge and a power control driver that will need
access to the SDR Controller registers.
>> + },
>> +#endif
>> +};
>> +
>> +u32 altera_sdr_readl(struct altera_sdr *sdr, u32 reg_offset)
>> +{
>> + return readl(sdr->reg_base + reg_offset);
>> +}
>> +EXPORT_SYMBOL_GPL(altera_sdr_readl);
>> +
>> +void altera_sdr_writel(struct altera_sdr *sdr, u32 reg_offset, u32 value)
>> +{
>> + writel(value, sdr->reg_base + reg_offset);
>> +}
>> +EXPORT_SYMBOL_GPL(altera_sdr_writel);
> Why are you abstracting these?
>
> Might be better to use Regmap even.
regmap seems unnecessarily complex for what we're doing which is why
this method was chosen.

Future drivers will access different sets of registers in the device.
These drivers won't share bitfields in the same register so the MFD
seemed like the best solution. Originally we implemented this using
syscon but that seems to be frowned upon so we changed to using a MFD.
>> +/* Get total memory size in bytes */
>> +u32 altera_sdr_mem_size(struct altera_sdr *sdr)
>> +{
>> + u32 size;
>> + u32 read_reg, row, bank, col, cs, width;
> Weird that size is on its own. Either place on a single line or
> separate them all.
OK. I will change this.
>> + read_reg = altera_sdr_readl(sdr, SDR_DRAMADDRW_OFST);
>> + if (read_reg < 0)
>> + return 0;
>> +
>> + width = altera_sdr_readl(sdr, SDR_DRAMIFWIDTH_OFST);
>> + if (width < 0)
>> + return 0;
>> +
>> + col = (read_reg & SDR_DRAMADDRW_COLBITS_MASK) >>
>> + SDR_DRAMADDRW_COLBITS_LSB;
>> + row = (read_reg & SDR_DRAMADDRW_ROWBITS_MASK) >>
>> + SDR_DRAMADDRW_ROWBITS_LSB;
>> + bank = (read_reg & SDR_DRAMADDRW_BANKBITS_MASK) >>
>> + SDR_DRAMADDRW_BANKBITS_LSB;
>> + cs = (read_reg & SDR_DRAMADDRW_CSBITS_MASK) >>
>> + SDR_DRAMADDRW_CSBITS_LSB;
> These would probably be better as macros.
>
OK. I will fix this.
>> + /* Correct for ECC as its not addressible */
>> + if (width == SDR_DRAMIFWIDTH_32B_ECC)
>> + width = 32;
>> + if (width == SDR_DRAMIFWIDTH_16B_ECC)
>> + width = 16;
>> +
>> + /* calculate the SDRAM size base on this info */
>> + size = 1 << (row + bank + col);
>> + size = size * cs * (width / 8);
>> + return size;
>> +}
>> +EXPORT_SYMBOL_GPL(altera_sdr_mem_size);
> Should this really be done in here? Isn't this an SDRAM function?
>
This register is part of the SDRAM controller and size information may
be required by the other drivers that share this memory area/need SDRAM
information.

>> +static int altera_sdr_probe(struct platform_device *pdev)
>> +{
>> + struct device *dev = &pdev->dev;
>> + struct altera_sdr *sdr;
>> + struct resource *res;
>> + void __iomem *base;
>> + int ret;
>> +
>> + sdr = devm_kzalloc(dev, sizeof(*sdr), GFP_KERNEL);
>> + if (!sdr)
>> + return -ENOMEM;
>> +
>> + res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
>> + if (!res)
>> + return -ENOENT;
>> +
>> + base = devm_ioremap(dev, res->start, resource_size(res));
> Instead use devm_ioremap_resource(), then you can omit the error
> checking of platform_get_resource().
OK. Thanks. I will make the change.
>> + if (!base)
>> + return -ENOMEM;
>> +
>> + sdr->dev = &pdev->dev;
> Either use 'dev' here, or remove the top line in this function and use
> &pdev->dev everywhere. I personally prefer the latter.
OK. I will use the latter.
>> + sdr->reg_base = base;
>> +
>> + ret = mfd_add_devices(sdr->dev, 0, altera_sdr_devs,
>> + ARRAY_SIZE(altera_sdr_devs), NULL, 0, NULL);
>> + if (ret)
>> + dev_err(sdr->dev, "error adding devices");
>> +
>> + platform_set_drvdata(pdev, sdr);
>> +
>> + dev_dbg(dev, "Altera SDR MFD registered\n");
>> +
>> + return 0;
>> +}
>> +
>> +static int altera_sdr_remove(struct platform_device *pdev)
>> +{
>> + struct altera_sdr *sdr = platform_get_drvdata(pdev);
> No need for this, just use &pdev->dev.
OK. I will make the change.
>> + mfd_remove_devices(sdr->dev);
>> +
>> + return 0;
>> +}
>> +
>> +static const struct of_device_id of_altera_sdr_match[] = {
>> + { .compatible = "altr,sdr", },
>> + { },
>> +};
>> +
>> +static const struct platform_device_id altera_sdr_ids[] = {
>> + { "altera_sdr", },
>> + { }
>> +};
> What's this for?
We don't strictly need it because we are driven by the device tree. It
can be removed it if is a problem but I'm not clear why it is a problem.
>> +static struct platform_driver altera_sdr_driver = {
>> + .driver = {
>> + .name = "altera_sdr",
>> + .owner = THIS_MODULE,
> You can remove this line, it's taken care of for you.
I will remove the .owner line.
>> + .of_match_table = of_altera_sdr_match,
>> + },
>> + .probe = altera_sdr_probe,
>> + .remove = altera_sdr_remove,
>> + .id_table = altera_sdr_ids,
>> +};
>> +
>> +static int __init altera_sdr_init(void)
>> +{
>> + return platform_driver_register(&altera_sdr_driver);
>> +}
>> +postcore_initcall(altera_sdr_init);
> Why was this chosen?
We want this to happen pretty early.
>> +static void __exit altera_sdr_exit(void)
>> +{
>> + platform_driver_unregister(&altera_sdr_driver);
>> +}
>> +module_exit(altera_sdr_exit);
>> +
>> +MODULE_AUTHOR("Alan Tull <[email protected]>");
>> +MODULE_DESCRIPTION("Altera SDRAM Controller (SDR) MFD");
>> +MODULE_LICENSE("GPL v2");
>> diff --git a/include/linux/mfd/altera-sdr.h b/include/linux/mfd/altera-sdr.h
>> new file mode 100644
>> index 0000000..a5f5c39
>> --- /dev/null
>> +++ b/include/linux/mfd/altera-sdr.h
>> @@ -0,0 +1,102 @@
>> +/*
>> + * Copyright (C) 2014 Altera 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.
>> + *
>> + * You should have received a copy of the GNU General Public License along with
>> + * this program. If not, see <http://www.gnu.org/licenses/>.
> Use the short version.
Same as above. This is the shorter version that we've been using at Altera.
>> + */
> '\n' here.
OK.
>> +#ifndef __LINUX_MFD_ALTERA_SDR_H
>> +#define __LINUX_MFD_ALTERA_SDR_H
>> +
>> +/* SDRAM Controller register offsets */
>> +#define SDR_CTLCFG_OFST 0x00
>> +#define SDR_DRAMADDRW_OFST 0x2C
>> +#define SDR_DRAMIFWIDTH_OFST 0x30
>> +#define SDR_DRAMSTS_OFST 0x38
>> +#define SDR_DRAMINTR_OFST 0x3C
>> +#define SDR_SBECOUNT_OFST 0x40
>> +#define SDR_DBECOUNT_OFST 0x44
>> +#define SDR_ERRADDR_OFST 0x48
>> +#define SDR_DROPCOUNT_OFST 0x4C
>> +#define SDR_DROPADDR_OFST 0x50
>> +#define SDR_CTRLGRP_LOWPWREQ_OFST 0x54
>> +#define SDR_CTRLGRP_LOWPWRACK_OFST 0x58
>> +
>> +/* SDRAM Controller CtrlCfg Register Bit Masks */
>> +#define SDR_CTLCFG_ECC_EN 0x400
>> +#define SDR_CTLCFG_ECC_CORR_EN 0x800
>> +#define SDR_CTLCFG_GEN_SB_ERR 0x2000
>> +#define SDR_CTLCFG_GEN_DB_ERR 0x4000
>> +
>> +#define SDR_CTLCFG_ECC_AUTO_EN (SDR_CTLCFG_ECC_EN | \
>> + SDR_CTLCFG_ECC_CORR_EN)
>> +
>> +/* SDRAM Controller Address Widths Field Register */
>> +#define SDR_DRAMADDRW_COLBITS_MASK 0x001F
>> +#define SDR_DRAMADDRW_COLBITS_LSB 0
>> +#define SDR_DRAMADDRW_ROWBITS_MASK 0x03E0
>> +#define SDR_DRAMADDRW_ROWBITS_LSB 5
>> +#define SDR_DRAMADDRW_BANKBITS_MASK 0x1C00
>> +#define SDR_DRAMADDRW_BANKBITS_LSB 10
>> +#define SDR_DRAMADDRW_CSBITS_MASK 0xE000
>> +#define SDR_DRAMADDRW_CSBITS_LSB 13
> We normally call _LSB, _SHIFT.
OK. I will change.
>> +/* SDRAM Controller Interface Data Width Defines */
>> +#define SDR_DRAMIFWIDTH_16B_ECC 24
>> +#define SDR_DRAMIFWIDTH_32B_ECC 40
>> +
>> +/* SDRAM Controller DRAM Status Register Bit Masks */
>> +#define SDR_DRAMSTS_SBEERR 0x04
>> +#define SDR_DRAMSTS_DBEERR 0x08
>> +#define SDR_DRAMSTS_CORR_DROP 0x10
>> +
>> +/* SDRAM Controller DRAM IRQ Register Bit Masks */
>> +#define SDR_DRAMINTR_INTREN 0x01
>> +#define SDR_DRAMINTR_SBEMASK 0x02
>> +#define SDR_DRAMINTR_DBEMASK 0x04
>> +#define SDR_DRAMINTR_CORRDROPMASK 0x08
>> +#define SDR_DRAMINTR_INTRCLR 0x10
>> +
>> +/* SDRAM Controller Single Bit Error Count Register Bit Masks */
>> +#define SDR_SBECOUNT_COUNT_MASK 0x0F
>> +
>> +/* SDRAM Controller Double Bit Error Count Register Bit Masks */
>> +#define SDR_DBECOUNT_COUNT_MASK 0x0F
>> +
>> +/* SDRAM Controller ECC Error Address Register Bit Masks */
>> +#define SDR_ERRADDR_ADDR_MASK 0xFFFFFFFF
>> +
>> +/* SDRAM Controller ECC Autocorrect Drop Count Register Bit Masks */
>> +#define SDR_DROPCOUNT_CORRMASK 0x0F
>> +
>> +/* SDRAM Controller ECC AutoCorrect Error Address Register Bit Masks */
>> +#define SDR_DROPADDR_ADDR_MASK 0xFFFFFFFF
>> +
>> +#define SELFRSHREQ_POS 3
>> +#define SELFRSHREQ_MASK 0x8
>> +
>> +#define SELFRFSHMASK_POS 4
>> +#define SELFRFSHMASK_MASK 0x30
>> +
>> +#define SELFRFSHACK_POS 1
>> +#define SELFRFSHACK_MASK 0x2
>> +
>> +struct altera_sdr {
>> + struct device *dev;
>> + void __iomem *reg_base;
>> +};
>> +
>> +/* Register access API */
>> +u32 altera_sdr_readl(struct altera_sdr *sdr, u32 reg_offset);
>> +void altera_sdr_writel(struct altera_sdr *sdr, u32 reg_offset, u32 value);
> Regmap?
Same as above. This seems to be more complex than we need.


Thanks for your comments and for reviewing!

Thor
>> +u32 altera_sdr_mem_size(struct altera_sdr *sdr);
>> +
>> +#endif /* __LINUX_MFD_ALTERA_SDR_H */