2 * Freescale Memory Controller kernel module
4 * Support Power-based SoCs including MPC85xx, MPC86xx, MPC83xx and
5 * ARM-based Layerscape SoCs including LS2xxx. Originally split
6 * out from mpc85xx_edac EDAC driver.
8 * Parts Copyrighted (c) 2013 by Freescale Semiconductor, Inc.
10 * Author: Dave Jiang <djiang@mvista.com>
12 * 2006-2007 (c) MontaVista Software, Inc. This file is licensed under
13 * the terms of the GNU General Public License version 2. This program
14 * is licensed "as is" without any warranty of any kind, whether express
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
20 #include <linux/ctype.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/edac.h>
24 #include <linux/smp.h>
25 #include <linux/gfp.h>
27 #include <linux/of_platform.h>
28 #include <linux/of_device.h>
29 #include <linux/of_address.h>
30 #include "edac_module.h"
31 #include "fsl_ddr_edac.h"
33 #define EDAC_MOD_STR "fsl_ddr_edac"
35 static int edac_mc_idx
;
37 static u32 orig_ddr_err_disable
;
38 static u32 orig_ddr_err_sbe
;
39 static bool little_endian
;
41 static inline u32
ddr_in32(void __iomem
*addr
)
43 return little_endian
? ioread32(addr
) : ioread32be(addr
);
46 static inline void ddr_out32(void __iomem
*addr
, u32 value
)
49 iowrite32(value
, addr
);
51 iowrite32be(value
, addr
);
54 /************************ MC SYSFS parts ***********************************/
56 #define to_mci(k) container_of(k, struct mem_ctl_info, dev)
58 static ssize_t
fsl_mc_inject_data_hi_show(struct device
*dev
,
59 struct device_attribute
*mattr
,
62 struct mem_ctl_info
*mci
= to_mci(dev
);
63 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
64 return sprintf(data
, "0x%08x",
65 ddr_in32(pdata
->mc_vbase
+ FSL_MC_DATA_ERR_INJECT_HI
));
68 static ssize_t
fsl_mc_inject_data_lo_show(struct device
*dev
,
69 struct device_attribute
*mattr
,
72 struct mem_ctl_info
*mci
= to_mci(dev
);
73 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
74 return sprintf(data
, "0x%08x",
75 ddr_in32(pdata
->mc_vbase
+ FSL_MC_DATA_ERR_INJECT_LO
));
78 static ssize_t
fsl_mc_inject_ctrl_show(struct device
*dev
,
79 struct device_attribute
*mattr
,
82 struct mem_ctl_info
*mci
= to_mci(dev
);
83 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
84 return sprintf(data
, "0x%08x",
85 ddr_in32(pdata
->mc_vbase
+ FSL_MC_ECC_ERR_INJECT
));
88 static ssize_t
fsl_mc_inject_data_hi_store(struct device
*dev
,
89 struct device_attribute
*mattr
,
90 const char *data
, size_t count
)
92 struct mem_ctl_info
*mci
= to_mci(dev
);
93 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
98 rc
= kstrtoul(data
, 0, &val
);
102 ddr_out32(pdata
->mc_vbase
+ FSL_MC_DATA_ERR_INJECT_HI
, val
);
108 static ssize_t
fsl_mc_inject_data_lo_store(struct device
*dev
,
109 struct device_attribute
*mattr
,
110 const char *data
, size_t count
)
112 struct mem_ctl_info
*mci
= to_mci(dev
);
113 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
117 if (isdigit(*data
)) {
118 rc
= kstrtoul(data
, 0, &val
);
122 ddr_out32(pdata
->mc_vbase
+ FSL_MC_DATA_ERR_INJECT_LO
, val
);
128 static ssize_t
fsl_mc_inject_ctrl_store(struct device
*dev
,
129 struct device_attribute
*mattr
,
130 const char *data
, size_t count
)
132 struct mem_ctl_info
*mci
= to_mci(dev
);
133 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
137 if (isdigit(*data
)) {
138 rc
= kstrtoul(data
, 0, &val
);
142 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ECC_ERR_INJECT
, val
);
148 static DEVICE_ATTR(inject_data_hi
, S_IRUGO
| S_IWUSR
,
149 fsl_mc_inject_data_hi_show
, fsl_mc_inject_data_hi_store
);
150 static DEVICE_ATTR(inject_data_lo
, S_IRUGO
| S_IWUSR
,
151 fsl_mc_inject_data_lo_show
, fsl_mc_inject_data_lo_store
);
152 static DEVICE_ATTR(inject_ctrl
, S_IRUGO
| S_IWUSR
,
153 fsl_mc_inject_ctrl_show
, fsl_mc_inject_ctrl_store
);
155 static struct attribute
*fsl_ddr_dev_attrs
[] = {
156 &dev_attr_inject_data_hi
.attr
,
157 &dev_attr_inject_data_lo
.attr
,
158 &dev_attr_inject_ctrl
.attr
,
162 ATTRIBUTE_GROUPS(fsl_ddr_dev
);
164 /**************************** MC Err device ***************************/
167 * Taken from table 8-55 in the MPC8641 User's Manual and/or 9-61 in the
168 * MPC8572 User's Manual. Each line represents a syndrome bit column as a
169 * 64-bit value, but split into an upper and lower 32-bit chunk. The labels
170 * below correspond to Freescale's manuals.
172 static unsigned int ecc_table
[16] = {
175 0xf00fe11e, 0xc33c0ff7, /* Syndrome bit 7 */
176 0x00ff00ff, 0x00fff0ff,
177 0x0f0f0f0f, 0x0f0fff00,
178 0x11113333, 0x7777000f,
179 0x22224444, 0x8888222f,
180 0x44448888, 0xffff4441,
181 0x8888ffff, 0x11118882,
182 0xffff1111, 0x22221114, /* Syndrome bit 0 */
186 * Calculate the correct ECC value for a 64-bit value specified by high:low
188 static u8
calculate_ecc(u32 high
, u32 low
)
197 for (i
= 0; i
< 8; i
++) {
198 mask_high
= ecc_table
[i
* 2];
199 mask_low
= ecc_table
[i
* 2 + 1];
202 for (j
= 0; j
< 32; j
++) {
203 if ((mask_high
>> j
) & 1)
204 bit_cnt
^= (high
>> j
) & 1;
205 if ((mask_low
>> j
) & 1)
206 bit_cnt
^= (low
>> j
) & 1;
216 * Create the syndrome code which is generated if the data line specified by
217 * 'bit' failed. Eg generate an 8-bit codes seen in Table 8-55 in the MPC8641
218 * User's Manual and 9-61 in the MPC8572 User's Manual.
220 static u8
syndrome_from_bit(unsigned int bit
) {
225 * Cycle through the upper or lower 32-bit portion of each value in
226 * ecc_table depending on if 'bit' is in the upper or lower half of
229 for (i
= bit
< 32; i
< 16; i
+= 2)
230 syndrome
|= ((ecc_table
[i
] >> (bit
% 32)) & 1) << (i
/ 2);
236 * Decode data and ecc syndrome to determine what went wrong
237 * Note: This can only decode single-bit errors
239 static void sbe_ecc_decode(u32 cap_high
, u32 cap_low
, u32 cap_ecc
,
240 int *bad_data_bit
, int *bad_ecc_bit
)
249 * Calculate the ECC of the captured data and XOR it with the captured
250 * ECC to find an ECC syndrome value we can search for
252 syndrome
= calculate_ecc(cap_high
, cap_low
) ^ cap_ecc
;
254 /* Check if a data line is stuck... */
255 for (i
= 0; i
< 64; i
++) {
256 if (syndrome
== syndrome_from_bit(i
)) {
262 /* If data is correct, check ECC bits for errors... */
263 for (i
= 0; i
< 8; i
++) {
264 if ((syndrome
>> i
) & 0x1) {
271 #define make64(high, low) (((u64)(high) << 32) | (low))
273 static void fsl_mc_check(struct mem_ctl_info
*mci
)
275 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
276 struct csrow_info
*csrow
;
288 err_detect
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_ERR_DETECT
);
292 fsl_mc_printk(mci
, KERN_ERR
, "Err Detect Register: %#8.8x\n",
295 /* no more processing if not ECC bit errors */
296 if (!(err_detect
& (DDR_EDE_SBE
| DDR_EDE_MBE
))) {
297 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_DETECT
, err_detect
);
301 syndrome
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_CAPTURE_ECC
);
303 /* Mask off appropriate bits of syndrome based on bus width */
304 bus_width
= (ddr_in32(pdata
->mc_vbase
+ FSL_MC_DDR_SDRAM_CFG
) &
305 DSC_DBW_MASK
) ? 32 : 64;
312 ddr_in32(pdata
->mc_vbase
+ FSL_MC_CAPTURE_EXT_ADDRESS
),
313 ddr_in32(pdata
->mc_vbase
+ FSL_MC_CAPTURE_ADDRESS
));
314 pfn
= err_addr
>> PAGE_SHIFT
;
316 for (row_index
= 0; row_index
< mci
->nr_csrows
; row_index
++) {
317 csrow
= mci
->csrows
[row_index
];
318 if ((pfn
>= csrow
->first_page
) && (pfn
<= csrow
->last_page
))
322 cap_high
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_CAPTURE_DATA_HI
);
323 cap_low
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_CAPTURE_DATA_LO
);
326 * Analyze single-bit errors on 64-bit wide buses
327 * TODO: Add support for 32-bit wide buses
329 if ((err_detect
& DDR_EDE_SBE
) && (bus_width
== 64)) {
330 sbe_ecc_decode(cap_high
, cap_low
, syndrome
,
331 &bad_data_bit
, &bad_ecc_bit
);
333 if (bad_data_bit
!= -1)
334 fsl_mc_printk(mci
, KERN_ERR
,
335 "Faulty Data bit: %d\n", bad_data_bit
);
336 if (bad_ecc_bit
!= -1)
337 fsl_mc_printk(mci
, KERN_ERR
,
338 "Faulty ECC bit: %d\n", bad_ecc_bit
);
340 fsl_mc_printk(mci
, KERN_ERR
,
341 "Expected Data / ECC:\t%#8.8x_%08x / %#2.2x\n",
342 cap_high
^ (1 << (bad_data_bit
- 32)),
343 cap_low
^ (1 << bad_data_bit
),
344 syndrome
^ (1 << bad_ecc_bit
));
347 fsl_mc_printk(mci
, KERN_ERR
,
348 "Captured Data / ECC:\t%#8.8x_%08x / %#2.2x\n",
349 cap_high
, cap_low
, syndrome
);
350 fsl_mc_printk(mci
, KERN_ERR
, "Err addr: %#8.8llx\n", err_addr
);
351 fsl_mc_printk(mci
, KERN_ERR
, "PFN: %#8.8x\n", pfn
);
353 /* we are out of range */
354 if (row_index
== mci
->nr_csrows
)
355 fsl_mc_printk(mci
, KERN_ERR
, "PFN out of range!\n");
357 if (err_detect
& DDR_EDE_SBE
)
358 edac_mc_handle_error(HW_EVENT_ERR_CORRECTED
, mci
, 1,
359 pfn
, err_addr
& ~PAGE_MASK
, syndrome
,
363 if (err_detect
& DDR_EDE_MBE
)
364 edac_mc_handle_error(HW_EVENT_ERR_UNCORRECTED
, mci
, 1,
365 pfn
, err_addr
& ~PAGE_MASK
, syndrome
,
369 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_DETECT
, err_detect
);
372 static irqreturn_t
fsl_mc_isr(int irq
, void *dev_id
)
374 struct mem_ctl_info
*mci
= dev_id
;
375 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
378 err_detect
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_ERR_DETECT
);
387 static void fsl_ddr_init_csrows(struct mem_ctl_info
*mci
)
389 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
390 struct csrow_info
*csrow
;
391 struct dimm_info
*dimm
;
398 sdram_ctl
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_DDR_SDRAM_CFG
);
400 sdtype
= sdram_ctl
& DSC_SDTYPE_MASK
;
401 if (sdram_ctl
& DSC_RD_EN
) {
439 for (index
= 0; index
< mci
->nr_csrows
; index
++) {
443 csrow
= mci
->csrows
[index
];
444 dimm
= csrow
->channels
[0]->dimm
;
446 cs_bnds
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_CS_BNDS_0
+
447 (index
* FSL_MC_CS_BNDS_OFS
));
449 start
= (cs_bnds
& 0xffff0000) >> 16;
450 end
= (cs_bnds
& 0x0000ffff);
453 continue; /* not populated */
455 start
<<= (24 - PAGE_SHIFT
);
456 end
<<= (24 - PAGE_SHIFT
);
457 end
|= (1 << (24 - PAGE_SHIFT
)) - 1;
459 csrow
->first_page
= start
;
460 csrow
->last_page
= end
;
462 dimm
->nr_pages
= end
+ 1 - start
;
465 dimm
->dtype
= DEV_UNKNOWN
;
466 if (sdram_ctl
& DSC_X32_EN
)
467 dimm
->dtype
= DEV_X32
;
468 dimm
->edac_mode
= EDAC_SECDED
;
472 int fsl_mc_err_probe(struct platform_device
*op
)
474 struct mem_ctl_info
*mci
;
475 struct edac_mc_layer layers
[2];
476 struct fsl_mc_pdata
*pdata
;
481 if (!devres_open_group(&op
->dev
, fsl_mc_err_probe
, GFP_KERNEL
))
484 layers
[0].type
= EDAC_MC_LAYER_CHIP_SELECT
;
486 layers
[0].is_virt_csrow
= true;
487 layers
[1].type
= EDAC_MC_LAYER_CHANNEL
;
489 layers
[1].is_virt_csrow
= false;
490 mci
= edac_mc_alloc(edac_mc_idx
, ARRAY_SIZE(layers
), layers
,
493 devres_release_group(&op
->dev
, fsl_mc_err_probe
);
497 pdata
= mci
->pvt_info
;
498 pdata
->name
= "fsl_mc_err";
499 mci
->pdev
= &op
->dev
;
500 pdata
->edac_idx
= edac_mc_idx
++;
501 dev_set_drvdata(mci
->pdev
, mci
);
502 mci
->ctl_name
= pdata
->name
;
503 mci
->dev_name
= pdata
->name
;
506 * Get the endianness of DDR controller registers.
507 * Default is big endian.
509 little_endian
= of_property_read_bool(op
->dev
.of_node
, "little-endian");
511 res
= of_address_to_resource(op
->dev
.of_node
, 0, &r
);
513 pr_err("%s: Unable to get resource for MC err regs\n",
518 if (!devm_request_mem_region(&op
->dev
, r
.start
, resource_size(&r
),
520 pr_err("%s: Error while requesting mem region\n",
526 pdata
->mc_vbase
= devm_ioremap(&op
->dev
, r
.start
, resource_size(&r
));
527 if (!pdata
->mc_vbase
) {
528 pr_err("%s: Unable to setup MC err regs\n", __func__
);
533 sdram_ctl
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_DDR_SDRAM_CFG
);
534 if (!(sdram_ctl
& DSC_ECC_EN
)) {
536 pr_warn("%s: No ECC DIMMs discovered\n", __func__
);
541 edac_dbg(3, "init mci\n");
542 mci
->mtype_cap
= MEM_FLAG_DDR
| MEM_FLAG_RDDR
|
543 MEM_FLAG_DDR2
| MEM_FLAG_RDDR2
|
544 MEM_FLAG_DDR3
| MEM_FLAG_RDDR3
|
545 MEM_FLAG_DDR4
| MEM_FLAG_RDDR4
;
546 mci
->edac_ctl_cap
= EDAC_FLAG_NONE
| EDAC_FLAG_SECDED
;
547 mci
->edac_cap
= EDAC_FLAG_SECDED
;
548 mci
->mod_name
= EDAC_MOD_STR
;
550 if (edac_op_state
== EDAC_OPSTATE_POLL
)
551 mci
->edac_check
= fsl_mc_check
;
553 mci
->ctl_page_to_phys
= NULL
;
555 mci
->scrub_mode
= SCRUB_SW_SRC
;
557 fsl_ddr_init_csrows(mci
);
559 /* store the original error disable bits */
560 orig_ddr_err_disable
= ddr_in32(pdata
->mc_vbase
+ FSL_MC_ERR_DISABLE
);
561 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_DISABLE
, 0);
563 /* clear all error bits */
564 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_DETECT
, ~0);
566 res
= edac_mc_add_mc_with_groups(mci
, fsl_ddr_dev_groups
);
568 edac_dbg(3, "failed edac_mc_add_mc()\n");
572 if (edac_op_state
== EDAC_OPSTATE_INT
) {
573 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_INT_EN
,
574 DDR_EIE_MBEE
| DDR_EIE_SBEE
);
576 /* store the original error management threshold */
577 orig_ddr_err_sbe
= ddr_in32(pdata
->mc_vbase
+
578 FSL_MC_ERR_SBE
) & 0xff0000;
580 /* set threshold to 1 error per interrupt */
581 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_SBE
, 0x10000);
583 /* register interrupts */
584 pdata
->irq
= platform_get_irq(op
, 0);
585 res
= devm_request_irq(&op
->dev
, pdata
->irq
,
588 "[EDAC] MC err", mci
);
590 pr_err("%s: Unable to request irq %d for FSL DDR DRAM ERR\n",
591 __func__
, pdata
->irq
);
596 pr_info(EDAC_MOD_STR
" acquired irq %d for MC\n",
600 devres_remove_group(&op
->dev
, fsl_mc_err_probe
);
601 edac_dbg(3, "success\n");
602 pr_info(EDAC_MOD_STR
" MC err registered\n");
607 edac_mc_del_mc(&op
->dev
);
609 devres_release_group(&op
->dev
, fsl_mc_err_probe
);
614 int fsl_mc_err_remove(struct platform_device
*op
)
616 struct mem_ctl_info
*mci
= dev_get_drvdata(&op
->dev
);
617 struct fsl_mc_pdata
*pdata
= mci
->pvt_info
;
621 if (edac_op_state
== EDAC_OPSTATE_INT
) {
622 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_INT_EN
, 0);
625 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_DISABLE
,
626 orig_ddr_err_disable
);
627 ddr_out32(pdata
->mc_vbase
+ FSL_MC_ERR_SBE
, orig_ddr_err_sbe
);
629 edac_mc_del_mc(&op
->dev
);