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 * NAND device will automatically prepare the next one
109 * This object is used to pass per-page I/O requests to NAND sub-layers. This
111 * specific NAND layers can focus on translating these information into
138 * enum nand_ecc_engine_type - NAND ECC engine type
154 * enum nand_ecc_placement - NAND ECC bytes placement
168 * enum nand_ecc_algo - NAND ECC algorithm
182 * struct nand_ecc_props - NAND ECC properties
201 /* NAND ECC misc flags */
213 * struct nand_ops - NAND operations
215 * erasing, this has been taken care of by the generic NAND layer
218 * NAND layer. This method should just write the BBM (Bad Block
226 * NAND layers (SPI NAND, raw NAND, ...).
229 int (*erase)(struct nand_device *nand, const struct nand_pos *pos);
230 int (*markbad)(struct nand_device *nand, const struct nand_pos *pos);
231 bool (*isbad)(struct nand_device *nand, const struct nand_pos *pos);
251 * @init_ctx: given a desired user configuration for the pointed NAND device,
261 int (*init_ctx)(struct nand_device *nand);
262 void (*cleanup_ctx)(struct nand_device *nand);
263 int (*prepare_io_req)(struct nand_device *nand,
265 int (*finish_io_req)(struct nand_device *nand,
270 * enum nand_ecc_engine_integration - How the NAND ECC engine is integrated
285 * struct nand_ecc_engine - ECC engine abstraction for NAND devices
301 void of_get_nand_ecc_user_config(struct nand_device *nand);
302 int nand_ecc_init_ctx(struct nand_device *nand);
303 void nand_ecc_cleanup_ctx(struct nand_device *nand);
304 int nand_ecc_prepare_io_req(struct nand_device *nand,
306 int nand_ecc_finish_io_req(struct nand_device *nand,
308 bool nand_ecc_is_strong_enough(struct nand_device *nand);
326 struct nand_ecc_engine *nand_ecc_get_sw_engine(struct nand_device *nand);
327 struct nand_ecc_engine *nand_ecc_get_on_die_hw_engine(struct nand_device *nand);
328 struct nand_ecc_engine *nand_ecc_get_on_host_hw_engine(struct nand_device *nand);
329 void nand_ecc_put_on_host_hw_engine(struct nand_device *nand);
353 * @nand: Related NAND device, to have access to its memory organization
365 struct nand_device *nand; member
375 struct nand_device *nand);
385 * @requirements: ECC requirements from the NAND chip perspective
402 * struct nand_device - NAND device
403 * @mtd: MTD instance attached to the NAND device
405 * @ecc: NAND ECC object attached to the NAND device
408 * @ops: NAND operations attached to the NAND device
410 * Generic NAND object. Specialized NAND layers (raw NAND, SPI NAND, OneNAND)
411 * should declare their own NAND object embedding a nand_device struct (that's
414 * be filled at device detection time to reflect the NAND device
416 * It will take care of converting NAND information into MTD ones, which means
417 * the specialized NAND layers should never manually tweak
430 * struct nand_io_iter - NAND I/O iterator
436 * Can be used by specialized NAND layers to iterate over all pages covered
438 * code needed to read/write data from/to a NAND device.
448 * mtd_to_nanddev() - Get the NAND device attached to the MTD instance
451 * Return: the NAND device embedding @mtd.
459 * nanddev_to_mtd() - Get the MTD device attached to a NAND device
460 * @nand: NAND device
462 * Return: the MTD device embedded in @nand.
464 static inline struct mtd_info *nanddev_to_mtd(struct nand_device *nand) in nanddev_to_mtd() argument
466 return &nand->mtd; in nanddev_to_mtd()
471 * @nand: NAND device
475 static inline unsigned int nanddev_bits_per_cell(const struct nand_device *nand) in nanddev_bits_per_cell() argument
477 return nand->memorg.bits_per_cell; in nanddev_bits_per_cell()
481 * nanddev_page_size() - Get NAND page size
482 * @nand: NAND device
486 static inline size_t nanddev_page_size(const struct nand_device *nand) in nanddev_page_size() argument
488 return nand->memorg.pagesize; in nanddev_page_size()
492 * nanddev_per_page_oobsize() - Get NAND OOB size
493 * @nand: NAND device
498 nanddev_per_page_oobsize(const struct nand_device *nand) in nanddev_per_page_oobsize() argument
500 return nand->memorg.oobsize; in nanddev_per_page_oobsize()
505 * @nand: NAND device
510 nanddev_pages_per_eraseblock(const struct nand_device *nand) in nanddev_pages_per_eraseblock() argument
512 return nand->memorg.pages_per_eraseblock; in nanddev_pages_per_eraseblock()
517 * @nand: NAND device
522 nanddev_pages_per_target(const struct nand_device *nand) in nanddev_pages_per_target() argument
524 return nand->memorg.pages_per_eraseblock * in nanddev_pages_per_target()
525 nand->memorg.eraseblocks_per_lun * in nanddev_pages_per_target()
526 nand->memorg.luns_per_target; in nanddev_pages_per_target()
530 * nanddev_per_page_oobsize() - Get NAND erase block size
531 * @nand: NAND device
535 static inline size_t nanddev_eraseblock_size(const struct nand_device *nand) in nanddev_eraseblock_size() argument
537 return nand->memorg.pagesize * nand->memorg.pages_per_eraseblock; in nanddev_eraseblock_size()
542 * @nand: NAND device
547 nanddev_eraseblocks_per_lun(const struct nand_device *nand) in nanddev_eraseblocks_per_lun() argument
549 return nand->memorg.eraseblocks_per_lun; in nanddev_eraseblocks_per_lun()
554 * @nand: NAND device
559 nanddev_eraseblocks_per_target(const struct nand_device *nand) in nanddev_eraseblocks_per_target() argument
561 return nand->memorg.eraseblocks_per_lun * nand->memorg.luns_per_target; in nanddev_eraseblocks_per_target()
566 * @nand: NAND device
570 static inline u64 nanddev_target_size(const struct nand_device *nand) in nanddev_target_size() argument
572 return (u64)nand->memorg.luns_per_target * in nanddev_target_size()
573 nand->memorg.eraseblocks_per_lun * in nanddev_target_size()
574 nand->memorg.pages_per_eraseblock * in nanddev_target_size()
575 nand->memorg.pagesize; in nanddev_target_size()
580 * @nand: NAND device
582 * Return: the number of targets/dies exposed by @nand.
584 static inline unsigned int nanddev_ntargets(const struct nand_device *nand) in nanddev_ntargets() argument
586 return nand->memorg.ntargets; in nanddev_ntargets()
591 * @nand: NAND device
593 * Return: the total number of eraseblocks exposed by @nand.
595 static inline unsigned int nanddev_neraseblocks(const struct nand_device *nand) in nanddev_neraseblocks() argument
597 return nand->memorg.ntargets * nand->memorg.luns_per_target * in nanddev_neraseblocks()
598 nand->memorg.eraseblocks_per_lun; in nanddev_neraseblocks()
602 * nanddev_size() - Get NAND size
603 * @nand: NAND device
605 * Return: the total size (in bytes) exposed by @nand.
607 static inline u64 nanddev_size(const struct nand_device *nand) in nanddev_size() argument
609 return nanddev_target_size(nand) * nanddev_ntargets(nand); in nanddev_size()
613 * nanddev_get_memorg() - Extract memory organization info from a NAND device
614 * @nand: NAND device
619 * Return: the memorg object embedded in the NAND device.
622 nanddev_get_memorg(struct nand_device *nand) in nanddev_get_memorg() argument
624 return &nand->memorg; in nanddev_get_memorg()
628 * nanddev_get_ecc_conf() - Extract the ECC configuration from a NAND device
629 * @nand: NAND device
632 nanddev_get_ecc_conf(struct nand_device *nand) in nanddev_get_ecc_conf() argument
634 return &nand->ecc.ctx.conf; in nanddev_get_ecc_conf()
639 * @nand: NAND device
642 nanddev_get_ecc_nsteps(struct nand_device *nand) in nanddev_get_ecc_nsteps() argument
644 return nand->ecc.ctx.nsteps; in nanddev_get_ecc_nsteps()
649 * @nand: NAND device
652 nanddev_get_ecc_bytes_per_step(struct nand_device *nand) in nanddev_get_ecc_bytes_per_step() argument
654 return nand->ecc.ctx.total / nand->ecc.ctx.nsteps; in nanddev_get_ecc_bytes_per_step()
658 * nanddev_get_ecc_requirements() - Extract the ECC requirements from a NAND
660 * @nand: NAND device
663 nanddev_get_ecc_requirements(struct nand_device *nand) in nanddev_get_ecc_requirements() argument
665 return &nand->ecc.requirements; in nanddev_get_ecc_requirements()
669 * nanddev_set_ecc_requirements() - Assign the ECC requirements of a NAND
671 * @nand: NAND device
675 nanddev_set_ecc_requirements(struct nand_device *nand, in nanddev_set_ecc_requirements() argument
678 nand->ecc.requirements = *reqs; in nanddev_set_ecc_requirements()
681 int nanddev_init(struct nand_device *nand, const struct nand_ops *ops,
683 void nanddev_cleanup(struct nand_device *nand);
686 * nanddev_register() - Register a NAND device
687 * @nand: NAND device
689 * Register a NAND device.
691 * registering the MTD device embedded in @nand.
695 static inline int nanddev_register(struct nand_device *nand) in nanddev_register() argument
697 return mtd_device_register(&nand->mtd, NULL, 0); in nanddev_register()
701 * nanddev_unregister() - Unregister a NAND device
702 * @nand: NAND device
704 * Unregister a NAND device.
706 * unregistering the MTD device embedded in @nand.
710 static inline int nanddev_unregister(struct nand_device *nand) in nanddev_unregister() argument
712 return mtd_device_unregister(&nand->mtd); in nanddev_unregister()
716 * nanddev_set_of_node() - Attach a DT node to a NAND device
717 * @nand: NAND device
720 * Attach a DT node to a NAND device.
722 static inline void nanddev_set_of_node(struct nand_device *nand, in nanddev_set_of_node() argument
725 mtd_set_of_node(&nand->mtd, np); in nanddev_set_of_node()
729 * nanddev_get_of_node() - Retrieve the DT node attached to a NAND device
730 * @nand: NAND device
732 * Return: the DT node attached to @nand.
734 static inline struct device_node *nanddev_get_of_node(struct nand_device *nand) in nanddev_get_of_node() argument
736 return mtd_get_of_node(&nand->mtd); in nanddev_get_of_node()
740 * nanddev_offs_to_pos() - Convert an absolute NAND offset into a NAND position
741 * @nand: NAND device
742 * @offs: absolute NAND offset (usually passed by the MTD layer)
743 * @pos: a NAND position object to fill in
747 * Return: the offset within the NAND page pointed by @pos.
749 static inline unsigned int nanddev_offs_to_pos(struct nand_device *nand, in nanddev_offs_to_pos() argument
756 pageoffs = do_div(tmp, nand->memorg.pagesize); in nanddev_offs_to_pos()
757 pos->page = do_div(tmp, nand->memorg.pages_per_eraseblock); in nanddev_offs_to_pos()
758 pos->eraseblock = do_div(tmp, nand->memorg.eraseblocks_per_lun); in nanddev_offs_to_pos()
759 pos->plane = pos->eraseblock % nand->memorg.planes_per_lun; in nanddev_offs_to_pos()
760 pos->lun = do_div(tmp, nand->memorg.luns_per_target); in nanddev_offs_to_pos()
767 * nanddev_pos_cmp() - Compare two NAND positions
768 * @a: First NAND position
769 * @b: Second NAND position
771 * Compares two NAND positions.
794 * nanddev_pos_to_offs() - Convert a NAND position into an absolute offset
795 * @nand: NAND device
796 * @pos: the NAND position to convert
798 * Converts @pos NAND position into an absolute offset.
804 static inline loff_t nanddev_pos_to_offs(struct nand_device *nand, in nanddev_pos_to_offs() argument
812 (pos->target * nand->memorg.luns_per_target)) * in nanddev_pos_to_offs()
813 nand->memorg.eraseblocks_per_lun) * in nanddev_pos_to_offs()
814 nand->memorg.pages_per_eraseblock); in nanddev_pos_to_offs()
816 return (loff_t)npages * nand->memorg.pagesize; in nanddev_pos_to_offs()
820 * nanddev_pos_to_row() - Extract a row address from a NAND position
821 * @nand: NAND device
824 * Converts a NAND position into a row address that can then be passed to the
829 static inline unsigned int nanddev_pos_to_row(struct nand_device *nand, in nanddev_pos_to_row() argument
832 return (pos->lun << nand->rowconv.lun_addr_shift) | in nanddev_pos_to_row()
833 (pos->eraseblock << nand->rowconv.eraseblock_addr_shift) | in nanddev_pos_to_row()
839 * @nand: NAND device
843 * want to iterate over all targets/dies of a NAND device.
845 static inline void nanddev_pos_next_target(struct nand_device *nand, in nanddev_pos_next_target() argument
857 * @nand: NAND device
861 * iterate over all LUNs of a NAND device.
863 static inline void nanddev_pos_next_lun(struct nand_device *nand, in nanddev_pos_next_lun() argument
866 if (pos->lun >= nand->memorg.luns_per_target - 1) in nanddev_pos_next_lun()
867 return nanddev_pos_next_target(nand, pos); in nanddev_pos_next_lun()
877 * @nand: NAND device
881 * want to iterate over all eraseblocks of a NAND device.
883 static inline void nanddev_pos_next_eraseblock(struct nand_device *nand, in nanddev_pos_next_eraseblock() argument
886 if (pos->eraseblock >= nand->memorg.eraseblocks_per_lun - 1) in nanddev_pos_next_eraseblock()
887 return nanddev_pos_next_lun(nand, pos); in nanddev_pos_next_eraseblock()
891 pos->plane = pos->eraseblock % nand->memorg.planes_per_lun; in nanddev_pos_next_eraseblock()
896 * @nand: NAND device
900 * iterate over all pages of a NAND device.
902 static inline void nanddev_pos_next_page(struct nand_device *nand, in nanddev_pos_next_page() argument
905 if (pos->page >= nand->memorg.pages_per_eraseblock - 1) in nanddev_pos_next_page()
906 return nanddev_pos_next_eraseblock(nand, pos); in nanddev_pos_next_page()
912 * nand_io_page_iter_init - Initialize a NAND I/O iterator
913 * @nand: NAND device
916 * @iter: NAND I/O iterator
918 * Initializes a NAND iterator based on the information passed by the MTD
921 static inline void nanddev_io_page_iter_init(struct nand_device *nand, in nanddev_io_page_iter_init() argument
926 struct mtd_info *mtd = nanddev_to_mtd(nand); in nanddev_io_page_iter_init()
930 iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos); in nanddev_io_page_iter_init()
937 nand->memorg.pagesize - iter->req.dataoffs, in nanddev_io_page_iter_init()
947 * nand_io_block_iter_init - Initialize a NAND I/O iterator
948 * @nand: NAND device
951 * @iter: NAND I/O iterator
953 * Initializes a NAND iterator based on the information passed by the MTD
958 static inline void nanddev_io_block_iter_init(struct nand_device *nand, in nanddev_io_block_iter_init() argument
967 iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos); in nanddev_io_block_iter_init()
973 offs_in_eb = (nand->memorg.pagesize * iter->req.pos.page) + iter->req.dataoffs; in nanddev_io_block_iter_init()
975 nanddev_eraseblock_size(nand) - offs_in_eb, in nanddev_io_block_iter_init()
984 * @nand: NAND device
985 * @iter: NAND I/O iterator
989 static inline void nanddev_io_iter_next_page(struct nand_device *nand, in nanddev_io_iter_next_page() argument
992 nanddev_pos_next_page(nand, &iter->req.pos); in nanddev_io_iter_next_page()
999 iter->req.datalen = min_t(unsigned int, nand->memorg.pagesize, in nanddev_io_iter_next_page()
1007 * @nand: NAND device
1008 * @iter: NAND I/O iterator
1013 static inline void nanddev_io_iter_next_block(struct nand_device *nand, in nanddev_io_iter_next_block() argument
1016 nanddev_pos_next_eraseblock(nand, &iter->req.pos); in nanddev_io_iter_next_block()
1020 iter->req.datalen = min_t(unsigned int, nanddev_eraseblock_size(nand), in nanddev_io_iter_next_block()
1026 * @nand: NAND device
1027 * @iter: NAND I/O iterator
1029 * Check whether @iter has reached the end of the NAND portion it was asked to
1035 static inline bool nanddev_io_iter_end(struct nand_device *nand, in nanddev_io_iter_end() argument
1045 * nand_io_for_each_page - Iterate over all NAND pages contained in an MTD I/O
1047 * @nand: NAND device
1050 * @iter: NAND I/O iterator
1054 #define nanddev_io_for_each_page(nand, type, start, req, iter) \ argument
1055 for (nanddev_io_page_iter_init(nand, type, start, req, iter); \
1056 !nanddev_io_iter_end(nand, iter); \
1057 nanddev_io_iter_next_page(nand, iter))
1060 * nand_io_for_each_block - Iterate over all NAND pages contained in an MTD I/O
1062 * @nand: NAND device
1065 * @iter: NAND I/O iterator
1069 #define nanddev_io_for_each_block(nand, type, start, req, iter) \ argument
1070 for (nanddev_io_block_iter_init(nand, type, start, req, iter); \
1071 !nanddev_io_iter_end(nand, iter); \
1072 nanddev_io_iter_next_block(nand, iter))
1074 bool nanddev_isbad(struct nand_device *nand, const struct nand_pos *pos);
1075 bool nanddev_isreserved(struct nand_device *nand, const struct nand_pos *pos);
1076 int nanddev_markbad(struct nand_device *nand, const struct nand_pos *pos);
1079 int nanddev_ecc_engine_init(struct nand_device *nand);
1080 void nanddev_ecc_engine_cleanup(struct nand_device *nand);
1082 static inline void *nand_to_ecc_ctx(struct nand_device *nand) in nand_to_ecc_ctx() argument
1084 return nand->ecc.ctx.priv; in nand_to_ecc_ctx()
1097 int nanddev_bbt_init(struct nand_device *nand);
1098 void nanddev_bbt_cleanup(struct nand_device *nand);
1099 int nanddev_bbt_update(struct nand_device *nand);
1100 int nanddev_bbt_get_block_status(const struct nand_device *nand,
1102 int nanddev_bbt_set_block_status(struct nand_device *nand, unsigned int entry,
1104 int nanddev_bbt_markbad(struct nand_device *nand, unsigned int block);
1107 * nanddev_bbt_pos_to_entry() - Convert a NAND position into a BBT entry
1108 * @nand: NAND device
1109 * @pos: the NAND position we want to get BBT entry for
1116 static inline unsigned int nanddev_bbt_pos_to_entry(struct nand_device *nand, in nanddev_bbt_pos_to_entry() argument
1120 ((pos->lun + (pos->target * nand->memorg.luns_per_target)) * in nanddev_bbt_pos_to_entry()
1121 nand->memorg.eraseblocks_per_lun); in nanddev_bbt_pos_to_entry()
1126 * @nand: NAND device
1130 static inline bool nanddev_bbt_is_initialized(struct nand_device *nand) in nanddev_bbt_is_initialized() argument
1132 return !!nand->bbt.cache; in nanddev_bbt_is_initialized()
1135 /* MTD -> NAND helper functions. */