2012-09-27 10:58:06 -06:00
|
|
|
/*
|
|
|
|
* NAND Flash Controller Device Driver for DT
|
|
|
|
*
|
|
|
|
* Copyright © 2011, Picochip.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
#include <linux/clk.h>
|
|
|
|
#include <linux/err.h>
|
|
|
|
#include <linux/io.h>
|
|
|
|
#include <linux/ioport.h>
|
|
|
|
#include <linux/kernel.h>
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/platform_device.h>
|
|
|
|
#include <linux/of.h>
|
|
|
|
#include <linux/of_device.h>
|
|
|
|
|
|
|
|
#include "denali.h"
|
|
|
|
|
|
|
|
struct denali_dt {
|
|
|
|
struct denali_nand_info denali;
|
|
|
|
struct clk *clk;
|
|
|
|
};
|
|
|
|
|
2017-03-22 14:07:07 -06:00
|
|
|
struct denali_dt_data {
|
2017-03-30 00:45:57 -06:00
|
|
|
unsigned int revision;
|
2017-03-22 14:07:07 -06:00
|
|
|
unsigned int caps;
|
mtd: nand: denali: avoid hard-coding ECC step, strength, bytes
This driver was originally written for the Intel MRST platform with
several platform-specific parameters hard-coded.
Currently, the ECC settings are hard-coded as follows:
#define ECC_SECTOR_SIZE 512
#define ECC_8BITS 14
#define ECC_15BITS 26
Therefore, the driver can only support two cases.
- ecc.size = 512, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 512, ecc.strength = 15 --> ecc.bytes = 26
However, these are actually customizable parameters, for example,
UniPhier platform supports the following:
- ecc.size = 1024, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 1024, ecc.strength = 16 --> ecc.bytes = 28
- ecc.size = 1024, ecc.strength = 24 --> ecc.bytes = 42
So, we need to handle the ECC parameters in a more generic manner.
Fortunately, the Denali User's Guide explains how to calculate the
ecc.bytes. The formula is:
ecc.bytes = 2 * CEIL(13 * ecc.strength / 16) (for ecc.size = 512)
ecc.bytes = 2 * CEIL(14 * ecc.strength / 16) (for ecc.size = 1024)
For DT platforms, it would be reasonable to allow DT to specify ECC
strength by either "nand-ecc-strength" or "nand-ecc-maximize". If
none of them is specified, the driver will try to meet the chip's ECC
requirement.
For PCI platforms, the max ECC strength is used to keep the original
behavior.
Newer versions of this IP need ecc.size and ecc.steps explicitly
set up via the following registers:
CFG_DATA_BLOCK_SIZE (0x6b0)
CFG_LAST_DATA_BLOCK_SIZE (0x6c0)
CFG_NUM_DATA_BLOCKS (0x6d0)
For older IP versions, write accesses to these registers are just
ignored.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
2017-06-07 05:52:12 -06:00
|
|
|
const struct nand_ecc_caps *ecc_caps;
|
2017-03-22 14:07:07 -06:00
|
|
|
};
|
|
|
|
|
mtd: nand: denali: avoid hard-coding ECC step, strength, bytes
This driver was originally written for the Intel MRST platform with
several platform-specific parameters hard-coded.
Currently, the ECC settings are hard-coded as follows:
#define ECC_SECTOR_SIZE 512
#define ECC_8BITS 14
#define ECC_15BITS 26
Therefore, the driver can only support two cases.
- ecc.size = 512, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 512, ecc.strength = 15 --> ecc.bytes = 26
However, these are actually customizable parameters, for example,
UniPhier platform supports the following:
- ecc.size = 1024, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 1024, ecc.strength = 16 --> ecc.bytes = 28
- ecc.size = 1024, ecc.strength = 24 --> ecc.bytes = 42
So, we need to handle the ECC parameters in a more generic manner.
Fortunately, the Denali User's Guide explains how to calculate the
ecc.bytes. The formula is:
ecc.bytes = 2 * CEIL(13 * ecc.strength / 16) (for ecc.size = 512)
ecc.bytes = 2 * CEIL(14 * ecc.strength / 16) (for ecc.size = 1024)
For DT platforms, it would be reasonable to allow DT to specify ECC
strength by either "nand-ecc-strength" or "nand-ecc-maximize". If
none of them is specified, the driver will try to meet the chip's ECC
requirement.
For PCI platforms, the max ECC strength is used to keep the original
behavior.
Newer versions of this IP need ecc.size and ecc.steps explicitly
set up via the following registers:
CFG_DATA_BLOCK_SIZE (0x6b0)
CFG_LAST_DATA_BLOCK_SIZE (0x6c0)
CFG_NUM_DATA_BLOCKS (0x6d0)
For older IP versions, write accesses to these registers are just
ignored.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
2017-06-07 05:52:12 -06:00
|
|
|
NAND_ECC_CAPS_SINGLE(denali_socfpga_ecc_caps, denali_calc_ecc_bytes,
|
|
|
|
512, 8, 15);
|
2017-03-30 00:45:53 -06:00
|
|
|
static const struct denali_dt_data denali_socfpga_data = {
|
|
|
|
.caps = DENALI_CAP_HW_ECC_FIXUP,
|
mtd: nand: denali: avoid hard-coding ECC step, strength, bytes
This driver was originally written for the Intel MRST platform with
several platform-specific parameters hard-coded.
Currently, the ECC settings are hard-coded as follows:
#define ECC_SECTOR_SIZE 512
#define ECC_8BITS 14
#define ECC_15BITS 26
Therefore, the driver can only support two cases.
- ecc.size = 512, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 512, ecc.strength = 15 --> ecc.bytes = 26
However, these are actually customizable parameters, for example,
UniPhier platform supports the following:
- ecc.size = 1024, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 1024, ecc.strength = 16 --> ecc.bytes = 28
- ecc.size = 1024, ecc.strength = 24 --> ecc.bytes = 42
So, we need to handle the ECC parameters in a more generic manner.
Fortunately, the Denali User's Guide explains how to calculate the
ecc.bytes. The formula is:
ecc.bytes = 2 * CEIL(13 * ecc.strength / 16) (for ecc.size = 512)
ecc.bytes = 2 * CEIL(14 * ecc.strength / 16) (for ecc.size = 1024)
For DT platforms, it would be reasonable to allow DT to specify ECC
strength by either "nand-ecc-strength" or "nand-ecc-maximize". If
none of them is specified, the driver will try to meet the chip's ECC
requirement.
For PCI platforms, the max ECC strength is used to keep the original
behavior.
Newer versions of this IP need ecc.size and ecc.steps explicitly
set up via the following registers:
CFG_DATA_BLOCK_SIZE (0x6b0)
CFG_LAST_DATA_BLOCK_SIZE (0x6c0)
CFG_NUM_DATA_BLOCKS (0x6d0)
For older IP versions, write accesses to these registers are just
ignored.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
2017-06-07 05:52:12 -06:00
|
|
|
.ecc_caps = &denali_socfpga_ecc_caps,
|
2017-03-30 00:45:53 -06:00
|
|
|
};
|
2012-09-27 10:58:06 -06:00
|
|
|
|
2017-06-07 05:52:14 -06:00
|
|
|
NAND_ECC_CAPS_SINGLE(denali_uniphier_v5a_ecc_caps, denali_calc_ecc_bytes,
|
|
|
|
1024, 8, 16, 24);
|
|
|
|
static const struct denali_dt_data denali_uniphier_v5a_data = {
|
|
|
|
.caps = DENALI_CAP_HW_ECC_FIXUP |
|
|
|
|
DENALI_CAP_DMA_64BIT,
|
|
|
|
.ecc_caps = &denali_uniphier_v5a_ecc_caps,
|
|
|
|
};
|
|
|
|
|
|
|
|
NAND_ECC_CAPS_SINGLE(denali_uniphier_v5b_ecc_caps, denali_calc_ecc_bytes,
|
|
|
|
1024, 8, 16);
|
|
|
|
static const struct denali_dt_data denali_uniphier_v5b_data = {
|
|
|
|
.revision = 0x0501,
|
|
|
|
.caps = DENALI_CAP_HW_ECC_FIXUP |
|
|
|
|
DENALI_CAP_DMA_64BIT,
|
|
|
|
.ecc_caps = &denali_uniphier_v5b_ecc_caps,
|
|
|
|
};
|
|
|
|
|
2017-03-30 00:45:53 -06:00
|
|
|
static const struct of_device_id denali_nand_dt_ids[] = {
|
|
|
|
{
|
|
|
|
.compatible = "altr,socfpga-denali-nand",
|
|
|
|
.data = &denali_socfpga_data,
|
|
|
|
},
|
2017-06-07 05:52:14 -06:00
|
|
|
{
|
|
|
|
.compatible = "socionext,uniphier-denali-nand-v5a",
|
|
|
|
.data = &denali_uniphier_v5a_data,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
.compatible = "socionext,uniphier-denali-nand-v5b",
|
|
|
|
.data = &denali_uniphier_v5b_data,
|
|
|
|
},
|
2017-03-30 00:45:53 -06:00
|
|
|
{ /* sentinel */ }
|
|
|
|
};
|
2012-09-27 10:58:06 -06:00
|
|
|
MODULE_DEVICE_TABLE(of, denali_nand_dt_ids);
|
|
|
|
|
2017-03-30 00:45:56 -06:00
|
|
|
static int denali_dt_probe(struct platform_device *pdev)
|
2012-09-27 10:58:06 -06:00
|
|
|
{
|
2017-06-05 17:21:40 -06:00
|
|
|
struct resource *res;
|
2012-09-27 10:58:06 -06:00
|
|
|
struct denali_dt *dt;
|
2017-03-22 14:07:07 -06:00
|
|
|
const struct denali_dt_data *data;
|
2012-09-27 10:58:06 -06:00
|
|
|
struct denali_nand_info *denali;
|
|
|
|
int ret;
|
|
|
|
|
2017-03-30 00:45:56 -06:00
|
|
|
dt = devm_kzalloc(&pdev->dev, sizeof(*dt), GFP_KERNEL);
|
2012-09-27 10:58:06 -06:00
|
|
|
if (!dt)
|
|
|
|
return -ENOMEM;
|
|
|
|
denali = &dt->denali;
|
|
|
|
|
2017-03-30 00:45:56 -06:00
|
|
|
data = of_device_get_match_data(&pdev->dev);
|
2017-03-30 00:45:57 -06:00
|
|
|
if (data) {
|
|
|
|
denali->revision = data->revision;
|
2017-03-22 14:07:07 -06:00
|
|
|
denali->caps = data->caps;
|
mtd: nand: denali: avoid hard-coding ECC step, strength, bytes
This driver was originally written for the Intel MRST platform with
several platform-specific parameters hard-coded.
Currently, the ECC settings are hard-coded as follows:
#define ECC_SECTOR_SIZE 512
#define ECC_8BITS 14
#define ECC_15BITS 26
Therefore, the driver can only support two cases.
- ecc.size = 512, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 512, ecc.strength = 15 --> ecc.bytes = 26
However, these are actually customizable parameters, for example,
UniPhier platform supports the following:
- ecc.size = 1024, ecc.strength = 8 --> ecc.bytes = 14
- ecc.size = 1024, ecc.strength = 16 --> ecc.bytes = 28
- ecc.size = 1024, ecc.strength = 24 --> ecc.bytes = 42
So, we need to handle the ECC parameters in a more generic manner.
Fortunately, the Denali User's Guide explains how to calculate the
ecc.bytes. The formula is:
ecc.bytes = 2 * CEIL(13 * ecc.strength / 16) (for ecc.size = 512)
ecc.bytes = 2 * CEIL(14 * ecc.strength / 16) (for ecc.size = 1024)
For DT platforms, it would be reasonable to allow DT to specify ECC
strength by either "nand-ecc-strength" or "nand-ecc-maximize". If
none of them is specified, the driver will try to meet the chip's ECC
requirement.
For PCI platforms, the max ECC strength is used to keep the original
behavior.
Newer versions of this IP need ecc.size and ecc.steps explicitly
set up via the following registers:
CFG_DATA_BLOCK_SIZE (0x6b0)
CFG_LAST_DATA_BLOCK_SIZE (0x6c0)
CFG_NUM_DATA_BLOCKS (0x6d0)
For older IP versions, write accesses to these registers are just
ignored.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
2017-06-07 05:52:12 -06:00
|
|
|
denali->ecc_caps = data->ecc_caps;
|
2017-03-30 00:45:57 -06:00
|
|
|
}
|
2017-03-22 14:07:07 -06:00
|
|
|
|
2017-03-30 00:45:56 -06:00
|
|
|
denali->dev = &pdev->dev;
|
|
|
|
denali->irq = platform_get_irq(pdev, 0);
|
2012-09-27 10:58:06 -06:00
|
|
|
if (denali->irq < 0) {
|
2017-03-30 00:45:56 -06:00
|
|
|
dev_err(&pdev->dev, "no irq defined\n");
|
2013-03-18 03:41:13 -06:00
|
|
|
return denali->irq;
|
2012-09-27 10:58:06 -06:00
|
|
|
}
|
|
|
|
|
2017-06-05 17:21:40 -06:00
|
|
|
res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "denali_reg");
|
mtd: nand: denali: avoid magic numbers and rename for clarification
Introduce some macros and helpers to avoid magic numbers and
rename macros/functions for clarification.
- We see '| 2' in several places. This means Data Cycle in MAP11 mode.
The Denali User's Guide says bit[1:0] of MAP11 is like follows:
b'00 = Command Cycle
b'01 = Address Cycle
b'10 = Data Cycle
So, this commit added DENALI_MAP11_{CMD,ADDR,DATA} macros.
- We see 'denali->flash_mem + 0x10' in several places, but 0x10 is a
magic number. Actually, this accesses the data port of the Host
Data/Command Interface. So, this commit added DENALI_HOST_DATA.
On the other hand, 'denali->flash_mem' gets access to the address
port, so DENALI_HOST_ADDR was also added.
- We see 'index_addr(denali, cmd, 0x1)' in denali_erase(), but 0x1
is a magic number. 0x1 means the erase operation. Replace 0x1
with DENALI_ERASE.
- Rename index_addr() to denali_host_write() for clarification
- Denali User's Guide says MAP{00,01,10,11} for access mode. Match
the macros with terminology in the IP document.
- Rename struct members as follows:
flash_bank -> active_bank (currently selected bank)
flash_reg -> reg (base address of registers)
flash_mem -> host (base address of host interface)
devnum -> devs_per_cs (devices connected in parallel)
bbtskipbytes -> oob_skip_bytes (number of bytes to skip in OOB)
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
2017-06-15 23:36:39 -06:00
|
|
|
denali->reg = devm_ioremap_resource(&pdev->dev, res);
|
|
|
|
if (IS_ERR(denali->reg))
|
|
|
|
return PTR_ERR(denali->reg);
|
2012-09-27 10:58:06 -06:00
|
|
|
|
2017-06-05 17:21:40 -06:00
|
|
|
res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "nand_data");
|
mtd: nand: denali: avoid magic numbers and rename for clarification
Introduce some macros and helpers to avoid magic numbers and
rename macros/functions for clarification.
- We see '| 2' in several places. This means Data Cycle in MAP11 mode.
The Denali User's Guide says bit[1:0] of MAP11 is like follows:
b'00 = Command Cycle
b'01 = Address Cycle
b'10 = Data Cycle
So, this commit added DENALI_MAP11_{CMD,ADDR,DATA} macros.
- We see 'denali->flash_mem + 0x10' in several places, but 0x10 is a
magic number. Actually, this accesses the data port of the Host
Data/Command Interface. So, this commit added DENALI_HOST_DATA.
On the other hand, 'denali->flash_mem' gets access to the address
port, so DENALI_HOST_ADDR was also added.
- We see 'index_addr(denali, cmd, 0x1)' in denali_erase(), but 0x1
is a magic number. 0x1 means the erase operation. Replace 0x1
with DENALI_ERASE.
- Rename index_addr() to denali_host_write() for clarification
- Denali User's Guide says MAP{00,01,10,11} for access mode. Match
the macros with terminology in the IP document.
- Rename struct members as follows:
flash_bank -> active_bank (currently selected bank)
flash_reg -> reg (base address of registers)
flash_mem -> host (base address of host interface)
devnum -> devs_per_cs (devices connected in parallel)
bbtskipbytes -> oob_skip_bytes (number of bytes to skip in OOB)
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
2017-06-15 23:36:39 -06:00
|
|
|
denali->host = devm_ioremap_resource(&pdev->dev, res);
|
|
|
|
if (IS_ERR(denali->host))
|
|
|
|
return PTR_ERR(denali->host);
|
2012-09-27 10:58:06 -06:00
|
|
|
|
2017-03-30 00:45:56 -06:00
|
|
|
dt->clk = devm_clk_get(&pdev->dev, NULL);
|
2012-09-27 10:58:06 -06:00
|
|
|
if (IS_ERR(dt->clk)) {
|
2017-03-30 00:45:56 -06:00
|
|
|
dev_err(&pdev->dev, "no clk available\n");
|
2012-09-27 10:58:06 -06:00
|
|
|
return PTR_ERR(dt->clk);
|
|
|
|
}
|
|
|
|
clk_prepare_enable(dt->clk);
|
|
|
|
|
mtd: nand: denali: handle timing parameters by setup_data_interface()
Handling timing parameters in a driver's own way should be avoided
because it duplicates efforts of drivers/mtd/nand/nand_timings.c
Besides, this driver hard-codes Intel specific parameters such as
CLK_X=5, CLK_MULTI=4. Taking a certain device (Samsung K9WAG08U1A)
into account by get_samsung_nand_para() is weird as well.
Now, the core framework provides .setup_data_interface() hook, which
handles timing parameters in a generic manner.
While I am working on this, I found even more issues in the current
code, so fixed the following as well:
- In recent IP versions, WE_2_RE and TWHR2 share the same register.
Likewise for ADDR_2_DATA and TCWAW, CS_SETUP_CNT and TWB. When
updating one, the other must be masked. Otherwise, the other will
be set to 0, then timing settings will be broken.
- The recent IP release expanded the ADDR_2_DATA to 7-bit wide.
This register is related to tADL. As commit 74a332e78e8f ("mtd:
nand: timings: Fix tADL_min for ONFI 4.0 chips") addressed, the
ONFi 4.0 increased the minimum of tADL to 400 nsec. This may not
fit in the 6-bit ADDR_2_DATA in older versions. Check the IP
revision and handle this correctly, otherwise the register value
would wrap around.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
2017-06-13 07:45:37 -06:00
|
|
|
denali->clk_x_rate = clk_get_rate(dt->clk);
|
|
|
|
|
2012-09-27 10:58:06 -06:00
|
|
|
ret = denali_init(denali);
|
|
|
|
if (ret)
|
|
|
|
goto out_disable_clk;
|
|
|
|
|
2017-03-30 00:45:56 -06:00
|
|
|
platform_set_drvdata(pdev, dt);
|
2012-09-27 10:58:06 -06:00
|
|
|
return 0;
|
|
|
|
|
|
|
|
out_disable_clk:
|
|
|
|
clk_disable_unprepare(dt->clk);
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2017-03-30 00:45:56 -06:00
|
|
|
static int denali_dt_remove(struct platform_device *pdev)
|
2012-09-27 10:58:06 -06:00
|
|
|
{
|
2017-03-30 00:45:56 -06:00
|
|
|
struct denali_dt *dt = platform_get_drvdata(pdev);
|
2012-09-27 10:58:06 -06:00
|
|
|
|
|
|
|
denali_remove(&dt->denali);
|
2016-11-02 11:21:04 -06:00
|
|
|
clk_disable_unprepare(dt->clk);
|
2012-09-27 10:58:06 -06:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static struct platform_driver denali_dt_driver = {
|
|
|
|
.probe = denali_dt_probe,
|
2012-11-19 11:21:24 -07:00
|
|
|
.remove = denali_dt_remove,
|
2012-09-27 10:58:06 -06:00
|
|
|
.driver = {
|
|
|
|
.name = "denali-nand-dt",
|
2013-03-18 03:41:14 -06:00
|
|
|
.of_match_table = denali_nand_dt_ids,
|
2012-09-27 10:58:06 -06:00
|
|
|
},
|
|
|
|
};
|
|
|
|
|
2013-03-18 03:41:12 -06:00
|
|
|
module_platform_driver(denali_dt_driver);
|
2012-09-27 10:58:06 -06:00
|
|
|
|
|
|
|
MODULE_LICENSE("GPL");
|
|
|
|
MODULE_AUTHOR("Jamie Iles");
|
|
|
|
MODULE_DESCRIPTION("DT driver for Denali NAND controller");
|