Documentation/driver-api/mtdnand.rst

357 Hardware ECC support
363 The nand driver supports three different types of hardware ECC.
367    Hardware ECC generator providing 3 bytes ECC per 256 byte.
371    Hardware ECC generator providing 3 bytes ECC per 512 byte.
375    Hardware ECC generator providing 6 bytes ECC per 512 byte.
379    Hardware ECC generator providing 8 bytes ECC per 512 byte.
396    Transfer the ECC from the hardware to the buffer. If the option
402    In case of an ECC error this function is called for error detection
409 Hardware ECC with syndrome calculation
412 Many hardware ECC implementations provide Reed-Solomon codes and
417 The ECC bytes must be placed immediately after the data bytes in order
419 layout used by software ECC. The separation of data and out of band area
424 use bad block tables on FLASH, because the ECC layout is interfering
612 to hardware ECC functionality the default placement does not fit then
632    The useecc member controls the ecc and placement function. The header
633    file include/mtd/mtd-abi.h contains constants to select ecc and
634    placement. MTD_NANDECC_OFF switches off the ecc complete. This is
641    The eccbytes member defines the number of ecc bytes per page.
646    ecc codes are placed.
660 which defines the ecc placement. For writes the caller must provide a
663 is (number of pages) \* ((size of spare area) + (number of ecc steps per
664 page) \* sizeof (int)). The driver stores the result of the ecc check
667 	<spare data page 0><ecc result 0>...<ecc result n>
671 	<spare data page n><ecc result 0>...<ecc result n>
675 If the spare area buffer is NULL then only the ECC placement is done
681 Automatic placement uses the built in defaults to place the ecc bytes in
687 If the spare area buffer is NULL then only the ECC placement is done
699 0x00     ECC byte 0         Error correction code byte 0
700 0x01     ECC byte 1         Error correction code byte 1
701 0x02     ECC byte 2         Error correction code byte 2
719 0x00          ECC byte 0         Error correction code byte 0 of the lower
721 0x01          ECC byte 1         Error correction code byte 1 of the lower
723 0x02          ECC byte 2         Error correction code byte 2 of the lower
725 0x03          ECC byte 3         Error correction code byte 0 of the upper
732 0x06          ECC byte 4         Error correction code byte 1 of the upper
734 0x07          ECC byte 5         Error correction code byte 2 of the upper
751 0x28        ECC byte 0         Error correction code byte 0 of the first
753 0x29        ECC byte 1         Error correction code byte 1 of the first
755 0x2A        ECC byte 2         Error correction code byte 2 of the first
757 0x2B        ECC byte 3         Error correction code byte 0 of the second
759 0x2C        ECC byte 4         Error correction code byte 1 of the second
761 0x2D        ECC byte 5         Error correction code byte 2 of the second
763 0x2E        ECC byte 6         Error correction code byte 0 of the third
765 0x2F        ECC byte 7         Error correction code byte 1 of the third
767 0x30        ECC byte 8         Error correction code byte 2 of the third
769 0x31        ECC byte 9         Error correction code byte 0 of the fourth
771 0x32        ECC byte 10        Error correction code byte 1 of the fourth
773 0x33        ECC byte 11        Error correction code byte 2 of the fourth
775 0x34        ECC byte 12        Error correction code byte 0 of the fifth
777 0x35        ECC byte 13        Error correction code byte 1 of the fifth
779 0x36        ECC byte 14        Error correction code byte 2 of the fifth
781 0x37        ECC byte 15        Error correction code byte 0 of the sixth
783 0x38        ECC byte 16        Error correction code byte 1 of the sixth
785 0x39        ECC byte 17        Error correction code byte 2 of the sixth
787 0x3A        ECC byte 18        Error correction code byte 0 of the seventh
789 0x3B        ECC byte 19        Error correction code byte 1 of the seventh
791 0x3C        ECC byte 20        Error correction code byte 2 of the seventh
793 0x3D        ECC byte 21        Error correction code byte 0 of the eighth
795 0x3E        ECC byte 22        Error correction code byte 1 of the eighth
797 0x3F        ECC byte 23        Error correction code byte 2 of the eighth
873     /* The hw ecc generator provides a syndrome instead a ecc value on read
874      * This can only work if we have the ecc bytes directly behind the
879 ECC selection constants
882 Use these constants to select the ECC algorithm::
884     /* No ECC. Usage is not recommended ! */
886     /* Software ECC 3 byte ECC per 256 Byte data */
888     /* Hardware ECC 3 byte ECC per 256 Byte data */
890     /* Hardware ECC 3 byte ECC per 512 Byte data */
892     /* Hardware ECC 6 byte ECC per 512 Byte data */
894     /* Hardware ECC 8 byte ECC per 512 Byte data */