^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (c) 2017 Free Electrons
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Authors:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Boris Brezillon <boris.brezillon@free-electrons.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Peter Pan <peterpandong@micron.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #define pr_fmt(fmt) "nand-bbt: " fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/mtd/nand.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) * nanddev_bbt_init() - Initialize the BBT (Bad Block Table)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) * @nand: NAND device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * Initialize the in-memory BBT.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) * Return: 0 in case of success, a negative error code otherwise.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) int nanddev_bbt_init(struct nand_device *nand)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) unsigned int nblocks = nanddev_neraseblocks(nand);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) unsigned int nwords = DIV_ROUND_UP(nblocks * bits_per_block,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) BITS_PER_LONG);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) nand->bbt.cache = kcalloc(nwords, sizeof(*nand->bbt.cache),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) if (!nand->bbt.cache)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) EXPORT_SYMBOL_GPL(nanddev_bbt_init);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * nanddev_bbt_cleanup() - Cleanup the BBT (Bad Block Table)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * @nand: NAND device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * Undoes what has been done in nanddev_bbt_init()
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) void nanddev_bbt_cleanup(struct nand_device *nand)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) kfree(nand->bbt.cache);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) EXPORT_SYMBOL_GPL(nanddev_bbt_cleanup);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) * nanddev_bbt_update() - Update a BBT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) * @nand: nand device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) * Update the BBT. Currently a NOP function since on-flash bbt is not yet
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) * supported.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) * Return: 0 in case of success, a negative error code otherwise.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) int nanddev_bbt_update(struct nand_device *nand)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) EXPORT_SYMBOL_GPL(nanddev_bbt_update);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) * nanddev_bbt_get_block_status() - Return the status of an eraseblock
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) * @nand: nand device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) * @entry: the BBT entry
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) * Return: a positive number nand_bbt_block_status status or -%ERANGE if @entry
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) * is bigger than the BBT size.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) int nanddev_bbt_get_block_status(const struct nand_device *nand,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) unsigned int entry)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) unsigned long *pos = nand->bbt.cache +
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) ((entry * bits_per_block) / BITS_PER_LONG);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) unsigned int offs = (entry * bits_per_block) % BITS_PER_LONG;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) unsigned long status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) if (entry >= nanddev_neraseblocks(nand))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) return -ERANGE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) status = pos[0] >> offs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) if (bits_per_block + offs > BITS_PER_LONG)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) status |= pos[1] << (BITS_PER_LONG - offs);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) return status & GENMASK(bits_per_block - 1, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) EXPORT_SYMBOL_GPL(nanddev_bbt_get_block_status);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) * nanddev_bbt_set_block_status() - Update the status of an eraseblock in the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) * in-memory BBT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) * @nand: nand device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) * @entry: the BBT entry to update
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) * @status: the new status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) * Update an entry of the in-memory BBT. If you want to push the updated BBT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) * the NAND you should call nanddev_bbt_update().
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) * Return: 0 in case of success or -%ERANGE if @entry is bigger than the BBT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) * size.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) int nanddev_bbt_set_block_status(struct nand_device *nand, unsigned int entry,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) enum nand_bbt_block_status status)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) unsigned int bits_per_block = fls(NAND_BBT_BLOCK_NUM_STATUS);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) unsigned long *pos = nand->bbt.cache +
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) ((entry * bits_per_block) / BITS_PER_LONG);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) unsigned int offs = (entry * bits_per_block) % BITS_PER_LONG;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) unsigned long val = status & GENMASK(bits_per_block - 1, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) if (entry >= nanddev_neraseblocks(nand))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) return -ERANGE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) if (bits_per_block + offs > BITS_PER_LONG)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) pos[0] &= ~GENMASK(BITS_PER_LONG - 1, offs);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) pos[0] &= ~GENMASK(offs + bits_per_block - 1, offs);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) pos[0] |= val << offs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) if (bits_per_block + offs > BITS_PER_LONG) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) unsigned int rbits = bits_per_block + offs - BITS_PER_LONG;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) pos[1] &= ~GENMASK(rbits - 1, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) pos[1] |= val >> (bits_per_block - rbits);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) EXPORT_SYMBOL_GPL(nanddev_bbt_set_block_status);