android13/kernel-5.10/drivers/rkflash/sfc_nand_mtd_bbt.c

442 lines
12 KiB
C

// SPDX-License-Identifier: GPL-2.0
/*
* Copyright (c) 2017 Free Electrons
*
* Authors:
* Boris Brezillon <boris.brezillon@free-electrons.com>
* Peter Pan <peterpandong@micron.com>
*/
#include <linux/mtd/mtd.h>
#include <linux/slab.h>
#include "sfc_nand.h"
#include "sfc_nand_mtd.h"
#ifdef CONFIG_MTD_NAND_BBT_USING_FLASH
#ifdef BBT_DEBUG
#define BBT_DBG pr_err
#else
#define BBT_DBG(args...)
#endif
struct nanddev_bbt_info {
u8 pattern[4];
unsigned int version;
};
static u8 bbt_pattern[] = {'B', 'b', 't', '0' };
/**
* nanddev_read_bbt() - Read the BBT (Bad Block Table)
* @nand: NAND device
* @block: bbt block address
* @update: true - get version and overwrite bbt.cache with new version;
* false - get bbt version only;
*
* Initialize the in-memory BBT.
*
* Return: 0 in case of success, a negative error code otherwise.
*/
static int nanddev_read_bbt(struct snand_mtd_dev *nand, u32 block, bool update)
{
unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
unsigned int nblocks = snanddev_neraseblocks(nand);
unsigned int nbytes = DIV_ROUND_UP(nblocks * bits_per_block,
BITS_PER_LONG) * sizeof(*nand->bbt.cache);
struct mtd_info *mtd = snanddev_to_mtd(nand);
u8 *data_buf, *oob_buf, *temp_buf;
struct nanddev_bbt_info *bbt_info;
struct mtd_oob_ops ops;
u32 bbt_page_num;
int ret = 0;
unsigned int version = 0;
u32 page_addr, i;
if (!nand->bbt.cache)
return -ENOMEM;
if (block >= nblocks)
return -EINVAL;
/* aligned to page size, and even pages is better */
bbt_page_num = (sizeof(struct nanddev_bbt_info) + nbytes +
mtd->writesize - 1) >> mtd->writesize_shift;
bbt_page_num = (bbt_page_num + 1) / 2 * 2;
data_buf = kzalloc(bbt_page_num * mtd->writesize, GFP_KERNEL);
if (!data_buf)
return -ENOMEM;
oob_buf = kzalloc(bbt_page_num * mtd->oobsize, GFP_KERNEL);
if (!oob_buf) {
kfree(data_buf);
return -ENOMEM;
}
bbt_info = (struct nanddev_bbt_info *)(data_buf + nbytes);
memset(&ops, 0, sizeof(struct mtd_oob_ops));
ops.mode = MTD_OPS_PLACE_OOB;
ops.datbuf = data_buf;
ops.len = bbt_page_num * mtd->writesize;
ops.oobbuf = oob_buf;
ops.ooblen = bbt_page_num * mtd->oobsize;
ops.ooboffs = 0;
/* Store one entry for each block */
temp_buf = kzalloc(mtd->writesize + mtd->oobsize, GFP_KERNEL);
if (!temp_buf) {
kfree(data_buf);
kfree(oob_buf);
return -ENOMEM;
}
page_addr = (u32)(block << (mtd->erasesize_shift - mtd->writesize_shift));
for (i = 0; i < bbt_page_num; i++) {
ret = sfc_nand_read_page_raw(0, page_addr + i, (u32 *)temp_buf);
if (ret < 0) {
pr_err("%s fail %d\n", __func__, ret);
ret = -EIO;
kfree(temp_buf);
goto out;
}
memcpy(ops.datbuf + i * mtd->writesize, temp_buf, mtd->writesize);
memcpy(ops.oobbuf + i * mtd->oobsize, temp_buf + mtd->writesize, mtd->oobsize);
}
kfree(temp_buf);
if (oob_buf[0] != 0xff && !memcmp(bbt_pattern, bbt_info->pattern, 4))
version = bbt_info->version;
BBT_DBG("read_bbt from blk=%d tag=%d ver=%d\n", block, update, version);
if (update && version > nand->bbt.version) {
memcpy(nand->bbt.cache, data_buf, nbytes);
nand->bbt.version = version;
}
out:
kfree(data_buf);
kfree(oob_buf);
return ret < 0 ? -EIO : (int)version;
}
static int nanddev_write_bbt(struct snand_mtd_dev *nand, u32 block)
{
unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
unsigned int nblocks = snanddev_neraseblocks(nand);
unsigned int nbytes = DIV_ROUND_UP(nblocks * bits_per_block,
BITS_PER_LONG) * sizeof(*nand->bbt.cache);
struct mtd_info *mtd = snanddev_to_mtd(nand);
u8 *data_buf, *oob_buf, *temp_buf;
struct nanddev_bbt_info *bbt_info;
struct mtd_oob_ops ops;
u32 bbt_page_num;
int ret = 0;
u32 page_addr, i;
BBT_DBG("write_bbt to blk=%d ver=%d\n", block, nand->bbt.version);
if (!nand->bbt.cache)
return -ENOMEM;
if (block >= nblocks)
return -EINVAL;
/* aligned to page size, and even pages is better */
bbt_page_num = (sizeof(struct nanddev_bbt_info) + nbytes +
mtd->writesize - 1) >> mtd->writesize_shift;
bbt_page_num = (bbt_page_num + 1) / 2 * 2;
data_buf = kzalloc(bbt_page_num * mtd->writesize, GFP_KERNEL);
if (!data_buf)
return -ENOMEM;
oob_buf = kzalloc(bbt_page_num * mtd->oobsize, GFP_KERNEL);
if (!oob_buf) {
kfree(data_buf);
return -ENOMEM;
}
bbt_info = (struct nanddev_bbt_info *)(data_buf + nbytes);
memcpy(data_buf, nand->bbt.cache, nbytes);
memcpy(bbt_info, bbt_pattern, 4);
bbt_info->version = nand->bbt.version;
/* Store one entry for each block */
ret = sfc_nand_erase_mtd(mtd, block * mtd->erasesize);
if (ret)
goto out;
memset(&ops, 0, sizeof(struct mtd_oob_ops));
ops.datbuf = data_buf;
ops.len = bbt_page_num * mtd->writesize;
ops.oobbuf = oob_buf;
ops.ooblen = bbt_page_num * mtd->oobsize;
ops.ooboffs = 0;
temp_buf = kzalloc(mtd->writesize + mtd->oobsize, GFP_KERNEL);
if (!temp_buf) {
kfree(data_buf);
kfree(oob_buf);
return -ENOMEM;
}
page_addr = (u32)(block << (mtd->erasesize_shift - mtd->writesize_shift));
for (i = 0; i < bbt_page_num; i++) {
memcpy(temp_buf, ops.datbuf + i * mtd->writesize, mtd->writesize);
memcpy(temp_buf + mtd->writesize, ops.oobbuf + i * mtd->oobsize, mtd->oobsize);
ret = sfc_nand_prog_page_raw(0, page_addr + i, (u32 *)temp_buf);
if (ret < 0) {
pr_err("%s fail %d\n", __func__, ret);
ret = -EIO;
kfree(temp_buf);
goto out;
}
}
kfree(temp_buf);
out:
kfree(data_buf);
kfree(oob_buf);
return ret;
}
static int nanddev_bbt_format(struct snand_mtd_dev *nand)
{
unsigned int nblocks = snanddev_neraseblocks(nand);
struct mtd_info *mtd = snanddev_to_mtd(nand);
u32 start_block, block;
start_block = nblocks - NANDDEV_BBT_SCAN_MAXBLOCKS;
for (block = 0; block < nblocks; block++) {
if (sfc_nand_isbad_mtd(mtd, block * mtd->erasesize))
snanddev_bbt_set_block_status(nand, block,
NAND_BBT_BLOCK_FACTORY_BAD);
}
for (block = 0; block < NANDDEV_BBT_SCAN_MAXBLOCKS; block++) {
if (snanddev_bbt_get_block_status(nand, start_block + block) ==
NAND_BBT_BLOCK_GOOD)
snanddev_bbt_set_block_status(nand, start_block + block,
NAND_BBT_BLOCK_WORN);
}
return 0;
}
static int nanddev_scan_bbt(struct snand_mtd_dev *nand)
{
unsigned int nblocks = snanddev_neraseblocks(nand);
u32 start_block, block;
int ret = 0;
nand->bbt.version = 0;
start_block = nblocks - NANDDEV_BBT_SCAN_MAXBLOCKS;
for (block = 0; block < NANDDEV_BBT_SCAN_MAXBLOCKS; block++)
nanddev_read_bbt(nand, start_block + block, true);
nand->bbt.option |= NANDDEV_BBT_SCANNED;
if (nand->bbt.version == 0) {
nanddev_bbt_format(nand);
ret = snanddev_bbt_update(nand);
if (ret) {
nand->bbt.option = 0;
pr_err("%s fail\n", __func__);
}
}
return ret;
}
#endif
/**
* nanddev_bbt_init() - Initialize the BBT (Bad Block Table)
* @nand: NAND device
*
* Initialize the in-memory BBT.
*
* Return: 0 in case of success, a negative error code otherwise.
*/
int snanddev_bbt_init(struct snand_mtd_dev *nand)
{
unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
unsigned int nblocks = snanddev_neraseblocks(nand);
unsigned int nwords = DIV_ROUND_UP(nblocks * bits_per_block,
BITS_PER_LONG);
nand->bbt.cache = kcalloc(nwords, sizeof(*nand->bbt.cache),
GFP_KERNEL);
if (!nand->bbt.cache)
return -ENOMEM;
return 0;
}
EXPORT_SYMBOL_GPL(snanddev_bbt_init);
/**
* nanddev_bbt_cleanup() - Cleanup the BBT (Bad Block Table)
* @nand: NAND device
*
* Undoes what has been done in nanddev_bbt_init()
*/
void snanddev_bbt_cleanup(struct snand_mtd_dev *nand)
{
kfree(nand->bbt.cache);
}
EXPORT_SYMBOL_GPL(snanddev_bbt_cleanup);
/**
* nanddev_bbt_update() - Update a BBT
* @nand: nand device
*
* Update the BBT. Currently a NOP function since on-flash bbt is not yet
* supported.
*
* Return: 0 in case of success, a negative error code otherwise.
*/
int snanddev_bbt_update(struct snand_mtd_dev *nand)
{
#ifdef CONFIG_MTD_NAND_BBT_USING_FLASH
if (nand->bbt.cache &&
nand->bbt.option & NANDDEV_BBT_USE_FLASH) {
unsigned int nblocks = snanddev_neraseblocks(nand);
u32 bbt_version[NANDDEV_BBT_SCAN_MAXBLOCKS];
int start_block, block;
u32 min_version, block_des;
int ret, count = 0;
start_block = nblocks - NANDDEV_BBT_SCAN_MAXBLOCKS;
for (block = 0; block < NANDDEV_BBT_SCAN_MAXBLOCKS; block++) {
ret = snanddev_bbt_get_block_status(nand, start_block + block);
if (ret == NAND_BBT_BLOCK_FACTORY_BAD) {
bbt_version[block] = 0xFFFFFFFF;
continue;
}
ret = nanddev_read_bbt(nand, start_block + block,
false);
if (ret < 0)
bbt_version[block] = 0xFFFFFFFF;
else if (ret == 0)
bbt_version[block] = 0;
else
bbt_version[block] = ret;
}
get_min_ver:
min_version = 0xFFFFFFFF;
block_des = 0;
for (block = 0; block < NANDDEV_BBT_SCAN_MAXBLOCKS; block++) {
if (bbt_version[block] < min_version) {
min_version = bbt_version[block];
block_des = start_block + block;
}
}
if (block_des > 0) {
nand->bbt.version++;
ret = nanddev_write_bbt(nand, block_des);
bbt_version[block_des - start_block] = 0xFFFFFFFF;
if (ret) {
pr_err("%s blk= %d ret= %d\n", __func__,
block_des, ret);
goto get_min_ver;
} else {
count++;
if (count < 2)
goto get_min_ver;
BBT_DBG("%s success\n", __func__);
}
} else {
pr_err("%s failed\n", __func__);
return -1;
}
}
#endif
return 0;
}
EXPORT_SYMBOL_GPL(snanddev_bbt_update);
/**
* nanddev_bbt_get_block_status() - Return the status of an eraseblock
* @nand: nand device
* @entry: the BBT entry
*
* Return: a positive number nand_bbt_block_status status or -%ERANGE if @entry
* is bigger than the BBT size.
*/
int snanddev_bbt_get_block_status(const struct snand_mtd_dev *nand,
unsigned int entry)
{
unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
unsigned long *pos = nand->bbt.cache +
((entry * bits_per_block) / BITS_PER_LONG);
unsigned int offs = (entry * bits_per_block) % BITS_PER_LONG;
unsigned long status;
#ifdef CONFIG_MTD_NAND_BBT_USING_FLASH
if (nand->bbt.option & NANDDEV_BBT_USE_FLASH &&
!(nand->bbt.option & NANDDEV_BBT_SCANNED))
nanddev_scan_bbt((struct snand_mtd_dev *)nand);
#endif
if (entry >= snanddev_neraseblocks(nand))
return -ERANGE;
status = pos[0] >> offs;
if (bits_per_block + offs > BITS_PER_LONG)
status |= pos[1] << (BITS_PER_LONG - offs);
return status & GENMASK(bits_per_block - 1, 0);
}
EXPORT_SYMBOL_GPL(snanddev_bbt_get_block_status);
/**
* nanddev_bbt_set_block_status() - Update the status of an eraseblock in the
* in-memory BBT
* @nand: nand device
* @entry: the BBT entry to update
* @status: the new status
*
* Update an entry of the in-memory BBT. If you want to push the updated BBT
* the NAND you should call nanddev_bbt_update().
*
* Return: 0 in case of success or -%ERANGE if @entry is bigger than the BBT
* size.
*/
int snanddev_bbt_set_block_status(struct snand_mtd_dev *nand,
unsigned int entry,
enum nand_bbt_block_status status)
{
unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
unsigned long *pos = nand->bbt.cache +
((entry * bits_per_block) / BITS_PER_LONG);
unsigned int offs = (entry * bits_per_block) % BITS_PER_LONG;
unsigned long val = status & GENMASK(bits_per_block - 1, 0);
if (entry >= snanddev_neraseblocks(nand))
return -ERANGE;
if (offs + bits_per_block - 1 > (BITS_PER_LONG - 1))
pos[0] &= ~GENMASK(BITS_PER_LONG - 1, offs);
else
pos[0] &= ~GENMASK(offs + bits_per_block - 1, offs);
pos[0] |= val << offs;
if (bits_per_block + offs > BITS_PER_LONG) {
unsigned int rbits = BITS_PER_LONG - offs;
pos[1] &= ~GENMASK(bits_per_block - rbits - 1, 0);
pos[1] |= val >> rbits;
}
return 0;
}
EXPORT_SYMBOL_GPL(snanddev_bbt_set_block_status);