[PATCH] mtd: spi-nor: hisi: Avoid generic function names

[PATCH] mtd: spi-nor: hisi: Avoid generic function names

[Ezequiel Garcia]

Using generic names such as get_if_type() is frowned
upon: it suggests a core function (which is not),
and then it makes code navigation harder.

Given drivers are often used as starting point
to write other drivers, generic names tend to spread
like the flu. Cure the problem.

Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
---
 drivers/mtd/spi-nor/hisi-sfc.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/mtd/spi-nor/hisi-sfc.c b/drivers/mtd/spi-nor/hisi-sfc.c
index 04f9fb5cd9b6..dea7b0c4b339 100644
--- a/drivers/mtd/spi-nor/hisi-sfc.c
+++ b/drivers/mtd/spi-nor/hisi-sfc.c
@@ -112,7 +112,7 @@ struct hifmc_host {
 	u32 num_chip;
 };
 
-static inline int wait_op_finish(struct hifmc_host *host)
+static inline int hisi_spi_nor_wait_op_finish(struct hifmc_host *host)
 {
 	u32 reg;
 
@@ -120,7 +120,7 @@ static inline int wait_op_finish(struct hifmc_host *host)
 		(reg & FMC_INT_OP_DONE), 0, FMC_WAIT_TIMEOUT);
 }
 
-static int get_if_type(enum spi_nor_protocol proto)
+static int hisi_spi_nor_get_if_type(enum spi_nor_protocol proto)
 {
 	enum hifmc_iftype if_type;
 
@@ -208,7 +208,7 @@ static int hisi_spi_nor_op_reg(struct spi_nor *nor,
 	reg = FMC_OP_CMD1_EN | FMC_OP_REG_OP_START | optype;
 	writel(reg, host->regbase + FMC_OP);
 
-	return wait_op_finish(host);
+	return hisi_spi_nor_wait_op_finish(host);
 }
 
 static int hisi_spi_nor_read_reg(struct spi_nor *nor, u8 opcode, u8 *buf,
@@ -259,9 +259,9 @@ static int hisi_spi_nor_dma_transfer(struct spi_nor *nor, loff_t start_off,
 
 	reg = OP_CFG_FM_CS(priv->chipselect);
 	if (op_type == FMC_OP_READ)
-		if_type = get_if_type(nor->read_proto);
+		if_type = hisi_spi_nor_get_if_type(nor->read_proto);
 	else
-		if_type = get_if_type(nor->write_proto);
+		if_type = hisi_spi_nor_get_if_type(nor->write_proto);
 	reg |= OP_CFG_MEM_IF_TYPE(if_type);
 	if (op_type == FMC_OP_READ)
 		reg |= OP_CFG_DUMMY_NUM(nor->read_dummy >> 3);
@@ -274,7 +274,7 @@ static int hisi_spi_nor_dma_transfer(struct spi_nor *nor, loff_t start_off,
 		: OP_CTRL_WR_OPCODE(nor->program_opcode);
 	writel(reg, host->regbase + FMC_OP_DMA);
 
-	return wait_op_finish(host);
+	return hisi_spi_nor_wait_op_finish(host);
 }
 
 static ssize_t hisi_spi_nor_read(struct spi_nor *nor, loff_t from, size_t len,
-- 
2.16.3

Re: [PATCH] mtd: spi-nor: hisi: Avoid generic function names

[Marek Vasut]

On 04/10/2018 10:01 PM, Ezequiel Garcia wrote:
> Using generic names such as get_if_type() is frowned
> upon: it suggests a core function (which is not),
> and then it makes code navigation harder.
> 
> Given drivers are often used as starting point
> to write other drivers, generic names tend to spread
> like the flu. Cure the problem.
> 
> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>

Reviewed-by: Marek Vasut <marek.vasut@gmail.com>

-- 
Best regards,
Marek Vasut

Re: [PATCH] mtd: spi-nor: hisi: Avoid generic function names

[Boris Brezillon]

On Tue, 10 Apr 2018 17:01:06 -0300
Ezequiel Garcia <ezequiel@collabora.com> wrote:

> Using generic names such as get_if_type() is frowned
> upon: it suggests a core function (which is not),
> and then it makes code navigation harder.
> 
> Given drivers are often used as starting point
> to write other drivers, generic names tend to spread
> like the flu. Cure the problem.
> 
> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>

Applied to spi-nor/next.

Thanks,

Boris

> ---
>  drivers/mtd/spi-nor/hisi-sfc.c | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/mtd/spi-nor/hisi-sfc.c b/drivers/mtd/spi-nor/hisi-sfc.c
> index 04f9fb5cd9b6..dea7b0c4b339 100644
> --- a/drivers/mtd/spi-nor/hisi-sfc.c
> +++ b/drivers/mtd/spi-nor/hisi-sfc.c
> @@ -112,7 +112,7 @@ struct hifmc_host {
>  	u32 num_chip;
>  };
>  
> -static inline int wait_op_finish(struct hifmc_host *host)
> +static inline int hisi_spi_nor_wait_op_finish(struct hifmc_host *host)
>  {
>  	u32 reg;
>  
> @@ -120,7 +120,7 @@ static inline int wait_op_finish(struct hifmc_host *host)
>  		(reg & FMC_INT_OP_DONE), 0, FMC_WAIT_TIMEOUT);
>  }
>  
> -static int get_if_type(enum spi_nor_protocol proto)
> +static int hisi_spi_nor_get_if_type(enum spi_nor_protocol proto)
>  {
>  	enum hifmc_iftype if_type;
>  
> @@ -208,7 +208,7 @@ static int hisi_spi_nor_op_reg(struct spi_nor *nor,
>  	reg = FMC_OP_CMD1_EN | FMC_OP_REG_OP_START | optype;
>  	writel(reg, host->regbase + FMC_OP);
>  
> -	return wait_op_finish(host);
> +	return hisi_spi_nor_wait_op_finish(host);
>  }
>  
>  static int hisi_spi_nor_read_reg(struct spi_nor *nor, u8 opcode, u8 *buf,
> @@ -259,9 +259,9 @@ static int hisi_spi_nor_dma_transfer(struct spi_nor *nor, loff_t start_off,
>  
>  	reg = OP_CFG_FM_CS(priv->chipselect);
>  	if (op_type == FMC_OP_READ)
> -		if_type = get_if_type(nor->read_proto);
> +		if_type = hisi_spi_nor_get_if_type(nor->read_proto);
>  	else
> -		if_type = get_if_type(nor->write_proto);
> +		if_type = hisi_spi_nor_get_if_type(nor->write_proto);
>  	reg |= OP_CFG_MEM_IF_TYPE(if_type);
>  	if (op_type == FMC_OP_READ)
>  		reg |= OP_CFG_DUMMY_NUM(nor->read_dummy >> 3);
> @@ -274,7 +274,7 @@ static int hisi_spi_nor_dma_transfer(struct spi_nor *nor, loff_t start_off,
>  		: OP_CTRL_WR_OPCODE(nor->program_opcode);
>  	writel(reg, host->regbase + FMC_OP_DMA);
>  
> -	return wait_op_finish(host);
> +	return hisi_spi_nor_wait_op_finish(host);
>  }
>  
>  static ssize_t hisi_spi_nor_read(struct spi_nor *nor, loff_t from, size_t len,