Patchwork [V3,1/9] mtd: add more comment for ecc_strength/ecc_size

login
register
mail settings
Submitter Huang Shijie
Date April 23, 2013, 8:54 a.m.
Message ID <1366707297-31309-2-git-send-email-b32955@freescale.com>
Download mbox | patch
Permalink /patch/238810/
State New
Headers show

Comments

Huang Shijie - April 23, 2013, 8:54 a.m.
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@freescale.com>
---
 include/linux/mtd/nand.h |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
Brian Norris - April 25, 2013, 6:32 a.m.
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@freescale.com> 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@freescale.com>
> ---
>  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
Huang Shijie - April 25, 2013, 6:39 a.m.
于 2013年04月25日 14:32, Brian Norris 写道:
>>    * @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
>
Huang Shijie - April 25, 2013, 6:40 a.m.
于 2013年04月25日 14:32, Brian Norris 写道:
> How about just: "minimum number of bits correctability, if known; if
> unknown, set to 0
>
ok. no problem.

thanks
Huang Shijie

Patch

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.
  * @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.
  * @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