diff mbox

mtd: jz4780_nand: replace if/else blocks with switch/case

Message ID 1452189188-139318-1-git-send-email-computersforpeace@gmail.com
State Accepted
Commit 9146cbd52b11d4ade62dba8f238ec5e421c3fa2b
Headers show

Commit Message

Brian Norris Jan. 7, 2016, 5:53 p.m. UTC
Using switch/case helps make this logic more clear and more robust. With
this structure:

 * it's clear that this driver only support ECC_{HW,SOFT,SOFT_BCH}; and

 * we can sanely handle new ECC unsupported modes (right now, this code
   makes incorrect assumptions about the possible values in the
   nand_ecc_modes_t enum; e.g., what happens with NAND_ECC_HW_OOB_FIRST?)

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
Cc: Alex Smith <alex@alex-smith.me.uk>
Cc: Harvey Hunt <harvey.hunt@imgtec.com>
---
Compile tested only

 drivers/mtd/nand/jz4780_nand.c | 34 +++++++++++++++++++---------------
 1 file changed, 19 insertions(+), 15 deletions(-)

Comments

Boris Brezillon Jan. 8, 2016, 12:28 p.m. UTC | #1
On Thu,  7 Jan 2016 09:53:08 -0800
Brian Norris <computersforpeace@gmail.com> wrote:

> Using switch/case helps make this logic more clear and more robust. With
> this structure:
> 
>  * it's clear that this driver only support ECC_{HW,SOFT,SOFT_BCH}; and
> 
>  * we can sanely handle new ECC unsupported modes (right now, this code
>    makes incorrect assumptions about the possible values in the
>    nand_ecc_modes_t enum; e.g., what happens with NAND_ECC_HW_OOB_FIRST?)
> 
> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> Cc: Alex Smith <alex@alex-smith.me.uk>
> Cc: Harvey Hunt <harvey.hunt@imgtec.com>

LGTM

Reviewed-by: Boris Brezillon <boris.brezillon@free-electrons.com>

