1 /* SPDX-License-Identifier: GPL-2.0 */
3  *  Copyright 2017 - Free Electrons
6  *	Boris Brezillon <boris.brezillon@free-electrons.com>
18  * struct nand_memory_organization - Memory organization structure
55  * struct nand_row_converter - Information needed to convert an absolute offset
67  * struct nand_pos - NAND position object
74  * These information are usually used by specific sub-layers to select the
86  * enum nand_page_io_req_type - Direction of an I/O request
96  * struct nand_page_io_req - NAND I/O request object
107  * This object is used to pass per-page I/O requests to NAND sub-layers. This
109  * specific NAND layers can focus on translating these information into
110  * specific commands/operations.
135  * enum nand_ecc_engine_type - NAND ECC engine type
151  * enum nand_ecc_placement - NAND ECC bytes placement
165  * enum nand_ecc_algo - NAND ECC algorithm
168  * @NAND_ECC_ALGO_BCH: Bose-Chaudhuri-Hocquenghem algorithm
169  * @NAND_ECC_ALGO_RS: Reed-Solomon algorithm
179  * struct nand_ecc_props - NAND ECC properties
180  * @engine_type: ECC engine type
202  * struct nand_bbt - bad block table object
210  * struct nand_ops - NAND operations
211  * @erase: erase a specific block. No need to check if the block is bad before
213  * @markbad: mark a specific block bad. No need to check if the block is
216  *	     Marker) so that future call to struct_nand_ops->isbad() return
232  * struct nand_ecc_context - Context for the ECC engine
233  * @conf: basic ECC engine parameters
237  * @priv: ECC engine driver private data
247  * struct nand_ecc_engine_ops - ECC engine operations
249  *            requests the ECC engine driver to setup a configuration with
267  * enum nand_ecc_engine_integration - How the NAND ECC engine is integrated
269  * @NAND_ECC_ENGINE_INTEGRATION_PIPELINED: Pipelined engine, performs on-the-fly
272  * @NAND_ECC_ENGINE_INTEGRATION_EXTERNAL: External engine, needs to bring the
282  * struct nand_ecc_engine - ECC engine abstraction for NAND devices
285  * @ops: ECC engine operations
286  * @integration: How the engine is integrated with the host
308 int nand_ecc_register_on_host_hw_engine(struct nand_ecc_engine *engine);
309 int nand_ecc_unregister_on_host_hw_engine(struct nand_ecc_engine *engine);
312 nand_ecc_register_on_host_hw_engine(struct nand_ecc_engine *engine)  in nand_ecc_register_on_host_hw_engine()  argument
314 	return -ENOTSUPP;  in nand_ecc_register_on_host_hw_engine()
317 nand_ecc_unregister_on_host_hw_engine(struct nand_ecc_engine *engine)  in nand_ecc_unregister_on_host_hw_engine()  argument
319 	return -ENOTSUPP;  in nand_ecc_unregister_on_host_hw_engine()
348  * struct nand_ecc_req_tweak_ctx - Help for automatically tweaking requests
380  * struct nand_ecc - Information relative to the ECC
384  * @ctx: ECC context for the ECC engine, derived from the device @requirements
386  * @ondie_engine: On-die ECC engine reference, if any
387  * @engine: ECC engine actually bound
395 	struct nand_ecc_engine *engine;  member
399  * struct nand_device - NAND device
410  * struct_nand_device->memorg and struct_nand_device->ecc.requirements should
415  * struct_nand_device->mtd except for the ->_read/write() hooks.
427  * struct nand_io_iter - NAND I/O iterator
434  * by an MTD I/O request, which should greatly simplifies the boiler-plate
445  * mtd_to_nanddev() - Get the NAND device attached to the MTD instance
456  * nanddev_to_mtd() - Get the MTD device attached to a NAND device
463 	return &nand->mtd;  in nanddev_to_mtd()
467  * nanddev_bits_per_cell() - Get the number of bits per cell
474 	return nand->memorg.bits_per_cell;  in nanddev_bits_per_cell()
478  * nanddev_page_size() - Get NAND page size
485 	return nand->memorg.pagesize;  in nanddev_page_size()
489  * nanddev_per_page_oobsize() - Get NAND OOB size
497 	return nand->memorg.oobsize;  in nanddev_per_page_oobsize()
501  * nanddev_pages_per_eraseblock() - Get the number of pages per eraseblock
509 	return nand->memorg.pages_per_eraseblock;  in nanddev_pages_per_eraseblock()
513  * nanddev_pages_per_target() - Get the number of pages per target
521 	return nand->memorg.pages_per_eraseblock *  in nanddev_pages_per_target()
522 	       nand->memorg.eraseblocks_per_lun *  in nanddev_pages_per_target()
523 	       nand->memorg.luns_per_target;  in nanddev_pages_per_target()
527  * nanddev_per_page_oobsize() - Get NAND erase block size
534 	return nand->memorg.pagesize * nand->memorg.pages_per_eraseblock;  in nanddev_eraseblock_size()
538  * nanddev_eraseblocks_per_lun() - Get the number of eraseblocks per LUN
546 	return nand->memorg.eraseblocks_per_lun;  in nanddev_eraseblocks_per_lun()
550  * nanddev_eraseblocks_per_target() - Get the number of eraseblocks per target
558 	return nand->memorg.eraseblocks_per_lun * nand->memorg.luns_per_target;  in nanddev_eraseblocks_per_target()
562  * nanddev_target_size() - Get the total size provided by a single target/die
569 	return (u64)nand->memorg.luns_per_target *  in nanddev_target_size()
570 	       nand->memorg.eraseblocks_per_lun *  in nanddev_target_size()
571 	       nand->memorg.pages_per_eraseblock *  in nanddev_target_size()
572 	       nand->memorg.pagesize;  in nanddev_target_size()
576  * nanddev_ntarget() - Get the total of targets
583 	return nand->memorg.ntargets;  in nanddev_ntargets()
587  * nanddev_neraseblocks() - Get the total number of eraseblocks
594 	return nand->memorg.ntargets * nand->memorg.luns_per_target *  in nanddev_neraseblocks()
595 	       nand->memorg.eraseblocks_per_lun;  in nanddev_neraseblocks()
599  * nanddev_size() - Get NAND size
610  * nanddev_get_memorg() - Extract memory organization info from a NAND device
621 	return &nand->memorg;  in nanddev_get_memorg()
625  * nanddev_get_ecc_conf() - Extract the ECC configuration from a NAND device
631 	return &nand->ecc.ctx.conf;  in nanddev_get_ecc_conf()
635  * nanddev_get_ecc_nsteps() - Extract the number of ECC steps
641 	return nand->ecc.ctx.nsteps;  in nanddev_get_ecc_nsteps()
645  * nanddev_get_ecc_bytes_per_step() - Extract the number of ECC bytes per step
651 	return nand->ecc.ctx.total / nand->ecc.ctx.nsteps;  in nanddev_get_ecc_bytes_per_step()
655  * nanddev_get_ecc_requirements() - Extract the ECC requirements from a NAND
662 	return &nand->ecc.requirements;  in nanddev_get_ecc_requirements()
666  * nanddev_set_ecc_requirements() - Assign the ECC requirements of a NAND
675 	nand->ecc.requirements = *reqs;  in nanddev_set_ecc_requirements()
683  * nanddev_register() - Register a NAND device
694 	return mtd_device_register(&nand->mtd, NULL, 0);  in nanddev_register()
698  * nanddev_unregister() - Unregister a NAND device
709 	return mtd_device_unregister(&nand->mtd);  in nanddev_unregister()
713  * nanddev_set_of_node() - Attach a DT node to a NAND device
722 	mtd_set_of_node(&nand->mtd, np);  in nanddev_set_of_node()
726  * nanddev_get_of_node() - Retrieve the DT node attached to a NAND device
733 	return mtd_get_of_node(&nand->mtd);  in nanddev_get_of_node()
737  * nanddev_offs_to_pos() - Convert an absolute NAND offset into a NAND position
753 	pageoffs = do_div(tmp, nand->memorg.pagesize);  in nanddev_offs_to_pos()
754 	pos->page = do_div(tmp, nand->memorg.pages_per_eraseblock);  in nanddev_offs_to_pos()
755 	pos->eraseblock = do_div(tmp, nand->memorg.eraseblocks_per_lun);  in nanddev_offs_to_pos()
756 	pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;  in nanddev_offs_to_pos()
757 	pos->lun = do_div(tmp, nand->memorg.luns_per_target);  in nanddev_offs_to_pos()
758 	pos->target = tmp;  in nanddev_offs_to_pos()
764  * nanddev_pos_cmp() - Compare two NAND positions
770  * Return: -1 if @a < @b, 0 if @a == @b and 1 if @a > @b.
775 	if (a->target != b->target)  in nanddev_pos_cmp()
776 		return a->target < b->target ? -1 : 1;  in nanddev_pos_cmp()
778 	if (a->lun != b->lun)  in nanddev_pos_cmp()
779 		return a->lun < b->lun ? -1 : 1;  in nanddev_pos_cmp()
781 	if (a->eraseblock != b->eraseblock)  in nanddev_pos_cmp()
782 		return a->eraseblock < b->eraseblock ? -1 : 1;  in nanddev_pos_cmp()
784 	if (a->page != b->page)  in nanddev_pos_cmp()
785 		return a->page < b->page ? -1 : 1;  in nanddev_pos_cmp()
791  * nanddev_pos_to_offs() - Convert a NAND position into an absolute offset
798  *	   page, if one wants to point to a specific offset within this page
806 	npages = pos->page +  in nanddev_pos_to_offs()
807 		 ((pos->eraseblock +  in nanddev_pos_to_offs()
808 		   (pos->lun +  in nanddev_pos_to_offs()
809 		    (pos->target * nand->memorg.luns_per_target)) *  in nanddev_pos_to_offs()
810 		   nand->memorg.eraseblocks_per_lun) *  in nanddev_pos_to_offs()
811 		  nand->memorg.pages_per_eraseblock);  in nanddev_pos_to_offs()
813 	return (loff_t)npages * nand->memorg.pagesize;  in nanddev_pos_to_offs()
817  * nanddev_pos_to_row() - Extract a row address from a NAND position
829 	return (pos->lun << nand->rowconv.lun_addr_shift) |  in nanddev_pos_to_row()
830 	       (pos->eraseblock << nand->rowconv.eraseblock_addr_shift) |  in nanddev_pos_to_row()
831 	       pos->page;  in nanddev_pos_to_row()
835  * nanddev_pos_next_target() - Move a position to the next target/die
845 	pos->page = 0;  in nanddev_pos_next_target()
846 	pos->plane = 0;  in nanddev_pos_next_target()
847 	pos->eraseblock = 0;  in nanddev_pos_next_target()
848 	pos->lun = 0;  in nanddev_pos_next_target()
849 	pos->target++;  in nanddev_pos_next_target()
853  * nanddev_pos_next_lun() - Move a position to the next LUN
863 	if (pos->lun >= nand->memorg.luns_per_target - 1)  in nanddev_pos_next_lun()
866 	pos->lun++;  in nanddev_pos_next_lun()
867 	pos->page = 0;  in nanddev_pos_next_lun()
868 	pos->plane = 0;  in nanddev_pos_next_lun()
869 	pos->eraseblock = 0;  in nanddev_pos_next_lun()
873  * nanddev_pos_next_eraseblock() - Move a position to the next eraseblock
883 	if (pos->eraseblock >= nand->memorg.eraseblocks_per_lun - 1)  in nanddev_pos_next_eraseblock()
886 	pos->eraseblock++;  in nanddev_pos_next_eraseblock()
887 	pos->page = 0;  in nanddev_pos_next_eraseblock()
888 	pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;  in nanddev_pos_next_eraseblock()
892  * nanddev_pos_next_page() - Move a position to the next page
902 	if (pos->page >= nand->memorg.pages_per_eraseblock - 1)  in nanddev_pos_next_page()
905 	pos->page++;  in nanddev_pos_next_page()
909  * nand_io_iter_init - Initialize a NAND I/O iterator
925 	iter->req.type = reqtype;  in nanddev_io_iter_init()
926 	iter->req.mode = req->mode;  in nanddev_io_iter_init()
927 	iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos);  in nanddev_io_iter_init()
928 	iter->req.ooboffs = req->ooboffs;  in nanddev_io_iter_init()
929 	iter->oobbytes_per_page = mtd_oobavail(mtd, req);  in nanddev_io_iter_init()
930 	iter->dataleft = req->len;  in nanddev_io_iter_init()
931 	iter->oobleft = req->ooblen;  in nanddev_io_iter_init()
932 	iter->req.databuf.in = req->datbuf;  in nanddev_io_iter_init()
933 	iter->req.datalen = min_t(unsigned int,  in nanddev_io_iter_init()
934 				  nand->memorg.pagesize - iter->req.dataoffs,  in nanddev_io_iter_init()
935 				  iter->dataleft);  in nanddev_io_iter_init()
936 	iter->req.oobbuf.in = req->oobbuf;  in nanddev_io_iter_init()
937 	iter->req.ooblen = min_t(unsigned int,  in nanddev_io_iter_init()
938 				 iter->oobbytes_per_page - iter->req.ooboffs,  in nanddev_io_iter_init()
939 				 iter->oobleft);  in nanddev_io_iter_init()
943  * nand_io_iter_next_page - Move to the next page
952 	nanddev_pos_next_page(nand, &iter->req.pos);  in nanddev_io_iter_next_page()
953 	iter->dataleft -= iter->req.datalen;  in nanddev_io_iter_next_page()
954 	iter->req.databuf.in += iter->req.datalen;  in nanddev_io_iter_next_page()
955 	iter->oobleft -= iter->req.ooblen;  in nanddev_io_iter_next_page()
956 	iter->req.oobbuf.in += iter->req.ooblen;  in nanddev_io_iter_next_page()
957 	iter->req.dataoffs = 0;  in nanddev_io_iter_next_page()
958 	iter->req.ooboffs = 0;  in nanddev_io_iter_next_page()
959 	iter->req.datalen = min_t(unsigned int, nand->memorg.pagesize,  in nanddev_io_iter_next_page()
960 				  iter->dataleft);  in nanddev_io_iter_next_page()
961 	iter->req.ooblen = min_t(unsigned int, iter->oobbytes_per_page,  in nanddev_io_iter_next_page()
962 				 iter->oobleft);  in nanddev_io_iter_next_page()
966  * nand_io_iter_end - Should end iteration or not
979 	if (iter->dataleft || iter->oobleft)  in nanddev_io_iter_end()
986  * nand_io_for_each_page - Iterate over all NAND pages contained in an MTD I/O
1011 	return nand->ecc.ctx.priv;  in nand_to_ecc_ctx()
1034  * nanddev_bbt_pos_to_entry() - Convert a NAND position into a BBT entry
1046 	return pos->eraseblock +  in nanddev_bbt_pos_to_entry()
1047 	       ((pos->lun + (pos->target * nand->memorg.luns_per_target)) *  in nanddev_bbt_pos_to_entry()
1048 		nand->memorg.eraseblocks_per_lun);  in nanddev_bbt_pos_to_entry()
1052  * nanddev_bbt_is_initialized() - Check if the BBT has been initialized
1059 	return !!nand->bbt.cache;  in nanddev_bbt_is_initialized()
1062 /* MTD -> NAND helper functions. */