1 /* SPDX-License-Identifier: GPL-2.0 */
3  *  Copyright 2017 - Free Electrons
6  *	Boris Brezillon <boris.brezillon@free-electrons.com>
16  * struct nand_memory_organization - Memory organization structure
17  * @bits_per_cell: number of bits per NAND cell
20  * @pages_per_eraseblock: number of pages per eraseblock
21  * @eraseblocks_per_lun: number of eraseblocks per LUN (Logical Unit Number)
22  * @planes_per_lun: number of planes per LUN
23  * @luns_per_target: number of LUN per target (target is a synonym for die)
24  * @ntargets: total number of targets exposed by the NAND device
50  * struct nand_row_converter - Information needed to convert an absolute offset
62  * struct nand_pos - NAND position object
69  * These information are usually used by specific sub-layers to select the
70  * appropriate target/die and generate a row address to pass to the device.
81  * struct nand_page_io_req - NAND I/O request object
91  * This object is used to pass per-page I/O requests to NAND sub-layers. This
114  * struct nand_ecc_req - NAND ECC requirements
133  * struct nand_bbt - bad block table object
147  * struct nand_ops - NAND operations
153  *	     Marker) so that future call to struct_nand_ops->isbad() return
169  * struct nand_device - NAND device
170  * @mtd: MTD instance attached to the NAND device
175  * @ops: NAND operations attached to the NAND device
180  * struct_nand_device->memorg and struct_nand_device->eccreq should be filled
181  * at device detection time to reflect the NAND device
185  * struct_nand_device->mtd except for the ->_read/write() hooks.
197  * struct nand_io_iter - NAND I/O iterator
199  * @oobbytes_per_page: maximum number of OOB bytes per page
204  * by an MTD I/O request, which should greatly simplifies the boiler-plate
205  * code needed to read/write data from/to a NAND device.
215  * mtd_to_nanddev() - Get the NAND device attached to the MTD instance
218  * Return: the NAND device embedding @mtd.
222 	return mtd->priv;  in mtd_to_nanddev()
226  * nanddev_to_mtd() - Get the MTD device attached to a NAND device
227  * @nand: NAND device
229  * Return: the MTD device embedded in @nand.
233 	return nand->mtd;  in nanddev_to_mtd()
237  * nanddev_bits_per_cell() - Get the number of bits per cell
238  * @nand: NAND device
240  * Return: the number of bits per cell.
244 	return nand->memorg.bits_per_cell;  in nanddev_bits_per_cell()
248  * nanddev_page_size() - Get NAND page size
249  * @nand: NAND device
255 	return nand->memorg.pagesize;  in nanddev_page_size()
259  * nanddev_per_page_oobsize() - Get NAND OOB size
260  * @nand: NAND device
267 	return nand->memorg.oobsize;  in nanddev_per_page_oobsize()
271  * nanddev_pages_per_eraseblock() - Get the number of pages per eraseblock
272  * @nand: NAND device
274  * Return: the number of pages per eraseblock.
279 	return nand->memorg.pages_per_eraseblock;  in nanddev_pages_per_eraseblock()
283  * nanddev_per_page_oobsize() - Get NAND erase block size
284  * @nand: NAND device
290 	return nand->memorg.pagesize * nand->memorg.pages_per_eraseblock;  in nanddev_eraseblock_size()
294  * nanddev_eraseblocks_per_lun() - Get the number of eraseblocks per LUN
295  * @nand: NAND device
297  * Return: the number of eraseblocks per LUN.
302 	return nand->memorg.eraseblocks_per_lun;  in nanddev_eraseblocks_per_lun()
306  * nanddev_target_size() - Get the total size provided by a single target/die
307  * @nand: NAND device
313 	return (u64)nand->memorg.luns_per_target *  in nanddev_target_size()
314 	       nand->memorg.eraseblocks_per_lun *  in nanddev_target_size()
315 	       nand->memorg.pages_per_eraseblock *  in nanddev_target_size()
316 	       nand->memorg.pagesize;  in nanddev_target_size()
320  * nanddev_ntarget() - Get the total of targets
321  * @nand: NAND device
327 	return nand->memorg.ntargets;  in nanddev_ntargets()
331  * nanddev_neraseblocks() - Get the total number of erasablocks
332  * @nand: NAND device
338 	return nand->memorg.ntargets * nand->memorg.luns_per_target *  in nanddev_neraseblocks()
339 	       nand->memorg.eraseblocks_per_lun;  in nanddev_neraseblocks()
343  * nanddev_size() - Get NAND size
344  * @nand: NAND device
354  * nanddev_get_memorg() - Extract memory organization info from a NAND device
355  * @nand: NAND device
360  * Return: the memorg object embedded in the NAND device.
365 	return &nand->memorg;  in nanddev_get_memorg()
373  * nanddev_register() - Register a NAND device
374  * @nand: NAND device
376  * Register a NAND device.
378  * registering the MTD device embedded in @nand.
384 	return mtd_device_register(nand->mtd, NULL, 0);  in nanddev_register()
388  * nanddev_unregister() - Unregister a NAND device
389  * @nand: NAND device
391  * Unregister a NAND device.
393  * unregistering the MTD device embedded in @nand.
399 	return mtd_device_unregister(nand->mtd);  in nanddev_unregister()
403  * nanddev_set_of_node() - Attach a DT node to a NAND device
404  * @nand: NAND device
407  * Attach a DT node to a NAND device.
412 	mtd_set_of_node(nand->mtd, np);  in nanddev_set_of_node()
416  * nanddev_get_of_node() - Retrieve the DT node attached to a NAND device
417  * @nand: NAND device
423 	return mtd_get_of_node(nand->mtd);  in nanddev_get_of_node()
427  * nanddev_offs_to_pos() - Convert an absolute NAND offset into a NAND position
428  * @nand: NAND device
443 	pageoffs = do_div(tmp, nand->memorg.pagesize);  in nanddev_offs_to_pos()
444 	pos->page = do_div(tmp, nand->memorg.pages_per_eraseblock);  in nanddev_offs_to_pos()
445 	pos->eraseblock = do_div(tmp, nand->memorg.eraseblocks_per_lun);  in nanddev_offs_to_pos()
446 	pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;  in nanddev_offs_to_pos()
447 	pos->lun = do_div(tmp, nand->memorg.luns_per_target);  in nanddev_offs_to_pos()
448 	pos->target = tmp;  in nanddev_offs_to_pos()
454  * nanddev_pos_cmp() - Compare two NAND positions
460  * Return: -1 if @a < @b, 0 if @a == @b and 1 if @a > @b.
465 	if (a->target != b->target)  in nanddev_pos_cmp()
466 		return a->target < b->target ? -1 : 1;  in nanddev_pos_cmp()
468 	if (a->lun != b->lun)  in nanddev_pos_cmp()
469 		return a->lun < b->lun ? -1 : 1;  in nanddev_pos_cmp()
471 	if (a->eraseblock != b->eraseblock)  in nanddev_pos_cmp()
472 		return a->eraseblock < b->eraseblock ? -1 : 1;  in nanddev_pos_cmp()
474 	if (a->page != b->page)  in nanddev_pos_cmp()
475 		return a->page < b->page ? -1 : 1;  in nanddev_pos_cmp()
481  * nanddev_pos_to_offs() - Convert a NAND position into an absolute offset
482  * @nand: NAND device
496 	npages = pos->page +  in nanddev_pos_to_offs()
497 		 ((pos->eraseblock +  in nanddev_pos_to_offs()
498 		   (pos->lun +  in nanddev_pos_to_offs()
499 		    (pos->target * nand->memorg.luns_per_target)) *  in nanddev_pos_to_offs()
500 		   nand->memorg.eraseblocks_per_lun) *  in nanddev_pos_to_offs()
501 		  nand->memorg.pages_per_eraseblock);  in nanddev_pos_to_offs()
503 	return (loff_t)npages * nand->memorg.pagesize;  in nanddev_pos_to_offs()
507  * nanddev_pos_to_row() - Extract a row address from a NAND position
508  * @nand: NAND device
512  * device.
519 	return (pos->lun << nand->rowconv.lun_addr_shift) |  in nanddev_pos_to_row()
520 	       (pos->eraseblock << nand->rowconv.eraseblock_addr_shift) |  in nanddev_pos_to_row()
521 	       pos->page;  in nanddev_pos_to_row()
525  * nanddev_pos_next_target() - Move a position to the next target/die
526  * @nand: NAND device
530  * want to iterate over all targets/dies of a NAND device.
535 	pos->page = 0;  in nanddev_pos_next_target()
536 	pos->plane = 0;  in nanddev_pos_next_target()
537 	pos->eraseblock = 0;  in nanddev_pos_next_target()
538 	pos->lun = 0;  in nanddev_pos_next_target()
539 	pos->target++;  in nanddev_pos_next_target()
543  * nanddev_pos_next_lun() - Move a position to the next LUN
544  * @nand: NAND device
548  * iterate over all LUNs of a NAND device.
553 	if (pos->lun >= nand->memorg.luns_per_target - 1)  in nanddev_pos_next_lun()
556 	pos->lun++;  in nanddev_pos_next_lun()
557 	pos->page = 0;  in nanddev_pos_next_lun()
558 	pos->plane = 0;  in nanddev_pos_next_lun()
559 	pos->eraseblock = 0;  in nanddev_pos_next_lun()
563  * nanddev_pos_next_eraseblock() - Move a position to the next eraseblock
564  * @nand: NAND device
568  * want to iterate over all eraseblocks of a NAND device.
573 	if (pos->eraseblock >= nand->memorg.eraseblocks_per_lun - 1)  in nanddev_pos_next_eraseblock()
576 	pos->eraseblock++;  in nanddev_pos_next_eraseblock()
577 	pos->page = 0;  in nanddev_pos_next_eraseblock()
578 	pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;  in nanddev_pos_next_eraseblock()
582  * nanddev_pos_next_eraseblock() - Move a position to the next page
583  * @nand: NAND device
587  * iterate over all pages of a NAND device.
592 	if (pos->page >= nand->memorg.pages_per_eraseblock - 1)  in nanddev_pos_next_page()
595 	pos->page++;  in nanddev_pos_next_page()
599  * nand_io_iter_init - Initialize a NAND I/O iterator
600  * @nand: NAND device
614 	iter->req.mode = req->mode;  in nanddev_io_iter_init()
615 	iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos);  in nanddev_io_iter_init()
616 	iter->req.ooboffs = req->ooboffs;  in nanddev_io_iter_init()
617 	iter->oobbytes_per_page = mtd_oobavail(mtd, req);  in nanddev_io_iter_init()
618 	iter->dataleft = req->len;  in nanddev_io_iter_init()
619 	iter->oobleft = req->ooblen;  in nanddev_io_iter_init()
620 	iter->req.databuf.in = req->datbuf;  in nanddev_io_iter_init()
621 	iter->req.datalen = min_t(unsigned int,  in nanddev_io_iter_init()
622 				  nand->memorg.pagesize - iter->req.dataoffs,  in nanddev_io_iter_init()
623 				  iter->dataleft);  in nanddev_io_iter_init()
624 	iter->req.oobbuf.in = req->oobbuf;  in nanddev_io_iter_init()
625 	iter->req.ooblen = min_t(unsigned int,  in nanddev_io_iter_init()
626 				 iter->oobbytes_per_page - iter->req.ooboffs,  in nanddev_io_iter_init()
627 				 iter->oobleft);  in nanddev_io_iter_init()
631  * nand_io_iter_next_page - Move to the next page
632  * @nand: NAND device
640 	nanddev_pos_next_page(nand, &iter->req.pos);  in nanddev_io_iter_next_page()
641 	iter->dataleft -= iter->req.datalen;  in nanddev_io_iter_next_page()
642 	iter->req.databuf.in += iter->req.datalen;  in nanddev_io_iter_next_page()
643 	iter->oobleft -= iter->req.ooblen;  in nanddev_io_iter_next_page()
644 	iter->req.oobbuf.in += iter->req.ooblen;  in nanddev_io_iter_next_page()
645 	iter->req.dataoffs = 0;  in nanddev_io_iter_next_page()
646 	iter->req.ooboffs = 0;  in nanddev_io_iter_next_page()
647 	iter->req.datalen = min_t(unsigned int, nand->memorg.pagesize,  in nanddev_io_iter_next_page()
648 				  iter->dataleft);  in nanddev_io_iter_next_page()
649 	iter->req.ooblen = min_t(unsigned int, iter->oobbytes_per_page,  in nanddev_io_iter_next_page()
650 				 iter->oobleft);  in nanddev_io_iter_next_page()
654  * nand_io_iter_end - Should end iteration or not
655  * @nand: NAND device
667 	if (iter->dataleft || iter->oobleft)  in nanddev_io_iter_end()
674  * nand_io_for_each_page - Iterate over all NAND pages contained in an MTD I/O
676  * @nand: NAND device
713  * nanddev_bbt_pos_to_entry() - Convert a NAND position into a BBT entry
714  * @nand: NAND device
725 	return pos->eraseblock +  in nanddev_bbt_pos_to_entry()
726 	       ((pos->lun + (pos->target * nand->memorg.luns_per_target)) *  in nanddev_bbt_pos_to_entry()
727 		nand->memorg.eraseblocks_per_lun);  in nanddev_bbt_pos_to_entry()
731  * nanddev_bbt_is_initialized() - Check if the BBT has been initialized
732  * @nand: NAND device
738 	return !!nand->bbt.cache;  in nanddev_bbt_is_initialized()
741 /* MTD -> NAND helper functions. */