> ---
> Compile tested only
> 
>  drivers/mtd/nand/jz4780_nand.c | 34 +++++++++++++++++++---------------
>  1 file changed, 19 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/mtd/nand/jz4780_nand.c b/drivers/mtd/nand/jz4780_nand.c
> index 17eb9f264187..aabee8f5627e 100644
> --- a/drivers/mtd/nand/jz4780_nand.c
> +++ b/drivers/mtd/nand/jz4780_nand.c
> @@ -171,29 +171,33 @@ static int jz4780_nand_init_ecc(struct jz4780_nand_chip *nand, struct device *de
>  	chip->ecc.bytes = fls((1 + 8) * chip->ecc.size)	*
>  				(chip->ecc.strength / 8);
>  
> -	if (nfc->bch && chip->ecc.mode == NAND_ECC_HW) {
> +	switch (chip->ecc.mode) {
> +	case NAND_ECC_HW:
> +		if (!nfc->bch) {
> +			dev_err(dev, "HW BCH selected, but BCH controller not found\n");
> +			return -ENODEV;
> +		}
> +
>  		chip->ecc.hwctl = jz4780_nand_ecc_hwctl;
>  		chip->ecc.calculate = jz4780_nand_ecc_calculate;
>  		chip->ecc.correct = jz4780_nand_ecc_correct;
> -	} else if (!nfc->bch && chip->ecc.mode == NAND_ECC_HW) {
> -		dev_err(dev, "HW BCH selected, but BCH controller not found\n");
> -		return -ENODEV;
> -	}
> -
> -	if (chip->ecc.mode == NAND_ECC_HW_SYNDROME) {
> -		dev_err(dev, "ECC HW syndrome not supported\n");
> -		return -EINVAL;
> -	}
> -
> -	if (chip->ecc.mode != NAND_ECC_NONE)
> +		/* fall through */
> +	case NAND_ECC_SOFT:
> +	case NAND_ECC_SOFT_BCH:
>  		dev_info(dev, "using %s (strength %d, size %d, bytes %d)\n",
>  			(nfc->bch) ? "hardware BCH" : "software ECC",
>  			chip->ecc.strength, chip->ecc.size, chip->ecc.bytes);
> -	else
> +		break;
> +	case NAND_ECC_NONE:
>  		dev_info(dev, "not using ECC\n");
> +		break;
> +	default:
> +		dev_err(dev, "ECC mode %d not supported\n", chip->ecc.mode);
> +		return -EINVAL;
> +	}
>  
> -	/* The NAND core will generate the ECC layout. */
> -	if (chip->ecc.mode == NAND_ECC_SOFT || chip->ecc.mode == NAND_ECC_SOFT_BCH)
> +	/* The NAND core will generate the ECC layout for SW ECC */
> +	if (chip->ecc.mode != NAND_ECC_HW)
>  		return 0;
>  
>  	/* Generate ECC layout. ECC codes are right aligned in the OOB area. */
Harvey Hunt Jan. 8, 2016, 12:30 p.m. UTC | #2
Hi,

On 08/01/16 12:28, Boris Brezillon wrote:
> On Thu,  7 Jan 2016 09:53:08 -0800
> Brian Norris <computersforpeace@gmail.com> wrote:
>
>> Using switch/case helps make this logic more clear and more robust. With
>> this structure:
>>
>>   * it's clear that this driver only support ECC_{HW,SOFT,SOFT_BCH}; and
>>
>>   * we can sanely handle new ECC unsupported modes (right now, this code
>>     makes incorrect assumptions about the possible values in the
>>     nand_ecc_modes_t enum; e.g., what happens with NAND_ECC_HW_OOB_FIRST?)
>>
>> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
>> Cc: Alex Smith <alex@alex-smith.me.uk>
>> Cc: Harvey Hunt <harvey.hunt@imgtec.com>
>
> LGTM
>
> Reviewed-by: Boris Brezillon <boris.brezillon@free-electrons.com>
>

If it helps, I can add my Tested-By later today?

Harvey
Boris Brezillon Jan. 8, 2016, 12:41 p.m. UTC | #3
On Fri, 8 Jan 2016 12:30:32 +0000
Harvey Hunt <harvey.hunt@imgtec.com> wrote:

> Hi,
> 
> On 08/01/16 12:28, Boris Brezillon wrote:
> > On Thu,  7 Jan 2016 09:53:08 -0800
> > Brian Norris <computersforpeace@gmail.com> wrote:
> >
> >> Using switch/case helps make this logic more clear and more robust. With
> >> this structure:
> >>
> >>   * it's clear that this driver only support ECC_{HW,SOFT,SOFT_BCH}; and
> >>
> >>   * we can sanely handle new ECC unsupported modes (right now, this code
> >>     makes incorrect assumptions about the possible values in the
> >>     nand_ecc_modes_t enum; e.g., what happens with NAND_ECC_HW_OOB_FIRST?)
> >>
> >> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> >> Cc: Alex Smith <alex@alex-smith.me.uk>
> >> Cc: Harvey Hunt <harvey.hunt@imgtec.com>
> >
> > LGTM
> >
> > Reviewed-by: Boris Brezillon <boris.brezillon@free-electrons.com>
> >
> 
> If it helps, I can add my Tested-By later today?

Yes, that would be good, I only reviewed the changes, a real test would
confirm it does not break anything.
Harvey Hunt Jan. 8, 2016, 4:26 p.m. UTC | #4
Hi Brian,

On 07/01/16 17:53, Brian Norris wrote:
> Using switch/case helps make this logic more clear and more robust. With
> this structure:
>
>   * it's clear that this driver only support ECC_{HW,SOFT,SOFT_BCH}; and
>
>   * we can sanely handle new ECC unsupported modes (right now, this code
>     makes incorrect assumptions about the possible values in the
>     nand_ecc_modes_t enum; e.g., what happens with NAND_ECC_HW_OOB_FIRST?)
>
> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> Cc: Alex Smith <alex@alex-smith.me.uk>
> Cc: Harvey Hunt <harvey.hunt@imgtec.com>
> ---
> Compile tested only
>
>   drivers/mtd/nand/jz4780_nand.c | 34 +++++++++++++++++++---------------
>   1 file changed, 19 insertions(+), 15 deletions(-)
>
> diff --git a/drivers/mtd/nand/jz4780_nand.c b/drivers/mtd/nand/jz4780_nand.c
> index 17eb9f264187..aabee8f5627e 100644
> --- a/drivers/mtd/nand/jz4780_nand.c
> +++ b/drivers/mtd/nand/jz4780_nand.c
> @@ -171,29 +171,33 @@ static int jz4780_nand_init_ecc(struct jz4780_nand_chip *nand, struct device *de
>   	chip->ecc.bytes = fls((1 + 8) * chip->ecc.size)	*
>   				(chip->ecc.strength / 8);
>
> -	if (nfc->bch && chip->ecc.mode == NAND_ECC_HW) {
> +	switch (chip->ecc.mode) {
> +	case NAND_ECC_HW:
> +		if (!nfc->bch) {
> +			dev_err(dev, "HW BCH selected, but BCH controller not found\n");
> +			return -ENODEV;
> +		}
> +
>   		chip->ecc.hwctl = jz4780_nand_ecc_hwctl;
>   		chip->ecc.calculate = jz4780_nand_ecc_calculate;
>   		chip->ecc.correct = jz4780_nand_ecc_correct;
> -	} else if (!nfc->bch && chip->ecc.mode == NAND_ECC_HW) {
> -		dev_err(dev, "HW BCH selected, but BCH controller not found\n");
> -		return -ENODEV;
> -	}
> -
> -	if (chip->ecc.mode == NAND_ECC_HW_SYNDROME) {
> -		dev_err(dev, "ECC HW syndrome not supported\n");
> -		return -EINVAL;
> -	}
> -
> -	if (chip->ecc.mode != NAND_ECC_NONE)
> +		/* fall through */
> +	case NAND_ECC_SOFT:
> +	case NAND_ECC_SOFT_BCH:
>   		dev_info(dev, "using %s (strength %d, size %d, bytes %d)\n",
>   			(nfc->bch) ? "hardware BCH" : "software ECC",
>   			chip->ecc.strength, chip->ecc.size, chip->ecc.bytes);
> -	else
> +		break;
> +	case NAND_ECC_NONE:
>   		dev_info(dev, "not using ECC\n");
> +		break;
> +	default:
> +		dev_err(dev, "ECC mode %d not supported\n", chip->ecc.mode);
> +		return -EINVAL;
> +	}
>
> -	/* The NAND core will generate the ECC layout. */
> -	if (chip->ecc.mode == NAND_ECC_SOFT || chip->ecc.mode == NAND_ECC_SOFT_BCH)
> +	/* The NAND core will generate the ECC layout for SW ECC */
> +	if (chip->ecc.mode != NAND_ECC_HW)
>   		return 0;
>
>   	/* Generate ECC layout. ECC codes are right aligned in the OOB area. */
>

I've just tested this on a Ci20 and all seems well.

Tested-by: Harvey Hunt <harvey.hunt@imgtec.com>
Acked-by: Harvey Hunt <harvey.hunt@imgtec.com>

Thanks,

Harvey
Brian Norris Jan. 8, 2016, 5:49 p.m. UTC | #5
On Fri, Jan 08, 2016 at 04:26:48PM +0000, Harvey Hunt wrote:
> Hi Brian,
> 
> On 07/01/16 17:53, Brian Norris wrote:
> >Using switch/case helps make this logic more clear and more robust. With
> >this structure:
> >
> >  * it's clear that this driver only support ECC_{HW,SOFT,SOFT_BCH}; and
> >
> >  * we can sanely handle new ECC unsupported modes (right now, this code
> >    makes incorrect assumptions about the possible values in the
> >    nand_ecc_modes_t enum; e.g., what happens with NAND_ECC_HW_OOB_FIRST?)
> >
> >Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> >Cc: Alex Smith <alex@alex-smith.me.uk>
> >Cc: Harvey Hunt <harvey.hunt@imgtec.com>
> 
> I've just tested this on a Ci20 and all seems well.
> 
> Tested-by: Harvey Hunt <harvey.hunt@imgtec.com>
> Acked-by: Harvey Hunt <harvey.hunt@imgtec.com>

Great, applied to l2-mtd.git
diff mbox

Patch

diff --git a/drivers/mtd/nand/jz4780_nand.c b/drivers/mtd/nand/jz4780_nand.c
index 17eb9f264187..aabee8f5627e 100644
--- a/drivers/mtd/nand/jz4780_nand.c
+++ b/drivers/mtd/nand/jz4780_nand.c
@@ -171,29 +171,33 @@  static int jz4780_nand_init_ecc(struct jz4780_nand_chip *nand, struct device *de
 	chip->ecc.bytes = fls((1 + 8) * chip->ecc.size)	*
 				(chip->ecc.strength / 8);
 
-	if (nfc->bch && chip->ecc.mode == NAND_ECC_HW) {
+	switch (chip->ecc.mode) {
+	case NAND_ECC_HW:
+		if (!nfc->bch) {
+			dev_err(dev, "HW BCH selected, but BCH controller not found\n");
+			return -ENODEV;
+		}
+
 		chip->ecc.hwctl = jz4780_nand_ecc_hwctl;
 		chip->ecc.calculate = jz4780_nand_ecc_calculate;
 		chip->ecc.correct = jz4780_nand_ecc_correct;
-	} else if (!nfc->bch && chip->ecc.mode == NAND_ECC_HW) {
-		dev_err(dev, "HW BCH selected, but BCH controller not found\n");
-		return -ENODEV;
-	}
-
-	if (chip->ecc.mode == NAND_ECC_HW_SYNDROME) {
-		dev_err(dev, "ECC HW syndrome not supported\n");
-		return -EINVAL;
-	}
-
-	if (chip->ecc.mode != NAND_ECC_NONE)
+		/* fall through */
+	case NAND_ECC_SOFT:
+	case NAND_ECC_SOFT_BCH:
 		dev_info(dev, "using %s (strength %d, size %d, bytes %d)\n",
 			(nfc->bch) ? "hardware BCH" : "software ECC",
 			chip->ecc.strength, chip->ecc.size, chip->ecc.bytes);
-	else
+		break;
+	case NAND_ECC_NONE:
 		dev_info(dev, "not using ECC\n");
+		break;
+	default:
+		dev_err(dev, "ECC mode %d not supported\n", chip->ecc.mode);
+		return -EINVAL;
+	}
 
-	/* The NAND core will generate the ECC layout. */
-	if (chip->ecc.mode == NAND_ECC_SOFT || chip->ecc.mode == NAND_ECC_SOFT_BCH)
+	/* The NAND core will generate the ECC layout for SW ECC */
+	if (chip->ecc.mode != NAND_ECC_HW)
 		return 0;
 
 	/* Generate ECC layout. ECC codes are right aligned in the OOB area. */