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
19  * @bits_per_cell: number of bits per NAND cell
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
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
75  * appropriate target/die and generate a row address to pass to the device.
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
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
184  * @step_size: Number of bytes per step
202  * struct nand_bbt - bad block table object
210  * struct nand_ops - NAND operations
216  *	     Marker) so that future call to struct_nand_ops->isbad() return
232  * struct nand_ecc_context - Context for the ECC engine
247  * struct nand_ecc_engine_ops - ECC engine operations
248  * @init_ctx: given a desired user configuration for the pointed NAND device,
267  * struct nand_ecc_engine - ECC engine abstraction for NAND devices
304  * struct nand_ecc_req_tweak_ctx - Help for automatically tweaking requests
306  * @nand: Related NAND device, to have access to its memory organization
336  * struct nand_ecc - Information relative to the ECC
340  * @ctx: ECC context for the ECC engine, derived from the device @requirements
342  * @ondie_engine: On-die ECC engine reference, if any
355  * struct nand_device - NAND device
356  * @mtd: MTD instance attached to the NAND device
358  * @ecc: NAND ECC object attached to the NAND device
361  * @ops: NAND operations attached to the NAND device
366  * struct_nand_device->memorg and struct_nand_device->ecc.requirements should
367  * be filled at device detection time to reflect the NAND device
371  * struct_nand_device->mtd except for the ->_read/write() hooks.
383  * struct nand_io_iter - NAND I/O iterator
385  * @oobbytes_per_page: maximum number of OOB bytes per page
390  * by an MTD I/O request, which should greatly simplifies the boiler-plate
391  * code needed to read/write data from/to a NAND device.
401  * mtd_to_nanddev() - Get the NAND device attached to the MTD instance
404  * Return: the NAND device embedding @mtd.
412  * nanddev_to_mtd() - Get the MTD device attached to a NAND device
413  * @nand: NAND device
415  * Return: the MTD device embedded in @nand.
419 	return &nand->mtd;  in nanddev_to_mtd()
423  * nanddev_bits_per_cell() - Get the number of bits per cell
424  * @nand: NAND device
426  * Return: the number of bits per cell.
430 	return nand->memorg.bits_per_cell;  in nanddev_bits_per_cell()
434  * nanddev_page_size() - Get NAND page size
435  * @nand: NAND device
441 	return nand->memorg.pagesize;  in nanddev_page_size()
445  * nanddev_per_page_oobsize() - Get NAND OOB size
446  * @nand: NAND device
453 	return nand->memorg.oobsize;  in nanddev_per_page_oobsize()
457  * nanddev_pages_per_eraseblock() - Get the number of pages per eraseblock
458  * @nand: NAND device
460  * Return: the number of pages per eraseblock.
465 	return nand->memorg.pages_per_eraseblock;  in nanddev_pages_per_eraseblock()
469  * nanddev_pages_per_target() - Get the number of pages per target
470  * @nand: NAND device
472  * Return: the number of pages per target.
477 	return nand->memorg.pages_per_eraseblock *  in nanddev_pages_per_target()
478 	       nand->memorg.eraseblocks_per_lun *  in nanddev_pages_per_target()
479 	       nand->memorg.luns_per_target;  in nanddev_pages_per_target()
483  * nanddev_per_page_oobsize() - Get NAND erase block size
484  * @nand: NAND device
490 	return nand->memorg.pagesize * nand->memorg.pages_per_eraseblock;  in nanddev_eraseblock_size()
494  * nanddev_eraseblocks_per_lun() - Get the number of eraseblocks per LUN
495  * @nand: NAND device
497  * Return: the number of eraseblocks per LUN.
502 	return nand->memorg.eraseblocks_per_lun;  in nanddev_eraseblocks_per_lun()
506  * nanddev_eraseblocks_per_target() - Get the number of eraseblocks per target
507  * @nand: NAND device
509  * Return: the number of eraseblocks per target.
514 	return nand->memorg.eraseblocks_per_lun * nand->memorg.luns_per_target;  in nanddev_eraseblocks_per_target()
518  * nanddev_target_size() - Get the total size provided by a single target/die
519  * @nand: NAND device
525 	return (u64)nand->memorg.luns_per_target *  in nanddev_target_size()
526 	       nand->memorg.eraseblocks_per_lun *  in nanddev_target_size()
527 	       nand->memorg.pages_per_eraseblock *  in nanddev_target_size()
528 	       nand->memorg.pagesize;  in nanddev_target_size()
532  * nanddev_ntarget() - Get the total of targets
533  * @nand: NAND device
539 	return nand->memorg.ntargets;  in nanddev_ntargets()
543  * nanddev_neraseblocks() - Get the total number of eraseblocks
544  * @nand: NAND device
550 	return nand->memorg.ntargets * nand->memorg.luns_per_target *  in nanddev_neraseblocks()
551 	       nand->memorg.eraseblocks_per_lun;  in nanddev_neraseblocks()
555  * nanddev_size() - Get NAND size
556  * @nand: NAND device
566  * nanddev_get_memorg() - Extract memory organization info from a NAND device
567  * @nand: NAND device
572  * Return: the memorg object embedded in the NAND device.
577 	return &nand->memorg;  in nanddev_get_memorg()
581  * nanddev_get_ecc_conf() - Extract the ECC configuration from a NAND device
582  * @nand: NAND device
587 	return &nand->ecc.ctx.conf;  in nanddev_get_ecc_conf()
591  * nanddev_get_ecc_nsteps() - Extract the number of ECC steps
592  * @nand: NAND device
597 	return nand->ecc.ctx.nsteps;  in nanddev_get_ecc_nsteps()
601  * nanddev_get_ecc_bytes_per_step() - Extract the number of ECC bytes per step
602  * @nand: NAND device
607 	return nand->ecc.ctx.total / nand->ecc.ctx.nsteps;  in nanddev_get_ecc_bytes_per_step()
611  * nanddev_get_ecc_requirements() - Extract the ECC requirements from a NAND
612  *                                  device
613  * @nand: NAND device
618 	return &nand->ecc.requirements;  in nanddev_get_ecc_requirements()
622  * nanddev_set_ecc_requirements() - Assign the ECC requirements of a NAND
623  *                                  device
624  * @nand: NAND device
631 	nand->ecc.requirements = *reqs;  in nanddev_set_ecc_requirements()
639  * nanddev_register() - Register a NAND device
640  * @nand: NAND device
642  * Register a NAND device.
644  * registering the MTD device embedded in @nand.
650 	return mtd_device_register(&nand->mtd, NULL, 0);  in nanddev_register()
654  * nanddev_unregister() - Unregister a NAND device
655  * @nand: NAND device
657  * Unregister a NAND device.
659  * unregistering the MTD device embedded in @nand.
665 	return mtd_device_unregister(&nand->mtd);  in nanddev_unregister()
669  * nanddev_set_of_node() - Attach a DT node to a NAND device
670  * @nand: NAND device
673  * Attach a DT node to a NAND device.
678 	mtd_set_of_node(&nand->mtd, np);  in nanddev_set_of_node()
682  * nanddev_get_of_node() - Retrieve the DT node attached to a NAND device
683  * @nand: NAND device
689 	return mtd_get_of_node(&nand->mtd);  in nanddev_get_of_node()
693  * nanddev_offs_to_pos() - Convert an absolute NAND offset into a NAND position
694  * @nand: NAND device
709 	pageoffs = do_div(tmp, nand->memorg.pagesize);  in nanddev_offs_to_pos()
710 	pos->page = do_div(tmp, nand->memorg.pages_per_eraseblock);  in nanddev_offs_to_pos()
711 	pos->eraseblock = do_div(tmp, nand->memorg.eraseblocks_per_lun);  in nanddev_offs_to_pos()
712 	pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;  in nanddev_offs_to_pos()
713 	pos->lun = do_div(tmp, nand->memorg.luns_per_target);  in nanddev_offs_to_pos()
714 	pos->target = tmp;  in nanddev_offs_to_pos()
720  * nanddev_pos_cmp() - Compare two NAND positions
726  * Return: -1 if @a < @b, 0 if @a == @b and 1 if @a > @b.
731 	if (a->target != b->target)  in nanddev_pos_cmp()
732 		return a->target < b->target ? -1 : 1;  in nanddev_pos_cmp()
734 	if (a->lun != b->lun)  in nanddev_pos_cmp()
735 		return a->lun < b->lun ? -1 : 1;  in nanddev_pos_cmp()
737 	if (a->eraseblock != b->eraseblock)  in nanddev_pos_cmp()
738 		return a->eraseblock < b->eraseblock ? -1 : 1;  in nanddev_pos_cmp()
740 	if (a->page != b->page)  in nanddev_pos_cmp()
741 		return a->page < b->page ? -1 : 1;  in nanddev_pos_cmp()
747  * nanddev_pos_to_offs() - Convert a NAND position into an absolute offset
748  * @nand: NAND device
762 	npages = pos->page +  in nanddev_pos_to_offs()
763 		 ((pos->eraseblock +  in nanddev_pos_to_offs()
764 		   (pos->lun +  in nanddev_pos_to_offs()
765 		    (pos->target * nand->memorg.luns_per_target)) *  in nanddev_pos_to_offs()
766 		   nand->memorg.eraseblocks_per_lun) *  in nanddev_pos_to_offs()
767 		  nand->memorg.pages_per_eraseblock);  in nanddev_pos_to_offs()
769 	return (loff_t)npages * nand->memorg.pagesize;  in nanddev_pos_to_offs()
773  * nanddev_pos_to_row() - Extract a row address from a NAND position
774  * @nand: NAND device
778  * device.
785 	return (pos->lun << nand->rowconv.lun_addr_shift) |  in nanddev_pos_to_row()
786 	       (pos->eraseblock << nand->rowconv.eraseblock_addr_shift) |  in nanddev_pos_to_row()
787 	       pos->page;  in nanddev_pos_to_row()
791  * nanddev_pos_next_target() - Move a position to the next target/die
792  * @nand: NAND device
796  * want to iterate over all targets/dies of a NAND device.
801 	pos->page = 0;  in nanddev_pos_next_target()
802 	pos->plane = 0;  in nanddev_pos_next_target()
803 	pos->eraseblock = 0;  in nanddev_pos_next_target()
804 	pos->lun = 0;  in nanddev_pos_next_target()
805 	pos->target++;  in nanddev_pos_next_target()
809  * nanddev_pos_next_lun() - Move a position to the next LUN
810  * @nand: NAND device
814  * iterate over all LUNs of a NAND device.
819 	if (pos->lun >= nand->memorg.luns_per_target - 1)  in nanddev_pos_next_lun()
822 	pos->lun++;  in nanddev_pos_next_lun()
823 	pos->page = 0;  in nanddev_pos_next_lun()
824 	pos->plane = 0;  in nanddev_pos_next_lun()
825 	pos->eraseblock = 0;  in nanddev_pos_next_lun()
829  * nanddev_pos_next_eraseblock() - Move a position to the next eraseblock
830  * @nand: NAND device
834  * want to iterate over all eraseblocks of a NAND device.
839 	if (pos->eraseblock >= nand->memorg.eraseblocks_per_lun - 1)  in nanddev_pos_next_eraseblock()
842 	pos->eraseblock++;  in nanddev_pos_next_eraseblock()
843 	pos->page = 0;  in nanddev_pos_next_eraseblock()
844 	pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;  in nanddev_pos_next_eraseblock()
848  * nanddev_pos_next_page() - Move a position to the next page
849  * @nand: NAND device
853  * iterate over all pages of a NAND device.
858 	if (pos->page >= nand->memorg.pages_per_eraseblock - 1)  in nanddev_pos_next_page()
861 	pos->page++;  in nanddev_pos_next_page()
865  * nand_io_iter_init - Initialize a NAND I/O iterator
866  * @nand: NAND device
881 	iter->req.type = reqtype;  in nanddev_io_iter_init()
882 	iter->req.mode = req->mode;  in nanddev_io_iter_init()
883 	iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos);  in nanddev_io_iter_init()
884 	iter->req.ooboffs = req->ooboffs;  in nanddev_io_iter_init()
885 	iter->oobbytes_per_page = mtd_oobavail(mtd, req);  in nanddev_io_iter_init()
886 	iter->dataleft = req->len;  in nanddev_io_iter_init()
887 	iter->oobleft = req->ooblen;  in nanddev_io_iter_init()
888 	iter->req.databuf.in = req->datbuf;  in nanddev_io_iter_init()
889 	iter->req.datalen = min_t(unsigned int,  in nanddev_io_iter_init()
890 				  nand->memorg.pagesize - iter->req.dataoffs,  in nanddev_io_iter_init()
891 				  iter->dataleft);  in nanddev_io_iter_init()
892 	iter->req.oobbuf.in = req->oobbuf;  in nanddev_io_iter_init()
893 	iter->req.ooblen = min_t(unsigned int,  in nanddev_io_iter_init()
894 				 iter->oobbytes_per_page - iter->req.ooboffs,  in nanddev_io_iter_init()
895 				 iter->oobleft);  in nanddev_io_iter_init()
899  * nand_io_iter_next_page - Move to the next page
900  * @nand: NAND device
908 	nanddev_pos_next_page(nand, &iter->req.pos);  in nanddev_io_iter_next_page()
909 	iter->dataleft -= iter->req.datalen;  in nanddev_io_iter_next_page()
910 	iter->req.databuf.in += iter->req.datalen;  in nanddev_io_iter_next_page()
911 	iter->oobleft -= iter->req.ooblen;  in nanddev_io_iter_next_page()
912 	iter->req.oobbuf.in += iter->req.ooblen;  in nanddev_io_iter_next_page()
913 	iter->req.dataoffs = 0;  in nanddev_io_iter_next_page()
914 	iter->req.ooboffs = 0;  in nanddev_io_iter_next_page()
915 	iter->req.datalen = min_t(unsigned int, nand->memorg.pagesize,  in nanddev_io_iter_next_page()
916 				  iter->dataleft);  in nanddev_io_iter_next_page()
917 	iter->req.ooblen = min_t(unsigned int, iter->oobbytes_per_page,  in nanddev_io_iter_next_page()
918 				 iter->oobleft);  in nanddev_io_iter_next_page()
922  * nand_io_iter_end - Should end iteration or not
923  * @nand: NAND device
935 	if (iter->dataleft || iter->oobleft)  in nanddev_io_iter_end()
942  * nand_io_for_each_page - Iterate over all NAND pages contained in an MTD I/O
944  * @nand: NAND device
985  * nanddev_bbt_pos_to_entry() - Convert a NAND position into a BBT entry
986  * @nand: NAND device
997 	return pos->eraseblock +  in nanddev_bbt_pos_to_entry()
998 	       ((pos->lun + (pos->target * nand->memorg.luns_per_target)) *  in nanddev_bbt_pos_to_entry()
999 		nand->memorg.eraseblocks_per_lun);  in nanddev_bbt_pos_to_entry()
1003  * nanddev_bbt_is_initialized() - Check if the BBT has been initialized
1004  * @nand: NAND device
1010 	return !!nand->bbt.cache;  in nanddev_bbt_is_initialized()
1013 /* MTD -> NAND helper functions. */