include/linux/mtd/nand.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  *  Copyright 2017 - Free Electrons
   4  *
   5  *  Authors:
   6  *      Boris Brezillon <boris.brezillon@free-electrons.com>
   7  *      Peter Pan <peterpandong@micron.com>
   8  */
   9
  10 #ifndef __LINUX_MTD_NAND_H
  11 #define __LINUX_MTD_NAND_H
  12
  13 #include <linux/mtd/mtd.h>
  14
  15 struct nand_device;
  16
  17 /**
  18  * struct nand_memory_organization - Memory organization structure
  19  * @bits_per_cell: number of bits per NAND cell
  20  * @pagesize: page size
  21  * @oobsize: OOB area size
  22  * @pages_per_eraseblock: number of pages per eraseblock
  23  * @eraseblocks_per_lun: number of eraseblocks per LUN (Logical Unit Number)
  24  * @max_bad_eraseblocks_per_lun: maximum number of eraseblocks per LUN
  25  * @planes_per_lun: number of planes per LUN
  26  * @luns_per_target: number of LUN per target (target is a synonym for die)
  27  * @ntargets: total number of targets exposed by the NAND device
  28  */
  29 struct nand_memory_organization {
  30         unsigned int bits_per_cell;
  31         unsigned int pagesize;
  32         unsigned int oobsize;
  33         unsigned int pages_per_eraseblock;
  34         unsigned int eraseblocks_per_lun;
  35         unsigned int max_bad_eraseblocks_per_lun;
  36         unsigned int planes_per_lun;
  37         unsigned int luns_per_target;
  38         unsigned int ntargets;
  39 };
  40
  41 #define NAND_MEMORG(bpc, ps, os, ppe, epl, mbb, ppl, lpt, nt)   \
  42         {                                                       \
  43                 .bits_per_cell = (bpc),                         \
  44                 .pagesize = (ps),                               \
  45                 .oobsize = (os),                                \
  46                 .pages_per_eraseblock = (ppe),                  \
  47                 .eraseblocks_per_lun = (epl),                   \
  48                 .max_bad_eraseblocks_per_lun = (mbb),           \
  49                 .planes_per_lun = (ppl),                        \
  50                 .luns_per_target = (lpt),                       \
  51                 .ntargets = (nt),                               \
  52         }
  53
  54 /**
  55  * struct nand_row_converter - Information needed to convert an absolute offset
  56  *                             into a row address
  57  * @lun_addr_shift: position of the LUN identifier in the row address
  58  * @eraseblock_addr_shift: position of the eraseblock identifier in the row
  59  *                         address
  60  */
  61 struct nand_row_converter {
  62         unsigned int lun_addr_shift;
  63         unsigned int eraseblock_addr_shift;
  64 };
  65
  66 /**
  67  * struct nand_pos - NAND position object
  68  * @target: the NAND target/die
  69  * @lun: the LUN identifier
  70  * @plane: the plane within the LUN
  71  * @eraseblock: the eraseblock within the LUN
  72  * @page: the page within the LUN
  73  *
  74  * These information are usually used by specific sub-layers to select the
  75  * appropriate target/die and generate a row address to pass to the device.
  76  */
  77 struct nand_pos {
  78         unsigned int target;
  79         unsigned int lun;
  80         unsigned int plane;
  81         unsigned int eraseblock;
  82         unsigned int page;
  83 };
  84
  85 /**
  86  * enum nand_page_io_req_type - Direction of an I/O request
  87  * @NAND_PAGE_READ: from the chip, to the controller
  88  * @NAND_PAGE_WRITE: from the controller, to the chip
  89  */
  90 enum nand_page_io_req_type {
  91         NAND_PAGE_READ = 0,
  92         NAND_PAGE_WRITE,
  93 };
  94
  95 /**
  96  * struct nand_page_io_req - NAND I/O request object
  97  * @type: the type of page I/O: read or write
  98  * @pos: the position this I/O request is targeting
  99  * @dataoffs: the offset within the page
 100  * @datalen: number of data bytes to read from/write to this page
 101  * @databuf: buffer to store data in or get data from
 102  * @ooboffs: the OOB offset within the page
 103  * @ooblen: the number of OOB bytes to read from/write to this page
 104  * @oobbuf: buffer to store OOB data in or get OOB data from
 105  * @mode: one of the %MTD_OPS_XXX mode
 106  *
 107  * This object is used to pass per-page I/O requests to NAND sub-layers. This
 108  * way all useful information are already formatted in a useful way and
 109  * specific NAND layers can focus on translating these information into
 110  * specific commands/operations.
 111  */
 112 struct nand_page_io_req {
 113         enum nand_page_io_req_type type;
 114         struct nand_pos pos;
 115         unsigned int dataoffs;
 116         unsigned int datalen;
 117         union {
 118                 const void *out;
 119                 void *in;
 120         } databuf;
 121         unsigned int ooboffs;
 122         unsigned int ooblen;
 123         union {
 124                 const void *out;
 125                 void *in;
 126         } oobbuf;
 127         int mode;
 128 };
 129
 130 const struct mtd_ooblayout_ops *nand_get_small_page_ooblayout(void);
 131 const struct mtd_ooblayout_ops *nand_get_large_page_ooblayout(void);
 132 const struct mtd_ooblayout_ops *nand_get_large_page_hamming_ooblayout(void);
 133
 134 /**
 135  * enum nand_ecc_engine_type - NAND ECC engine type
 136  * @NAND_ECC_ENGINE_TYPE_INVALID: Invalid value
 137  * @NAND_ECC_ENGINE_TYPE_NONE: No ECC correction
 138  * @NAND_ECC_ENGINE_TYPE_SOFT: Software ECC correction
 139  * @NAND_ECC_ENGINE_TYPE_ON_HOST: On host hardware ECC correction
 140  * @NAND_ECC_ENGINE_TYPE_ON_DIE: On chip hardware ECC correction
 141  */
 142 enum nand_ecc_engine_type {
 143         NAND_ECC_ENGINE_TYPE_INVALID,
 144         NAND_ECC_ENGINE_TYPE_NONE,
 145         NAND_ECC_ENGINE_TYPE_SOFT,
 146         NAND_ECC_ENGINE_TYPE_ON_HOST,
 147         NAND_ECC_ENGINE_TYPE_ON_DIE,
 148 };
 149
 150 /**
 151  * enum nand_ecc_placement - NAND ECC bytes placement
 152  * @NAND_ECC_PLACEMENT_UNKNOWN: The actual position of the ECC bytes is unknown
 153  * @NAND_ECC_PLACEMENT_OOB: The ECC bytes are located in the OOB area
 154  * @NAND_ECC_PLACEMENT_INTERLEAVED: Syndrome layout, there are ECC bytes
 155  *                                  interleaved with regular data in the main
 156  *                                  area
 157  */
 158 enum nand_ecc_placement {
 159         NAND_ECC_PLACEMENT_UNKNOWN,
 160         NAND_ECC_PLACEMENT_OOB,
 161         NAND_ECC_PLACEMENT_INTERLEAVED,
 162 };
 163
 164 /**
 165  * enum nand_ecc_algo - NAND ECC algorithm
 166  * @NAND_ECC_ALGO_UNKNOWN: Unknown algorithm
 167  * @NAND_ECC_ALGO_HAMMING: Hamming algorithm
 168  * @NAND_ECC_ALGO_BCH: Bose-Chaudhuri-Hocquenghem algorithm
 169  * @NAND_ECC_ALGO_RS: Reed-Solomon algorithm
 170  */
 171 enum nand_ecc_algo {
 172         NAND_ECC_ALGO_UNKNOWN,
 173         NAND_ECC_ALGO_HAMMING,
 174         NAND_ECC_ALGO_BCH,
 175         NAND_ECC_ALGO_RS,
 176 };
 177
 178 /**
 179  * struct nand_ecc_props - NAND ECC properties
 180  * @engine_type: ECC engine type
 181  * @placement: OOB placement (if relevant)
 182  * @algo: ECC algorithm (if relevant)
 183  * @strength: ECC strength
 184  * @step_size: Number of bytes per step
 185  * @flags: Misc properties
 186  */
 187 struct nand_ecc_props {
 188         enum nand_ecc_engine_type engine_type;
 189         enum nand_ecc_placement placement;
 190         enum nand_ecc_algo algo;
 191         unsigned int strength;
 192         unsigned int step_size;
 193         unsigned int flags;
 194 };
 195
 196 #define NAND_ECCREQ(str, stp) { .strength = (str), .step_size = (stp) }
 197
 198 /* NAND ECC misc flags */
 199 #define NAND_ECC_MAXIMIZE_STRENGTH BIT(0)
 200
 201 /**
 202  * struct nand_bbt - bad block table object
 203  * @cache: in memory BBT cache
 204  */
 205 struct nand_bbt {
 206         unsigned long *cache;
 207 };
 208
 209 /**
 210  * struct nand_ops - NAND operations
 211  * @erase: erase a specific block. No need to check if the block is bad before
 212  *         erasing, this has been taken care of by the generic NAND layer
 213  * @markbad: mark a specific block bad. No need to check if the block is
 214  *           already marked bad, this has been taken care of by the generic
 215  *           NAND layer. This method should just write the BBM (Bad Block
 216  *           Marker) so that future call to struct_nand_ops->isbad() return
 217  *           true
 218  * @isbad: check whether a block is bad or not. This method should just read
 219  *         the BBM and return whether the block is bad or not based on what it
 220  *         reads
 221  *
 222  * These are all low level operations that should be implemented by specialized
 223  * NAND layers (SPI NAND, raw NAND, ...).
 224  */
 225 struct nand_ops {
 226         int (*erase)(struct nand_device *nand, const struct nand_pos *pos);
 227         int (*markbad)(struct nand_device *nand, const struct nand_pos *pos);
 228         bool (*isbad)(struct nand_device *nand, const struct nand_pos *pos);
 229 };
 230
 231 /**
 232  * struct nand_ecc_context - Context for the ECC engine
 233  * @conf: basic ECC engine parameters
 234  * @nsteps: number of ECC steps
 235  * @total: total number of bytes used for storing ECC codes, this is used by
 236  *         generic OOB layouts
 237  * @priv: ECC engine driver private data
 238  */
 239 struct nand_ecc_context {
 240         struct nand_ecc_props conf;
 241         unsigned int nsteps;
 242         unsigned int total;
 243         void *priv;
 244 };
 245
 246 /**
 247  * struct nand_ecc_engine_ops - ECC engine operations
 248  * @init_ctx: given a desired user configuration for the pointed NAND device,
 249  *            requests the ECC engine driver to setup a configuration with
 250  *            values it supports.
 251  * @cleanup_ctx: clean the context initialized by @init_ctx.
 252  * @prepare_io_req: is called before reading/writing a page to prepare the I/O
 253  *                  request to be performed with ECC correction.
 254  * @finish_io_req: is called after reading/writing a page to terminate the I/O
 255  *                 request and ensure proper ECC correction.
 256  */
 257 struct nand_ecc_engine_ops {
 258         int (*init_ctx)(struct nand_device *nand);
 259         void (*cleanup_ctx)(struct nand_device *nand);
 260         int (*prepare_io_req)(struct nand_device *nand,
 261                               struct nand_page_io_req *req);
 262         int (*finish_io_req)(struct nand_device *nand,
 263                              struct nand_page_io_req *req);
 264 };
 265
 266 /**
 267  * enum nand_ecc_engine_integration - How the NAND ECC engine is integrated
 268  * @NAND_ECC_ENGINE_INTEGRATION_INVALID: Invalid value
 269  * @NAND_ECC_ENGINE_INTEGRATION_PIPELINED: Pipelined engine, performs on-the-fly
 270  *                                         correction, does not need to copy
 271  *                                         data around
 272  * @NAND_ECC_ENGINE_INTEGRATION_EXTERNAL: External engine, needs to bring the
 273  *                                        data into its own area before use
 274  */
 275 enum nand_ecc_engine_integration {
 276         NAND_ECC_ENGINE_INTEGRATION_INVALID,
 277         NAND_ECC_ENGINE_INTEGRATION_PIPELINED,
 278         NAND_ECC_ENGINE_INTEGRATION_EXTERNAL,
 279 };
 280
 281 /**
 282  * struct nand_ecc_engine - ECC engine abstraction for NAND devices
 283  * @dev: Host device
 284  * @node: Private field for registration time
 285  * @ops: ECC engine operations
 286  * @integration: How the engine is integrated with the host
 287  *               (only relevant on %NAND_ECC_ENGINE_TYPE_ON_HOST engines)
 288  * @priv: Private data
 289  */
 290 struct nand_ecc_engine {
 291         struct device *dev;
 292         struct list_head node;
 293         struct nand_ecc_engine_ops *ops;
 294         enum nand_ecc_engine_integration integration;
 295         void *priv;
 296 };
 297
 298 void of_get_nand_ecc_user_config(struct nand_device *nand);
 299 int nand_ecc_init_ctx(struct nand_device *nand);
 300 void nand_ecc_cleanup_ctx(struct nand_device *nand);
 301 int nand_ecc_prepare_io_req(struct nand_device *nand,
 302                             struct nand_page_io_req *req);
 303 int nand_ecc_finish_io_req(struct nand_device *nand,
 304                            struct nand_page_io_req *req);
 305 bool nand_ecc_is_strong_enough(struct nand_device *nand);
 306 int nand_ecc_register_on_host_hw_engine(struct nand_ecc_engine *engine);
 307 int nand_ecc_unregister_on_host_hw_engine(struct nand_ecc_engine *engine);
 308 struct nand_ecc_engine *nand_ecc_get_sw_engine(struct nand_device *nand);
 309 struct nand_ecc_engine *nand_ecc_get_on_die_hw_engine(struct nand_device *nand);
 310 struct nand_ecc_engine *nand_ecc_get_on_host_hw_engine(struct nand_device *nand);
 311 void nand_ecc_put_on_host_hw_engine(struct nand_device *nand);
 312
 313 #if IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_HAMMING)
 314 struct nand_ecc_engine *nand_ecc_sw_hamming_get_engine(void);
 315 #else
 316 static inline struct nand_ecc_engine *nand_ecc_sw_hamming_get_engine(void)
 317 {
 318         return NULL;
 319 }
 320 #endif /* CONFIG_MTD_NAND_ECC_SW_HAMMING */
 321
 322 #if IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_BCH)
 323 struct nand_ecc_engine *nand_ecc_sw_bch_get_engine(void);
 324 #else
 325 static inline struct nand_ecc_engine *nand_ecc_sw_bch_get_engine(void)
 326 {
 327         return NULL;
 328 }
 329 #endif /* CONFIG_MTD_NAND_ECC_SW_BCH */
 330
 331 /**
 332  * struct nand_ecc_req_tweak_ctx - Help for automatically tweaking requests
 333  * @orig_req: Pointer to the original IO request
 334  * @nand: Related NAND device, to have access to its memory organization
 335  * @page_buffer_size: Real size of the page buffer to use (can be set by the
 336  *                    user before the tweaking mechanism initialization)
 337  * @oob_buffer_size: Real size of the OOB buffer to use (can be set by the
 338  *                   user before the tweaking mechanism initialization)
 339  * @spare_databuf: Data bounce buffer
 340  * @spare_oobbuf: OOB bounce buffer
 341  * @bounce_data: Flag indicating a data bounce buffer is used
 342  * @bounce_oob: Flag indicating an OOB bounce buffer is used
 343  */
 344 struct nand_ecc_req_tweak_ctx {
 345         struct nand_page_io_req orig_req;
 346         struct nand_device *nand;
 347         unsigned int page_buffer_size;
 348         unsigned int oob_buffer_size;
 349         void *spare_databuf;
 350         void *spare_oobbuf;
 351         bool bounce_data;
 352         bool bounce_oob;
 353 };
 354
 355 int nand_ecc_init_req_tweaking(struct nand_ecc_req_tweak_ctx *ctx,
 356                                struct nand_device *nand);
 357 void nand_ecc_cleanup_req_tweaking(struct nand_ecc_req_tweak_ctx *ctx);
 358 void nand_ecc_tweak_req(struct nand_ecc_req_tweak_ctx *ctx,
 359                         struct nand_page_io_req *req);
 360 void nand_ecc_restore_req(struct nand_ecc_req_tweak_ctx *ctx,
 361                           struct nand_page_io_req *req);
 362
 363 /**
 364  * struct nand_ecc - Information relative to the ECC
 365  * @defaults: Default values, depend on the underlying subsystem
 366  * @requirements: ECC requirements from the NAND chip perspective
 367  * @user_conf: User desires in terms of ECC parameters
 368  * @ctx: ECC context for the ECC engine, derived from the device @requirements
 369  *       the @user_conf and the @defaults
 370  * @ondie_engine: On-die ECC engine reference, if any
 371  * @engine: ECC engine actually bound
 372  */
 373 struct nand_ecc {
 374         struct nand_ecc_props defaults;
 375         struct nand_ecc_props requirements;
 376         struct nand_ecc_props user_conf;
 377         struct nand_ecc_context ctx;
 378         struct nand_ecc_engine *ondie_engine;
 379         struct nand_ecc_engine *engine;
 380 };
 381
 382 /**
 383  * struct nand_device - NAND device
 384  * @mtd: MTD instance attached to the NAND device
 385  * @memorg: memory layout
 386  * @ecc: NAND ECC object attached to the NAND device
 387  * @rowconv: position to row address converter
 388  * @bbt: bad block table info
 389  * @ops: NAND operations attached to the NAND device
 390  *
 391  * Generic NAND object. Specialized NAND layers (raw NAND, SPI NAND, OneNAND)
 392  * should declare their own NAND object embedding a nand_device struct (that's
 393  * how inheritance is done).
 394  * struct_nand_device->memorg and struct_nand_device->ecc.requirements should
 395  * be filled at device detection time to reflect the NAND device
 396  * capabilities/requirements. Once this is done nanddev_init() can be called.
 397  * It will take care of converting NAND information into MTD ones, which means
 398  * the specialized NAND layers should never manually tweak
 399  * struct_nand_device->mtd except for the ->_read/write() hooks.
 400  */
 401 struct nand_device {
 402         struct mtd_info mtd;
 403         struct nand_memory_organization memorg;
 404         struct nand_ecc ecc;
 405         struct nand_row_converter rowconv;
 406         struct nand_bbt bbt;
 407         const struct nand_ops *ops;
 408 };
 409
 410 /**
 411  * struct nand_io_iter - NAND I/O iterator
 412  * @req: current I/O request
 413  * @oobbytes_per_page: maximum number of OOB bytes per page
 414  * @dataleft: remaining number of data bytes to read/write
 415  * @oobleft: remaining number of OOB bytes to read/write
 416  *
 417  * Can be used by specialized NAND layers to iterate over all pages covered
 418  * by an MTD I/O request, which should greatly simplifies the boiler-plate
 419  * code needed to read/write data from/to a NAND device.
 420  */
 421 struct nand_io_iter {
 422         struct nand_page_io_req req;
 423         unsigned int oobbytes_per_page;
 424         unsigned int dataleft;
 425         unsigned int oobleft;
 426 };
 427
 428 /**
 429  * mtd_to_nanddev() - Get the NAND device attached to the MTD instance
 430  * @mtd: MTD instance
 431  *
 432  * Return: the NAND device embedding @mtd.
 433  */
 434 static inline struct nand_device *mtd_to_nanddev(struct mtd_info *mtd)
 435 {
 436         return container_of(mtd, struct nand_device, mtd);
 437 }
 438
 439 /**
 440  * nanddev_to_mtd() - Get the MTD device attached to a NAND device
 441  * @nand: NAND device
 442  *
 443  * Return: the MTD device embedded in @nand.
 444  */
 445 static inline struct mtd_info *nanddev_to_mtd(struct nand_device *nand)
 446 {
 447         return &nand->mtd;
 448 }
 449
 450 /*
 451  * nanddev_bits_per_cell() - Get the number of bits per cell
 452  * @nand: NAND device
 453  *
 454  * Return: the number of bits per cell.
 455  */
 456 static inline unsigned int nanddev_bits_per_cell(const struct nand_device *nand)
 457 {
 458         return nand->memorg.bits_per_cell;
 459 }
 460
 461 /**
 462  * nanddev_page_size() - Get NAND page size
 463  * @nand: NAND device
 464  *
 465  * Return: the page size.
 466  */
 467 static inline size_t nanddev_page_size(const struct nand_device *nand)
 468 {
 469         return nand->memorg.pagesize;
 470 }
 471
 472 /**
 473  * nanddev_per_page_oobsize() - Get NAND OOB size
 474  * @nand: NAND device
 475  *
 476  * Return: the OOB size.
 477  */
 478 static inline unsigned int
 479 nanddev_per_page_oobsize(const struct nand_device *nand)
 480 {
 481         return nand->memorg.oobsize;
 482 }
 483
 484 /**
 485  * nanddev_pages_per_eraseblock() - Get the number of pages per eraseblock
 486  * @nand: NAND device
 487  *
 488  * Return: the number of pages per eraseblock.
 489  */
 490 static inline unsigned int
 491 nanddev_pages_per_eraseblock(const struct nand_device *nand)
 492 {
 493         return nand->memorg.pages_per_eraseblock;
 494 }
 495
 496 /**
 497  * nanddev_pages_per_target() - Get the number of pages per target
 498  * @nand: NAND device
 499  *
 500  * Return: the number of pages per target.
 501  */
 502 static inline unsigned int
 503 nanddev_pages_per_target(const struct nand_device *nand)
 504 {
 505         return nand->memorg.pages_per_eraseblock *
 506                nand->memorg.eraseblocks_per_lun *
 507                nand->memorg.luns_per_target;
 508 }
 509
 510 /**
 511  * nanddev_per_page_oobsize() - Get NAND erase block size
 512  * @nand: NAND device
 513  *
 514  * Return: the eraseblock size.
 515  */
 516 static inline size_t nanddev_eraseblock_size(const struct nand_device *nand)
 517 {
 518         return nand->memorg.pagesize * nand->memorg.pages_per_eraseblock;
 519 }
 520
 521 /**
 522  * nanddev_eraseblocks_per_lun() - Get the number of eraseblocks per LUN
 523  * @nand: NAND device
 524  *
 525  * Return: the number of eraseblocks per LUN.
 526  */
 527 static inline unsigned int
 528 nanddev_eraseblocks_per_lun(const struct nand_device *nand)
 529 {
 530         return nand->memorg.eraseblocks_per_lun;
 531 }
 532
 533 /**
 534  * nanddev_eraseblocks_per_target() - Get the number of eraseblocks per target
 535  * @nand: NAND device
 536  *
 537  * Return: the number of eraseblocks per target.
 538  */
 539 static inline unsigned int
 540 nanddev_eraseblocks_per_target(const struct nand_device *nand)
 541 {
 542         return nand->memorg.eraseblocks_per_lun * nand->memorg.luns_per_target;
 543 }
 544
 545 /**
 546  * nanddev_target_size() - Get the total size provided by a single target/die
 547  * @nand: NAND device
 548  *
 549  * Return: the total size exposed by a single target/die in bytes.
 550  */
 551 static inline u64 nanddev_target_size(const struct nand_device *nand)
 552 {
 553         return (u64)nand->memorg.luns_per_target *
 554                nand->memorg.eraseblocks_per_lun *
 555                nand->memorg.pages_per_eraseblock *
 556                nand->memorg.pagesize;
 557 }
 558
 559 /**
 560  * nanddev_ntarget() - Get the total of targets
 561  * @nand: NAND device
 562  *
 563  * Return: the number of targets/dies exposed by @nand.
 564  */
 565 static inline unsigned int nanddev_ntargets(const struct nand_device *nand)
 566 {
 567         return nand->memorg.ntargets;
 568 }
 569
 570 /**
 571  * nanddev_neraseblocks() - Get the total number of eraseblocks
 572  * @nand: NAND device
 573  *
 574  * Return: the total number of eraseblocks exposed by @nand.
 575  */
 576 static inline unsigned int nanddev_neraseblocks(const struct nand_device *nand)
 577 {
 578         return nand->memorg.ntargets * nand->memorg.luns_per_target *
 579                nand->memorg.eraseblocks_per_lun;
 580 }
 581
 582 /**
 583  * nanddev_size() - Get NAND size
 584  * @nand: NAND device
 585  *
 586  * Return: the total size (in bytes) exposed by @nand.
 587  */
 588 static inline u64 nanddev_size(const struct nand_device *nand)
 589 {
 590         return nanddev_target_size(nand) * nanddev_ntargets(nand);
 591 }
 592
 593 /**
 594  * nanddev_get_memorg() - Extract memory organization info from a NAND device
 595  * @nand: NAND device
 596  *
 597  * This can be used by the upper layer to fill the memorg info before calling
 598  * nanddev_init().
 599  *
 600  * Return: the memorg object embedded in the NAND device.
 601  */
 602 static inline struct nand_memory_organization *
 603 nanddev_get_memorg(struct nand_device *nand)
 604 {
 605         return &nand->memorg;
 606 }
 607
 608 /**
 609  * nanddev_get_ecc_conf() - Extract the ECC configuration from a NAND device
 610  * @nand: NAND device
 611  */
 612 static inline const struct nand_ecc_props *
 613 nanddev_get_ecc_conf(struct nand_device *nand)
 614 {
 615         return &nand->ecc.ctx.conf;
 616 }
 617
 618 /**
 619  * nanddev_get_ecc_nsteps() - Extract the number of ECC steps
 620  * @nand: NAND device
 621  */
 622 static inline unsigned int
 623 nanddev_get_ecc_nsteps(struct nand_device *nand)
 624 {
 625         return nand->ecc.ctx.nsteps;
 626 }
 627
 628 /**
 629  * nanddev_get_ecc_bytes_per_step() - Extract the number of ECC bytes per step
 630  * @nand: NAND device
 631  */
 632 static inline unsigned int
 633 nanddev_get_ecc_bytes_per_step(struct nand_device *nand)
 634 {
 635         return nand->ecc.ctx.total / nand->ecc.ctx.nsteps;
 636 }
 637
 638 /**
 639  * nanddev_get_ecc_requirements() - Extract the ECC requirements from a NAND
 640  *                                  device
 641  * @nand: NAND device
 642  */
 643 static inline const struct nand_ecc_props *
 644 nanddev_get_ecc_requirements(struct nand_device *nand)
 645 {
 646         return &nand->ecc.requirements;
 647 }
 648
 649 /**
 650  * nanddev_set_ecc_requirements() - Assign the ECC requirements of a NAND
 651  *                                  device
 652  * @nand: NAND device
 653  * @reqs: Requirements
 654  */
 655 static inline void
 656 nanddev_set_ecc_requirements(struct nand_device *nand,
 657                              const struct nand_ecc_props *reqs)
 658 {
 659         nand->ecc.requirements = *reqs;
 660 }
 661
 662 int nanddev_init(struct nand_device *nand, const struct nand_ops *ops,
 663                  struct module *owner);
 664 void nanddev_cleanup(struct nand_device *nand);
 665
 666 /**
 667  * nanddev_register() - Register a NAND device
 668  * @nand: NAND device
 669  *
 670  * Register a NAND device.
 671  * This function is just a wrapper around mtd_device_register()
 672  * registering the MTD device embedded in @nand.
 673  *
 674  * Return: 0 in case of success, a negative error code otherwise.
 675  */
 676 static inline int nanddev_register(struct nand_device *nand)
 677 {
 678         return mtd_device_register(&nand->mtd, NULL, 0);
 679 }
 680
 681 /**
 682  * nanddev_unregister() - Unregister a NAND device
 683  * @nand: NAND device
 684  *
 685  * Unregister a NAND device.
 686  * This function is just a wrapper around mtd_device_unregister()
 687  * unregistering the MTD device embedded in @nand.
 688  *
 689  * Return: 0 in case of success, a negative error code otherwise.
 690  */
 691 static inline int nanddev_unregister(struct nand_device *nand)
 692 {
 693         return mtd_device_unregister(&nand->mtd);
 694 }
 695
 696 /**
 697  * nanddev_set_of_node() - Attach a DT node to a NAND device
 698  * @nand: NAND device
 699  * @np: DT node
 700  *
 701  * Attach a DT node to a NAND device.
 702  */
 703 static inline void nanddev_set_of_node(struct nand_device *nand,
 704                                        struct device_node *np)
 705 {
 706         mtd_set_of_node(&nand->mtd, np);
 707 }
 708
 709 /**
 710  * nanddev_get_of_node() - Retrieve the DT node attached to a NAND device
 711  * @nand: NAND device
 712  *
 713  * Return: the DT node attached to @nand.
 714  */
 715 static inline struct device_node *nanddev_get_of_node(struct nand_device *nand)
 716 {
 717         return mtd_get_of_node(&nand->mtd);
 718 }
 719
 720 /**
 721  * nanddev_offs_to_pos() - Convert an absolute NAND offset into a NAND position
 722  * @nand: NAND device
 723  * @offs: absolute NAND offset (usually passed by the MTD layer)
 724  * @pos: a NAND position object to fill in
 725  *
 726  * Converts @offs into a nand_pos representation.
 727  *
 728  * Return: the offset within the NAND page pointed by @pos.
 729  */
 730 static inline unsigned int nanddev_offs_to_pos(struct nand_device *nand,
 731                                                loff_t offs,
 732                                                struct nand_pos *pos)
 733 {
 734         unsigned int pageoffs;
 735         u64 tmp = offs;
 736
 737         pageoffs = do_div(tmp, nand->memorg.pagesize);
 738         pos->page = do_div(tmp, nand->memorg.pages_per_eraseblock);
 739         pos->eraseblock = do_div(tmp, nand->memorg.eraseblocks_per_lun);
 740         pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;
 741         pos->lun = do_div(tmp, nand->memorg.luns_per_target);
 742         pos->target = tmp;
 743
 744         return pageoffs;
 745 }
 746
 747 /**
 748  * nanddev_pos_cmp() - Compare two NAND positions
 749  * @a: First NAND position
 750  * @b: Second NAND position
 751  *
 752  * Compares two NAND positions.
 753  *
 754  * Return: -1 if @a < @b, 0 if @a == @b and 1 if @a > @b.
 755  */
 756 static inline int nanddev_pos_cmp(const struct nand_pos *a,
 757                                   const struct nand_pos *b)
 758 {
 759         if (a->target != b->target)
 760                 return a->target < b->target ? -1 : 1;
 761
 762         if (a->lun != b->lun)
 763                 return a->lun < b->lun ? -1 : 1;
 764
 765         if (a->eraseblock != b->eraseblock)
 766                 return a->eraseblock < b->eraseblock ? -1 : 1;
 767
 768         if (a->page != b->page)
 769                 return a->page < b->page ? -1 : 1;
 770
 771         return 0;
 772 }
 773
 774 /**
 775  * nanddev_pos_to_offs() - Convert a NAND position into an absolute offset
 776  * @nand: NAND device
 777  * @pos: the NAND position to convert
 778  *
 779  * Converts @pos NAND position into an absolute offset.
 780  *
 781  * Return: the absolute offset. Note that @pos points to the beginning of a
 782  *         page, if one wants to point to a specific offset within this page
 783  *         the returned offset has to be adjusted manually.
 784  */
 785 static inline loff_t nanddev_pos_to_offs(struct nand_device *nand,
 786                                          const struct nand_pos *pos)
 787 {
 788         unsigned int npages;
 789
 790         npages = pos->page +
 791                  ((pos->eraseblock +
 792                    (pos->lun +
 793                     (pos->target * nand->memorg.luns_per_target)) *
 794                    nand->memorg.eraseblocks_per_lun) *
 795                   nand->memorg.pages_per_eraseblock);
 796
 797         return (loff_t)npages * nand->memorg.pagesize;
 798 }
 799
 800 /**
 801  * nanddev_pos_to_row() - Extract a row address from a NAND position
 802  * @nand: NAND device
 803  * @pos: the position to convert
 804  *
 805  * Converts a NAND position into a row address that can then be passed to the
 806  * device.
 807  *
 808  * Return: the row address extracted from @pos.
 809  */
 810 static inline unsigned int nanddev_pos_to_row(struct nand_device *nand,
 811                                               const struct nand_pos *pos)
 812 {
 813         return (pos->lun << nand->rowconv.lun_addr_shift) |
 814                (pos->eraseblock << nand->rowconv.eraseblock_addr_shift) |
 815                pos->page;
 816 }
 817
 818 /**
 819  * nanddev_pos_next_target() - Move a position to the next target/die
 820  * @nand: NAND device
 821  * @pos: the position to update
 822  *
 823  * Updates @pos to point to the start of the next target/die. Useful when you
 824  * want to iterate over all targets/dies of a NAND device.
 825  */
 826 static inline void nanddev_pos_next_target(struct nand_device *nand,
 827                                            struct nand_pos *pos)
 828 {
 829         pos->page = 0;
 830         pos->plane = 0;
 831         pos->eraseblock = 0;
 832         pos->lun = 0;
 833         pos->target++;
 834 }
 835
 836 /**
 837  * nanddev_pos_next_lun() - Move a position to the next LUN
 838  * @nand: NAND device
 839  * @pos: the position to update
 840  *
 841  * Updates @pos to point to the start of the next LUN. Useful when you want to
 842  * iterate over all LUNs of a NAND device.
 843  */
 844 static inline void nanddev_pos_next_lun(struct nand_device *nand,
 845                                         struct nand_pos *pos)
 846 {
 847         if (pos->lun >= nand->memorg.luns_per_target - 1)
 848                 return nanddev_pos_next_target(nand, pos);
 849
 850         pos->lun++;
 851         pos->page = 0;
 852         pos->plane = 0;
 853         pos->eraseblock = 0;
 854 }
 855
 856 /**
 857  * nanddev_pos_next_eraseblock() - Move a position to the next eraseblock
 858  * @nand: NAND device
 859  * @pos: the position to update
 860  *
 861  * Updates @pos to point to the start of the next eraseblock. Useful when you
 862  * want to iterate over all eraseblocks of a NAND device.
 863  */
 864 static inline void nanddev_pos_next_eraseblock(struct nand_device *nand,
 865                                                struct nand_pos *pos)
 866 {
 867         if (pos->eraseblock >= nand->memorg.eraseblocks_per_lun - 1)
 868                 return nanddev_pos_next_lun(nand, pos);
 869
 870         pos->eraseblock++;
 871         pos->page = 0;
 872         pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;
 873 }
 874
 875 /**
 876  * nanddev_pos_next_page() - Move a position to the next page
 877  * @nand: NAND device
 878  * @pos: the position to update
 879  *
 880  * Updates @pos to point to the start of the next page. Useful when you want to
 881  * iterate over all pages of a NAND device.
 882  */
 883 static inline void nanddev_pos_next_page(struct nand_device *nand,
 884                                          struct nand_pos *pos)
 885 {
 886         if (pos->page >= nand->memorg.pages_per_eraseblock - 1)
 887                 return nanddev_pos_next_eraseblock(nand, pos);
 888
 889         pos->page++;
 890 }
 891
 892 /**
 893  * nand_io_iter_init - Initialize a NAND I/O iterator
 894  * @nand: NAND device
 895  * @offs: absolute offset
 896  * @req: MTD request
 897  * @iter: NAND I/O iterator
 898  *
 899  * Initializes a NAND iterator based on the information passed by the MTD
 900  * layer.
 901  */
 902 static inline void nanddev_io_iter_init(struct nand_device *nand,
 903                                         enum nand_page_io_req_type reqtype,
 904                                         loff_t offs, struct mtd_oob_ops *req,
 905                                         struct nand_io_iter *iter)
 906 {
 907         struct mtd_info *mtd = nanddev_to_mtd(nand);
 908
 909         iter->req.type = reqtype;
 910         iter->req.mode = req->mode;
 911         iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos);
 912         iter->req.ooboffs = req->ooboffs;
 913         iter->oobbytes_per_page = mtd_oobavail(mtd, req);
 914         iter->dataleft = req->len;
 915         iter->oobleft = req->ooblen;
 916         iter->req.databuf.in = req->datbuf;
 917         iter->req.datalen = min_t(unsigned int,
 918                                   nand->memorg.pagesize - iter->req.dataoffs,
 919                                   iter->dataleft);
 920         iter->req.oobbuf.in = req->oobbuf;
 921         iter->req.ooblen = min_t(unsigned int,
 922                                  iter->oobbytes_per_page - iter->req.ooboffs,
 923                                  iter->oobleft);
 924 }
 925
 926 /**
 927  * nand_io_iter_next_page - Move to the next page
 928  * @nand: NAND device
 929  * @iter: NAND I/O iterator
 930  *
 931  * Updates the @iter to point to the next page.
 932  */
 933 static inline void nanddev_io_iter_next_page(struct nand_device *nand,
 934                                              struct nand_io_iter *iter)
 935 {
 936         nanddev_pos_next_page(nand, &iter->req.pos);
 937         iter->dataleft -= iter->req.datalen;
 938         iter->req.databuf.in += iter->req.datalen;
 939         iter->oobleft -= iter->req.ooblen;
 940         iter->req.oobbuf.in += iter->req.ooblen;
 941         iter->req.dataoffs = 0;
 942         iter->req.ooboffs = 0;
 943         iter->req.datalen = min_t(unsigned int, nand->memorg.pagesize,
 944                                   iter->dataleft);
 945         iter->req.ooblen = min_t(unsigned int, iter->oobbytes_per_page,
 946                                  iter->oobleft);
 947 }
 948
 949 /**
 950  * nand_io_iter_end - Should end iteration or not
 951  * @nand: NAND device
 952  * @iter: NAND I/O iterator
 953  *
 954  * Check whether @iter has reached the end of the NAND portion it was asked to
 955  * iterate on or not.
 956  *
 957  * Return: true if @iter has reached the end of the iteration request, false
 958  *         otherwise.
 959  */
 960 static inline bool nanddev_io_iter_end(struct nand_device *nand,
 961                                        const struct nand_io_iter *iter)
 962 {
 963         if (iter->dataleft || iter->oobleft)
 964                 return false;
 965
 966         return true;
 967 }
 968
 969 /**
 970  * nand_io_for_each_page - Iterate over all NAND pages contained in an MTD I/O
 971  *                         request
 972  * @nand: NAND device
 973  * @start: start address to read/write from
 974  * @req: MTD I/O request
 975  * @iter: NAND I/O iterator
 976  *
 977  * Should be used for iterate over pages that are contained in an MTD request.
 978  */
 979 #define nanddev_io_for_each_page(nand, type, start, req, iter)          \
 980         for (nanddev_io_iter_init(nand, type, start, req, iter);        \
 981              !nanddev_io_iter_end(nand, iter);                          \
 982              nanddev_io_iter_next_page(nand, iter))
 983
 984 bool nanddev_isbad(struct nand_device *nand, const struct nand_pos *pos);
 985 bool nanddev_isreserved(struct nand_device *nand, const struct nand_pos *pos);
 986 int nanddev_erase(struct nand_device *nand, const struct nand_pos *pos);
 987 int nanddev_markbad(struct nand_device *nand, const struct nand_pos *pos);
 988
 989 /* ECC related functions */
 990 int nanddev_ecc_engine_init(struct nand_device *nand);
 991 void nanddev_ecc_engine_cleanup(struct nand_device *nand);
 992
 993 static inline void *nand_to_ecc_ctx(struct nand_device *nand)
 994 {
 995         return nand->ecc.ctx.priv;
 996 }
 997
 998 /* BBT related functions */
 999 enum nand_bbt_block_status {
1000         NAND_BBT_BLOCK_STATUS_UNKNOWN,
1001         NAND_BBT_BLOCK_GOOD,
1002         NAND_BBT_BLOCK_WORN,
1003         NAND_BBT_BLOCK_RESERVED,
1004         NAND_BBT_BLOCK_FACTORY_BAD,
1005         NAND_BBT_BLOCK_NUM_STATUS,
1006 };
1007
1008 int nanddev_bbt_init(struct nand_device *nand);
1009 void nanddev_bbt_cleanup(struct nand_device *nand);
1010 int nanddev_bbt_update(struct nand_device *nand);
1011 int nanddev_bbt_get_block_status(const struct nand_device *nand,
1012                                  unsigned int entry);
1013 int nanddev_bbt_set_block_status(struct nand_device *nand, unsigned int entry,
1014                                  enum nand_bbt_block_status status);
1015 int nanddev_bbt_markbad(struct nand_device *nand, unsigned int block);
1016
1017 /**
1018  * nanddev_bbt_pos_to_entry() - Convert a NAND position into a BBT entry
1019  * @nand: NAND device
1020  * @pos: the NAND position we want to get BBT entry for
1021  *
1022  * Return the BBT entry used to store information about the eraseblock pointed
1023  * by @pos.
1024  *
1025  * Return: the BBT entry storing information about eraseblock pointed by @pos.
1026  */
1027 static inline unsigned int nanddev_bbt_pos_to_entry(struct nand_device *nand,
1028                                                     const struct nand_pos *pos)
1029 {
1030         return pos->eraseblock +
1031                ((pos->lun + (pos->target * nand->memorg.luns_per_target)) *
1032                 nand->memorg.eraseblocks_per_lun);
1033 }
1034
1035 /**
1036  * nanddev_bbt_is_initialized() - Check if the BBT has been initialized
1037  * @nand: NAND device
1038  *
1039  * Return: true if the BBT has been initialized, false otherwise.
1040  */
1041 static inline bool nanddev_bbt_is_initialized(struct nand_device *nand)
1042 {
1043         return !!nand->bbt.cache;
1044 }
1045
1046 /* MTD -> NAND helper functions. */
1047 int nanddev_mtd_erase(struct mtd_info *mtd, struct erase_info *einfo);
1048 int nanddev_mtd_max_bad_blocks(struct mtd_info *mtd, loff_t offs, size_t len);
1049
1050 #endif /* __LINUX_MTD_NAND_H */