From: Thor Thayer <ttha...@altera.com>

Added EDAC support for reporting ECC errors of CycloneV
and ArriaV SDRAM controller.
- The SDRAM Controller registers are used by the FPGA bridge so
  these are accessed through the syscon interface.
- The configuration of the SDRAM memory size for the EDAC framework
  is discovered from the SDRAM Controller registers.
- Documentation of the bindings in devicetree/bindings/arm/altera/
  socfpga-sdram-edac.txt
- Correction of single bit errors, detection of double bit errors.

---
v2: Use the SDRAM controller registers to calculate memory size
    instead of the Device Tree. Update To & Cc list. Add maintainer 
    information.

Signed-off-by: Thor Thayer <ttha...@altera.com>
To: Rob Herring <robherri...@gmail.com>
To: Doug Thompson <dougthomp...@xmission.com>
To: Grant Likely <grant.lik...@linaro.org>
To: Pawel Moll <pawel.m...@arm.com>
To: Mark Rutland <mark.rutl...@arm.com>
To: Ian Campbell <ijc+devicet...@hellion.org.uk>
To: Kumar Gala <ga...@codeaurora.org>
To: Rob Landley <r...@landley.net>
To: Russell King <li...@arm.linux.org.uk>
To: Dinh Nguyen <dingu...@altera.com>
Cc: Borislav Petkov <b...@alien8.de>
Cc: devicet...@vger.kernel.org
Cc: linux-e...@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
---
 MAINTAINERS                   |    5 +
 drivers/edac/Kconfig          |    9 +
 drivers/edac/Makefile         |    2 +
 drivers/edac/altera_mc_edac.c |  393 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 409 insertions(+)
 create mode 100644 drivers/edac/altera_mc_edac.c

diff --git a/MAINTAINERS b/MAINTAINERS
index b8af16d..aee0746 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1249,6 +1249,11 @@ M:       Dinh Nguyen <dingu...@altera.com>
 S:     Maintained
 F:     drivers/clk/socfpga/
 
+ARM/SOCFPGA SDRAM EDAC SUPPORT
+M:     Thor Thayer <ttha...@altera.com>
+S:     Maintained
+F:     drivers/edac/altera_mc_edac.c
+
 ARM/STI ARCHITECTURE
 M:     Srinivas Kandagatla <srinivas.kandaga...@st.com>
 M:     Stuart Menefy <stuart.men...@st.com>
