Lines Matching full:nand
19 * @bits_per_cell: number of bits per NAND cell
27 * @ntargets: total number of targets exposed by the NAND device
67 * struct nand_pos - NAND position object
68 * @target: the NAND target/die
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
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
179 * struct nand_ecc_props - NAND ECC properties
198 /* NAND ECC misc flags */
210 * struct nand_ops - NAND operations
212 * erasing, this has been taken care of by the generic NAND layer
215 * NAND layer. This method should just write the BBM (Bad Block
223 * NAND layers (SPI NAND, raw NAND, ...).
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);
248 * @init_ctx: given a desired user configuration for the pointed NAND device,
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,
262 int (*finish_io_req)(struct nand_device *nand,
267 * enum nand_ecc_engine_integration - How the NAND ECC engine is integrated
282 * struct nand_ecc_engine - ECC engine abstraction for NAND devices
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,
303 int nand_ecc_finish_io_req(struct nand_device *nand,
305 bool nand_ecc_is_strong_enough(struct nand_device *nand);
323 struct nand_ecc_engine *nand_ecc_get_sw_engine(struct nand_device *nand);
324 struct nand_ecc_engine *nand_ecc_get_on_die_hw_engine(struct nand_device *nand);
325 struct nand_ecc_engine *nand_ecc_get_on_host_hw_engine(struct nand_device *nand);
326 void nand_ecc_put_on_host_hw_engine(struct nand_device *nand);
350 * @nand: Related NAND device, to have access to its memory organization
362 struct nand_device *nand; member
372 struct nand_device *nand);
382 * @requirements: ECC requirements from the NAND chip perspective
399 * struct nand_device - NAND device
400 * @mtd: MTD instance attached to the NAND device
402 * @ecc: NAND ECC object attached to the NAND device
405 * @ops: NAND operations attached to the NAND device
407 * Generic NAND object. Specialized NAND layers (raw NAND, SPI NAND, OneNAND)
408 * should declare their own NAND object embedding a nand_device struct (that's
411 * be filled at device detection time to reflect the NAND device
413 * It will take care of converting NAND information into MTD ones, which means
414 * the specialized NAND layers should never manually tweak
427 * struct nand_io_iter - NAND I/O iterator
433 * Can be used by specialized NAND layers to iterate over all pages covered
435 * code needed to read/write data from/to a NAND device.
445 * mtd_to_nanddev() - Get the NAND device attached to the MTD instance
448 * Return: the NAND device embedding @mtd.
456 * nanddev_to_mtd() - Get the MTD device attached to a NAND device
457 * @nand: NAND device
459 * Return: the MTD device embedded in @nand.
461 static inline struct mtd_info *nanddev_to_mtd(struct nand_device *nand) in nanddev_to_mtd() argument
463 return &nand->mtd; in nanddev_to_mtd()
468 * @nand: NAND device
472 static inline unsigned int nanddev_bits_per_cell(const struct nand_device *nand) in nanddev_bits_per_cell() argument
474 return nand->memorg.bits_per_cell; in nanddev_bits_per_cell()
478 * nanddev_page_size() - Get NAND page size
479 * @nand: NAND device
483 static inline size_t nanddev_page_size(const struct nand_device *nand) in nanddev_page_size() argument
485 return nand->memorg.pagesize; in nanddev_page_size()
489 * nanddev_per_page_oobsize() - Get NAND OOB size
490 * @nand: NAND device
495 nanddev_per_page_oobsize(const struct nand_device *nand) in nanddev_per_page_oobsize() argument
497 return nand->memorg.oobsize; in nanddev_per_page_oobsize()
502 * @nand: NAND device
507 nanddev_pages_per_eraseblock(const struct nand_device *nand) in nanddev_pages_per_eraseblock() argument
509 return nand->memorg.pages_per_eraseblock; in nanddev_pages_per_eraseblock()
514 * @nand: NAND device
519 nanddev_pages_per_target(const struct nand_device *nand) in nanddev_pages_per_target() argument
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
528 * @nand: NAND device
532 static inline size_t nanddev_eraseblock_size(const struct nand_device *nand) in nanddev_eraseblock_size() argument
534 return nand->memorg.pagesize * nand->memorg.pages_per_eraseblock; in nanddev_eraseblock_size()
539 * @nand: NAND device
544 nanddev_eraseblocks_per_lun(const struct nand_device *nand) in nanddev_eraseblocks_per_lun() argument
546 return nand->memorg.eraseblocks_per_lun; in nanddev_eraseblocks_per_lun()
551 * @nand: NAND device
556 nanddev_eraseblocks_per_target(const struct nand_device *nand) in nanddev_eraseblocks_per_target() argument
558 return nand->memorg.eraseblocks_per_lun * nand->memorg.luns_per_target; in nanddev_eraseblocks_per_target()
563 * @nand: NAND device
567 static inline u64 nanddev_target_size(const struct nand_device *nand) in nanddev_target_size() argument
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()
577 * @nand: NAND device
579 * Return: the number of targets/dies exposed by @nand.
581 static inline unsigned int nanddev_ntargets(const struct nand_device *nand) in nanddev_ntargets() argument
583 return nand->memorg.ntargets; in nanddev_ntargets()
588 * @nand: NAND device
590 * Return: the total number of eraseblocks exposed by @nand.
592 static inline unsigned int nanddev_neraseblocks(const struct nand_device *nand) in nanddev_neraseblocks() argument
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
600 * @nand: NAND device
602 * Return: the total size (in bytes) exposed by @nand.
604 static inline u64 nanddev_size(const struct nand_device *nand) in nanddev_size() argument
606 return nanddev_target_size(nand) * nanddev_ntargets(nand); in nanddev_size()
610 * nanddev_get_memorg() - Extract memory organization info from a NAND device
611 * @nand: NAND device
616 * Return: the memorg object embedded in the NAND device.
619 nanddev_get_memorg(struct nand_device *nand) in nanddev_get_memorg() argument
621 return &nand->memorg; in nanddev_get_memorg()
625 * nanddev_get_ecc_conf() - Extract the ECC configuration from a NAND device
626 * @nand: NAND device
629 nanddev_get_ecc_conf(struct nand_device *nand) in nanddev_get_ecc_conf() argument
631 return &nand->ecc.ctx.conf; in nanddev_get_ecc_conf()
636 * @nand: NAND device
639 nanddev_get_ecc_nsteps(struct nand_device *nand) in nanddev_get_ecc_nsteps() argument
641 return nand->ecc.ctx.nsteps; in nanddev_get_ecc_nsteps()
646 * @nand: NAND device
649 nanddev_get_ecc_bytes_per_step(struct nand_device *nand) in nanddev_get_ecc_bytes_per_step() argument
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
657 * @nand: NAND device
660 nanddev_get_ecc_requirements(struct nand_device *nand) in nanddev_get_ecc_requirements() argument
662 return &nand->ecc.requirements; in nanddev_get_ecc_requirements()
666 * nanddev_set_ecc_requirements() - Assign the ECC requirements of a NAND
668 * @nand: NAND device
672 nanddev_set_ecc_requirements(struct nand_device *nand, in nanddev_set_ecc_requirements() argument
675 nand->ecc.requirements = *reqs; in nanddev_set_ecc_requirements()
678 int nanddev_init(struct nand_device *nand, const struct nand_ops *ops,
680 void nanddev_cleanup(struct nand_device *nand);
683 * nanddev_register() - Register a NAND device
684 * @nand: NAND device
686 * Register a NAND device.
688 * registering the MTD device embedded in @nand.
692 static inline int nanddev_register(struct nand_device *nand) in nanddev_register() argument
694 return mtd_device_register(&nand->mtd, NULL, 0); in nanddev_register()
698 * nanddev_unregister() - Unregister a NAND device
699 * @nand: NAND device
701 * Unregister a NAND device.
703 * unregistering the MTD device embedded in @nand.
707 static inline int nanddev_unregister(struct nand_device *nand) in nanddev_unregister() argument
709 return mtd_device_unregister(&nand->mtd); in nanddev_unregister()
713 * nanddev_set_of_node() - Attach a DT node to a NAND device
714 * @nand: NAND device
717 * Attach a DT node to a NAND device.
719 static inline void nanddev_set_of_node(struct nand_device *nand, in nanddev_set_of_node() argument
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
727 * @nand: NAND device
729 * Return: the DT node attached to @nand.
731 static inline struct device_node *nanddev_get_of_node(struct nand_device *nand) in nanddev_get_of_node() argument
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
738 * @nand: NAND device
739 * @offs: absolute NAND offset (usually passed by the MTD layer)
740 * @pos: a NAND position object to fill in
744 * Return: the offset within the NAND page pointed by @pos.
746 static inline unsigned int nanddev_offs_to_pos(struct nand_device *nand, in nanddev_offs_to_pos() argument
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()
764 * nanddev_pos_cmp() - Compare two NAND positions
765 * @a: First NAND position
766 * @b: Second NAND position
768 * Compares two NAND positions.
791 * nanddev_pos_to_offs() - Convert a NAND position into an absolute offset
792 * @nand: NAND device
793 * @pos: the NAND position to convert
795 * Converts @pos NAND position into an absolute offset.
801 static inline loff_t nanddev_pos_to_offs(struct nand_device *nand, in nanddev_pos_to_offs() argument
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
818 * @nand: NAND device
821 * Converts a NAND position into a row address that can then be passed to the
826 static inline unsigned int nanddev_pos_to_row(struct nand_device *nand, in nanddev_pos_to_row() argument
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()
836 * @nand: NAND device
840 * want to iterate over all targets/dies of a NAND device.
842 static inline void nanddev_pos_next_target(struct nand_device *nand, in nanddev_pos_next_target() argument
854 * @nand: NAND device
858 * iterate over all LUNs of a NAND device.
860 static inline void nanddev_pos_next_lun(struct nand_device *nand, in nanddev_pos_next_lun() argument
863 if (pos->lun >= nand->memorg.luns_per_target - 1) in nanddev_pos_next_lun()
864 return nanddev_pos_next_target(nand, pos); in nanddev_pos_next_lun()
874 * @nand: NAND device
878 * want to iterate over all eraseblocks of a NAND device.
880 static inline void nanddev_pos_next_eraseblock(struct nand_device *nand, in nanddev_pos_next_eraseblock() argument
883 if (pos->eraseblock >= nand->memorg.eraseblocks_per_lun - 1) in nanddev_pos_next_eraseblock()
884 return nanddev_pos_next_lun(nand, pos); in nanddev_pos_next_eraseblock()
888 pos->plane = pos->eraseblock % nand->memorg.planes_per_lun; in nanddev_pos_next_eraseblock()
893 * @nand: NAND device
897 * iterate over all pages of a NAND device.
899 static inline void nanddev_pos_next_page(struct nand_device *nand, in nanddev_pos_next_page() argument
902 if (pos->page >= nand->memorg.pages_per_eraseblock - 1) in nanddev_pos_next_page()
903 return nanddev_pos_next_eraseblock(nand, pos); in nanddev_pos_next_page()
909 * nand_io_iter_init - Initialize a NAND I/O iterator
910 * @nand: NAND device
913 * @iter: NAND I/O iterator
915 * Initializes a NAND iterator based on the information passed by the MTD
918 static inline void nanddev_io_iter_init(struct nand_device *nand, in nanddev_io_iter_init() argument
923 struct mtd_info *mtd = nanddev_to_mtd(nand); in nanddev_io_iter_init()
927 iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos); in nanddev_io_iter_init()
934 nand->memorg.pagesize - iter->req.dataoffs, in nanddev_io_iter_init()
944 * @nand: NAND device
945 * @iter: NAND I/O iterator
949 static inline void nanddev_io_iter_next_page(struct nand_device *nand, in nanddev_io_iter_next_page() argument
952 nanddev_pos_next_page(nand, &iter->req.pos); in nanddev_io_iter_next_page()
959 iter->req.datalen = min_t(unsigned int, nand->memorg.pagesize, in nanddev_io_iter_next_page()
967 * @nand: NAND device
968 * @iter: NAND I/O iterator
970 * Check whether @iter has reached the end of the NAND portion it was asked to
976 static inline bool nanddev_io_iter_end(struct nand_device *nand, in nanddev_io_iter_end() argument
986 * nand_io_for_each_page - Iterate over all NAND pages contained in an MTD I/O
988 * @nand: NAND device
991 * @iter: NAND I/O iterator
995 #define nanddev_io_for_each_page(nand, type, start, req, iter) \ argument
996 for (nanddev_io_iter_init(nand, type, start, req, iter); \
997 !nanddev_io_iter_end(nand, iter); \
998 nanddev_io_iter_next_page(nand, iter))
1000 bool nanddev_isbad(struct nand_device *nand, const struct nand_pos *pos);
1001 bool nanddev_isreserved(struct nand_device *nand, const struct nand_pos *pos);
1002 int nanddev_erase(struct nand_device *nand, const struct nand_pos *pos);
1003 int nanddev_markbad(struct nand_device *nand, const struct nand_pos *pos);
1006 int nanddev_ecc_engine_init(struct nand_device *nand);
1007 void nanddev_ecc_engine_cleanup(struct nand_device *nand);
1009 static inline void *nand_to_ecc_ctx(struct nand_device *nand) in nand_to_ecc_ctx() argument
1011 return nand->ecc.ctx.priv; in nand_to_ecc_ctx()
1024 int nanddev_bbt_init(struct nand_device *nand);
1025 void nanddev_bbt_cleanup(struct nand_device *nand);
1026 int nanddev_bbt_update(struct nand_device *nand);
1027 int nanddev_bbt_get_block_status(const struct nand_device *nand,
1029 int nanddev_bbt_set_block_status(struct nand_device *nand, unsigned int entry,
1031 int nanddev_bbt_markbad(struct nand_device *nand, unsigned int block);
1034 * nanddev_bbt_pos_to_entry() - Convert a NAND position into a BBT entry
1035 * @nand: NAND device
1036 * @pos: the NAND position we want to get BBT entry for
1043 static inline unsigned int nanddev_bbt_pos_to_entry(struct nand_device *nand, in nanddev_bbt_pos_to_entry() argument
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()
1053 * @nand: NAND device
1057 static inline bool nanddev_bbt_is_initialized(struct nand_device *nand) in nanddev_bbt_is_initialized() argument
1059 return !!nand->bbt.cache; in nanddev_bbt_is_initialized()
1062 /* MTD -> NAND helper functions. */