Re: [PATCH V3 1/9] mtd: add more comment for ecc_strength/ecc_size

[Brian Norris]

I would recommend different wording, describing what they represent
rather than how we accomplish it. See below.

On Tue, Apr 23, 2013 at 1:54 AM, Huang Shijie <b32955@xxxxxxxxxxxxx> wrote:
> Add more commit for ecc_strength and ecc_size fields.
> We can treat the comment as the initial semantics for the two fields.
>
> Signed-off-by: Huang Shijie <b32955@xxxxxxxxxxxxx>
> ---
>  include/linux/mtd/nand.h |    4 +++-
>  1 files changed, 3 insertions(+), 1 deletions(-)
>
> diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
> index 5458021..c1cc690 100644
> --- a/include/linux/mtd/nand.h
> +++ b/include/linux/mtd/nand.h
> @@ -436,7 +436,9 @@ struct nand_buffers {
>   * @cellinfo:          [INTERN] MLC/multichip data from chip ident
>   * @ecc_strength:      [INTERN] ECC correctability from the datasheet.

How about just: "minimum number of bits correctability, if known; if
unknown, set to 0

>   * @ecc_size:          [INTERN] ECC size required by the @ecc_strength,
> - *                      also from the datasheet.
> + *                      also from the datasheet. If we do not know the
> + *                     @ecc_size and @ecc_strength of the nand chips, we can
> + *                     set zeros to them which are the default value.

"recommend ECC step size, if known; if unknown, set to 0"

>   * @numchips:          [INTERN] number of physical chips
>   * @chipsize:          [INTERN] the size of one chip for multichip arrays
>   * @pagemask:          [INTERN] page number mask = number of (pages / chip) - 1

Brian
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/