diff --git a/drivers/edac/Kconfig b/drivers/edac/Kconfig
index 878f090..4f4d379 100644
--- a/drivers/edac/Kconfig
+++ b/drivers/edac/Kconfig
@@ -368,4 +368,13 @@ 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
+       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..e15d05f 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_mc_edac.o
diff --git a/drivers/edac/altera_mc_edac.c b/drivers/edac/altera_mc_edac.c
new file mode 100644
index 0000000..811b712
--- /dev/null
+++ b/drivers/edac/altera_mc_edac.c
@@ -0,0 +1,393 @@
+/*
+ *  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/types.h>
+#include <linux/kernel.h>
+#include <linux/ctype.h>
+#include <linux/edac.h>
+#include <linux/interrupt.h>
+#include <linux/platform_device.h>
+#include <linux/of_platform.h>
+#include <linux/uaccess.h>
+#include <linux/mfd/syscon.h>
+#include <linux/regmap.h>
+
+#include "edac_core.h"
+#include "edac_module.h"
+
+#define ALTR_EDAC_MOD_STR      "altera_edac"
+
+/* SDRAM Controller CtrlCfg Register */
+#define ALTR_SDR_CTLCFG                        0x00
+
+/* SDRAM Controller CtrlCfg Register Bit Masks */
+#define ALTR_SDR_CTLCFG_ECC_EN         0x400
+#define ALTR_SDR_CTLCFG_ECC_CORR_EN    0x800
+#define ALTR_SDR_CTLCFG_GEN_SB_ERR     0x2000
+#define ALTR_SDR_CTLCFG_GEN_DB_ERR     0x4000
+
+#define ALTR_SDR_CTLCFG_ECC_AUTO_EN    (ALTR_SDR_CTLCFG_ECC_EN | \
+                                       ALTR_SDR_CTLCFG_ECC_CORR_EN)
+
+/* SDRAM Controller Address Width Register */
+#define ALTR_SDR_DRAMADDRW             0x2C
+
+/* SDRAM Controller Address Widths Field Register */
+#define ALTR_SDR_DRAMADDRW_COLBIT_MASK 0x001F
+#define ALTR_SDR_DRAMADDRW_COLBIT_LSB  0
+#define ALTR_SDR_DRAMADDRW_ROWBIT_MASK 0x03E0
+#define ALTR_SDR_DRAMADDRW_ROWBIT_LSB  5
+#define ALTR_SDR_DRAMADDRW_BANKBIT_MASK        0x1C00
+#define ALTR_SDR_DRAMADDRW_BANKBIT_LSB 10
+#define ALTR_SDR_DRAMADDRW_CSBIT_MASK  0xE000
+#define ALTR_SDR_DRAMADDRW_CSBIT_LSB   13
+
+/* SDRAM Controller Interface Data Width Register */
+#define ALTR_SDR_DRAMIFWIDTH           0x30
+
+/* SDRAM Controller Interface Data Width Defines */
+#define ALTR_SDR_DRAMIFWIDTH_16B_ECC   24
+#define ALTR_SDR_DRAMIFWIDTH_32B_ECC   40
+
+/* SDRAM Controller DRAM Status Register */
+#define ALTR_SDR_DRAMSTS               0x38
+
+/* SDRAM Controller DRAM Status Register Bit Masks */
+#define ALTR_SDR_DRAMSTS_SBEERR                0x04
+#define ALTR_SDR_DRAMSTS_DBEERR                0x08
+#define ALTR_SDR_DRAMSTS_CORR_DROP     0x10
+
+/* SDRAM Controller DRAM IRQ Register */
+#define ALTR_SDR_DRAMINTR              0x3C
+
+/* SDRAM Controller DRAM IRQ Register Bit Masks */
+#define ALTR_SDR_DRAMINTR_INTREN       0x01
+#define ALTR_SDR_DRAMINTR_SBEMASK      0x02
+#define ALTR_SDR_DRAMINTR_DBEMASK      0x04
+#define ALTR_SDR_DRAMINTR_CORRDROPMASK 0x08
+#define ALTR_SDR_DRAMINTR_INTRCLR      0x10
+
+/* SDRAM Controller Single Bit Error Count Register */
+#define ALTR_SDR_SBECOUNT              0x40
+
+/* SDRAM Controller Single Bit Error Count Register Bit Masks */
+#define ALTR_SDR_SBECOUNT_MASK         0x0F
+
+/* SDRAM Controller Double Bit Error Count Register */
+#define ALTR_SDR_DBECOUNT              0x44
+
+/* SDRAM Controller Double Bit Error Count Register Bit Masks */
+#define ALTR_SDR_DBECOUNT_MASK         0x0F
+
+/* SDRAM Controller ECC Error Address Register */
+#define ALTR_SDR_ERRADDR               0x48
+
+/* SDRAM Controller ECC Error Address Register Bit Masks */
+#define ALTR_SDR_ERRADDR_MASK          0xFFFFFFFF
+
+/* SDRAM Controller ECC Autocorrect Drop Count Register */
+#define ALTR_SDR_DROPCOUNT             0x4C
+
+/* SDRAM Controller ECC Autocorrect Drop Count Register Bit Masks */
+#define ALTR_SDR_DROPCOUNT_MASK                0x0F
+
+/* SDRAM Controller ECC AutoCorrect Address Register */
+#define ALTR_SDR_DROPADDR              0x50
+
+/* SDRAM Controller ECC AutoCorrect Error Address Register Bit Masks */
+#define ALTR_SDR_DROPADDR_MASK         0xFFFFFFFF
+
+/* Altera SDRAM Memory Controller data */
+struct altr_sdram_mc_data {
+       struct regmap *mc_vbase;
+};
+
+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 = 0, err_count = 0, err_addr = 0;
+
+       /* Error Address is shared by both SBE & DBE */
+       regmap_read(drvdata->mc_vbase, ALTR_SDR_ERRADDR, &err_addr);
+
+       regmap_read(drvdata->mc_vbase, ALTR_SDR_DRAMSTS, &status);
+
+       if (status & ALTR_SDR_DRAMSTS_DBEERR) {
+               regmap_read(drvdata->mc_vbase, ALTR_SDR_DBECOUNT, &err_count);
+               panic("\nEDAC: [%d Uncorrectable errors @ 0x%08X]\n",
+                     err_count, err_addr);
+       }
+       if (status & ALTR_SDR_DRAMSTS_SBEERR) {
+               regmap_read(drvdata->mc_vbase, ALTR_SDR_SBECOUNT, &err_count);
+               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, "");
+       }
+
+       regmap_write(drvdata->mc_vbase, ALTR_SDR_DRAMINTR,
+                    (ALTR_SDR_DRAMINTR_INTRCLR | ALTR_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 = 0;
+
+       ptemp = dma_alloc_coherent(mci->pdev, 16, &dma_handle, GFP_KERNEL);
+       if (IS_ERR(ptemp)) {
+               dma_free_coherent(mci->pdev, 16, ptemp, dma_handle);
+               dev_err(mci->pdev, "**EDAC Inject: Buffer Allocation error\n");
+               return -ENOMEM;
+       }
+
+       regmap_read(drvdata->mc_vbase, ALTR_SDR_CTLCFG, &read_reg);
+       read_reg &= ~(ALTR_SDR_CTLCFG_GEN_SB_ERR | ALTR_SDR_CTLCFG_GEN_DB_ERR);
+
+       if (count == 3) {
+               dev_alert(mci->pdev, "** EDAC Inject Double bit error\n");
+               regmap_write(drvdata->mc_vbase, ALTR_SDR_CTLCFG,
+                            (read_reg | ALTR_SDR_CTLCFG_GEN_DB_ERR));
+       } else {
+               dev_alert(mci->pdev, "** EDAC Inject Single bit error\n");
+               regmap_write(drvdata->mc_vbase, ALTR_SDR_CTLCFG,
+                            (read_reg | ALTR_SDR_CTLCFG_GEN_SB_ERR));
+       }
+
+       ptemp[0] = 0x5A5A5A5A;
+       ptemp[1] = 0xA5A5A5A5;
+       regmap_write(drvdata->mc_vbase, ALTR_SDR_CTLCFG, read_reg);
+       /* Ensure it has been written out */
+       wmb();
+
+       reg = ptemp[0];
+       read_reg = ptemp[1];
+
+       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
+
+/* Get total memory size in bytes */
+static u32 altr_sdram_get_total_mem_size(struct regmap *mc_vbase)
+{
+       u32 size;
+       u32 read_reg, row, bank, col, cs, width;
+       u32 retcode;
+
+       retcode = regmap_read(mc_vbase, ALTR_SDR_DRAMADDRW, &read_reg);
+       if (retcode < 0)
+               return 0;
+
+       col = (read_reg & ALTR_SDR_DRAMADDRW_COLBIT_MASK) >>
+               ALTR_SDR_DRAMADDRW_COLBIT_LSB;
+       row = (read_reg & ALTR_SDR_DRAMADDRW_ROWBIT_MASK) >>
+               ALTR_SDR_DRAMADDRW_ROWBIT_LSB;
+       bank = (read_reg & ALTR_SDR_DRAMADDRW_BANKBIT_MASK) >>
+               ALTR_SDR_DRAMADDRW_BANKBIT_LSB;
+       cs = (read_reg & ALTR_SDR_DRAMADDRW_CSBIT_MASK) >>
+               ALTR_SDR_DRAMADDRW_CSBIT_LSB;
+
+       if (regmap_read(mc_vbase, ALTR_SDR_DRAMIFWIDTH, &width) < 0)
+               return 0;
+
+       /* Correct for ECC as its not addressible */
+       if (width == ALTR_SDR_DRAMIFWIDTH_32B_ECC)
+               width = 32;
+       if (width == ALTR_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;
+}
+
+static int altr_sdram_mc_probe(struct platform_device *pdev)
+{
+       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, retcode;
+
+       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;
+       platform_set_drvdata(pdev, mci);
+
+       if (!devres_open_group(&pdev->dev, NULL, GFP_KERNEL)) {
+               edac_mc_free(mci);
+               return -ENOMEM;
+       }
+
+       /* Grab the register values from the sdr-ctl in device tree */
+       drvdata->mc_vbase = syscon_regmap_lookup_by_compatible("altr,sdr-ctl");
+       if (IS_ERR(drvdata->mc_vbase)) {
+               dev_err(&pdev->dev,
+                       "regmap for altr,sdr-ctl lookup failed.\n");
+               res = -ENODEV;
+               goto err;
+       }
+
+       retcode = regmap_read(drvdata->mc_vbase, ALTR_SDR_CTLCFG, &read_reg);
+       if (retcode || ((read_reg & ALTR_SDR_CTLCFG_ECC_AUTO_EN) !=
+               ALTR_SDR_CTLCFG_ECC_AUTO_EN)) {
+               dev_err(&pdev->dev, "No ECC present / ECC disabled - 0x%08X\n",
+                       read_reg);
+               res = -ENODEV;
+               goto err;
+       }
+
+       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 = ALTR_EDAC_MOD_STR;
+       mci->mod_ver = "1";
+       mci->ctl_name = dev_name(&pdev->dev);
+       mci->scrub_mode = SCRUB_SW_SRC;
+       mci->dev_name = dev_name(&pdev->dev);
+
+       /* Grab memory size from device tree. */
+       mem_size = altr_sdram_get_total_mem_size(drvdata->mc_vbase);
+       dimm = *mci->dimms;
+       if (mem_size <= 0) {
+               dev_err(&pdev->dev, "Unable to calculate memory size\n");
+               res = -ENODEV;
+               goto err;
+       }
+       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;
+
+       retcode = regmap_write(drvdata->mc_vbase, ALTR_SDR_DRAMINTR,
+                       ALTR_SDR_DRAMINTR_INTRCLR);
+       if (retcode) {
+               dev_err(&pdev->dev, "Error clearing SDRAM ECC IRQ\n");
+               res = -ENODEV;
+               goto err;
+       }
+
+       irq = platform_get_irq(pdev, 0);
+       res = devm_request_irq(&pdev->dev, irq, altr_sdram_mc_err_handler,
+                               0, dev_name(&pdev->dev), mci);
+       if (res < 0) {
+               dev_err(&pdev->dev, "Unable to request irq %d\n", irq);
+               res = -ENODEV;
+               goto err;
+       }
+
+       retcode = regmap_write(drvdata->mc_vbase, ALTR_SDR_DRAMINTR,
+               (ALTR_SDR_DRAMINTR_INTRCLR | ALTR_SDR_DRAMINTR_INTREN));
+       if (retcode) {
+               dev_err(&pdev->dev, "Error enabling SDRAM ECC IRQ\n");
+               res = -ENODEV;
+               goto err2;
+       }
+
+       altr_sdr_mc_create_debugfs_nodes(mci);
+
+       devres_close_group(&pdev->dev, NULL);
+
+       return 0;
+err2:
+       edac_mc_del_mc(&pdev->dev);
+err:
+       dev_err(&pdev->dev, "EDAC Probe Failed; Error %d\n", res);
+       devres_release_group(&pdev->dev, NULL);
+       edac_mc_free(mci);
+
+       return res;
+}
+
+static int altr_sdram_mc_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_mc_edac_driver = {
+       .probe = altr_sdram_mc_probe,
+       .remove = altr_sdram_mc_remove,
+       .driver = {
+               .name = "altr_sdram_mc_edac",
+               .of_match_table = of_match_ptr(altr_sdram_ctrl_of_match),
+       },
+};
+
+module_platform_driver(altr_sdram_mc_edac_driver);
+
+MODULE_LICENSE("GPL v2");
+MODULE_AUTHOR("Altera Corporation");
+MODULE_DESCRIPTION("EDAC Driver for Altera SDRAM Controller");
-- 
1.7.9.5

--
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