mtd: spi-nor: Replace default_init() hook with late_init()

default_init() is wrong, it contributes to the maze of initializing
flash parameters. We'd like to get rid of it because the flash
parameters that it initializes are not really used at SFDP parsing time,
thus they can be initialized later.

Ideally we want SFDP to initialize all the flash parameters. If (when)
SFDP tables are wrong, we fix them with the post_sfdp/bfpt hooks, to
emphasize that SFDP is indeed wrong. When there are parameters that are
not covered by SFDP, we initialize them in late_init() - these
parameters have nothing to do with SFDP and they are not needed earlier.
With this we'll have a clearer view of who initializes what.

There are six default_init() hooks implemented just for initializing
octal_dtr_enable() and/or setup() hooks that called later on.
Just moving those to late_init() does not change functionality.

Suggested-by: Tudor Ambarus <tudor.ambarus@linaro.org>
Acked-by: Tudor Ambarus <tudor.ambarus@linaro.org>
Signed-off-by: Takahiro Kuwano <Takahiro.Kuwano@infineon.com>

diff --git a/drivers/mtd/spi/spi-nor-core.c b/drivers/mtd/spi/spi-nor-core.c
index 466729cd2a7906db50a003cad6d56cd9323b5fcb..d076388223595cddd594e4191837ca3d42abb3eb 100644 (file)
--- a/drivers/mtd/spi/spi-nor-core.c
+++ b/drivers/mtd/spi/spi-nor-core.c
@@ -194,27 +194,27 @@ struct sfdp_bfpt {
 
 /**
  * struct spi_nor_fixups - SPI NOR fixup hooks
- * @default_init: called after default flash parameters init. Used to tweak
- *                flash parameters when information provided by the flash_info
- *                table is incomplete or wrong.
  * @post_bfpt: called after the BFPT table has been parsed
  * @post_sfdp: called after SFDP has been parsed (is also called for SPI NORs
  *             that do not support RDSFDP). Typically used to tweak various
  *             parameters that could not be extracted by other means (i.e.
  *             when information provided by the SFDP/flash_info tables are
  *             incomplete or wrong).
+ * @late_init: used to initialize flash parameters that are not declared in the
+ *             JESD216 SFDP standard, or where SFDP tables not defined at all.
  *
  * Those hooks can be used to tweak the SPI NOR configuration when the SFDP
  * table is broken or not available.
  */
 struct spi_nor_fixups {
-       void (*default_init)(struct spi_nor *nor);
        int (*post_bfpt)(struct spi_nor *nor,
                         const struct sfdp_parameter_header *bfpt_header,
                         const struct sfdp_bfpt *bfpt,
                         struct spi_nor_flash_parameter *params);
        void (*post_sfdp)(struct spi_nor *nor,
                          struct spi_nor_flash_parameter *params);
+       void (*late_init)(struct spi_nor *nor,
+                         struct spi_nor_flash_parameter *params);
 };
 
 #define SPI_NOR_SRST_SLEEP_LEN                 200
@@ -3060,10 +3060,11 @@ static void spi_nor_post_sfdp_fixups(struct spi_nor *nor,
                nor->fixups->post_sfdp(nor, params);
 }
 
-static void spi_nor_default_init_fixups(struct spi_nor *nor)
+static void spi_nor_late_init_fixups(struct spi_nor *nor,
+                                    struct spi_nor_flash_parameter *params)
 {
-       if (nor->fixups && nor->fixups->default_init)
-               nor->fixups->default_init(nor);
+       if (nor->fixups && nor->fixups->late_init)
+               nor->fixups->late_init(nor, params);
 }
 
 static int spi_nor_init_params(struct spi_nor *nor,
@@ -3177,8 +3178,6 @@ static int spi_nor_init_params(struct spi_nor *nor,
                }
        }
 
-       spi_nor_default_init_fixups(nor);
-
        /* Override the parameters with data read from SFDP tables. */
        nor->addr_width = 0;
        nor->mtd.erasesize = 0;
@@ -3252,6 +3251,7 @@ static int spi_nor_init_params(struct spi_nor *nor,
        }
 #endif
        spi_nor_post_sfdp_fixups(nor, params);
+       spi_nor_late_init_fixups(nor, params);
 
        return 0;
 }
@@ -3715,7 +3715,8 @@ static int s25fs_s_setup(struct spi_nor *nor, const struct flash_info *info,
        return spi_nor_default_setup(nor, info, params);
 }
 
-static void s25fs_s_default_init(struct spi_nor *nor)
+static void s25fs_s_late_init(struct spi_nor *nor,
+                             struct spi_nor_flash_parameter *params)
 {
        nor->setup = s25fs_s_setup;
 }
@@ -3765,9 +3766,9 @@ static void s25fs_s_post_sfdp_fixup(struct spi_nor *nor,
 }
 
 static struct spi_nor_fixups s25fs_s_fixups = {
-       .default_init = s25fs_s_default_init,
        .post_bfpt = s25fs_s_post_bfpt_fixup,
        .post_sfdp = s25fs_s_post_sfdp_fixup,
+       .late_init = s25fs_s_late_init,
 };
 
 static int s25_s28_mdp_ready(struct spi_nor *nor)
@@ -3851,7 +3852,8 @@ static int s25_s28_setup(struct spi_nor *nor, const struct flash_info *info,
        return spi_nor_default_setup(nor, info, params);
 }
 
-static void s25_default_init(struct spi_nor *nor)
+static void s25_late_init(struct spi_nor *nor,
+                         struct spi_nor_flash_parameter *params)
 {
        nor->setup = s25_s28_setup;
 }
@@ -3932,9 +3934,9 @@ static void s25_post_sfdp_fixup(struct spi_nor *nor,
 }
 
 static struct spi_nor_fixups s25_fixups = {
-       .default_init = s25_default_init,
        .post_bfpt = s25_s28_post_bfpt_fixup,
        .post_sfdp = s25_post_sfdp_fixup,
+       .late_init = s25_late_init,
 };
 
 static int s25fl256l_setup(struct spi_nor *nor, const struct flash_info *info,
@@ -3943,13 +3945,14 @@ static int s25fl256l_setup(struct spi_nor *nor, const struct flash_info *info,
        return -ENOTSUPP; /* Bank Address Register is not supported */
 }
 
-static void s25fl256l_default_init(struct spi_nor *nor)
+static void s25fl256l_late_init(struct spi_nor *nor,
+                               struct spi_nor_flash_parameter *params)
 {
        nor->setup = s25fl256l_setup;
 }
 
 static struct spi_nor_fixups s25fl256l_fixups = {
-       .default_init = s25fl256l_default_init,
+       .late_init = s25fl256l_late_init,
 };
 #endif
 
@@ -4012,7 +4015,8 @@ static int spi_nor_cypress_octal_dtr_enable(struct spi_nor *nor)
        return 0;
 }
 
-static void s28hx_t_default_init(struct spi_nor *nor)
+static void s28hx_t_late_init(struct spi_nor *nor,
+                             struct spi_nor_flash_parameter *params)
 {
        nor->octal_dtr_enable = spi_nor_cypress_octal_dtr_enable;
        nor->setup = s25_s28_setup;
@@ -4050,9 +4054,9 @@ static void s28hx_t_post_sfdp_fixup(struct spi_nor *nor,
 }
 
 static struct spi_nor_fixups s28hx_t_fixups = {
-       .default_init = s28hx_t_default_init,
        .post_sfdp = s28hx_t_post_sfdp_fixup,
        .post_bfpt = s25_s28_post_bfpt_fixup,
+       .late_init = s28hx_t_late_init,
 };
 #endif /* CONFIG_SPI_FLASH_S28HX_T */
 
@@ -4104,7 +4108,8 @@ static int spi_nor_micron_octal_dtr_enable(struct spi_nor *nor)
        return 0;
 }
 
-static void mt35xu512aba_default_init(struct spi_nor *nor)
+static void mt35xu512aba_late_init(struct spi_nor *nor,
+                                  struct spi_nor_flash_parameter *params)
 {
        nor->octal_dtr_enable = spi_nor_micron_octal_dtr_enable;
 }
@@ -4133,8 +4138,8 @@ static void mt35xu512aba_post_sfdp_fixup(struct spi_nor *nor,
 }
 
 static struct spi_nor_fixups mt35xu512aba_fixups = {
-       .default_init = mt35xu512aba_default_init,
        .post_sfdp = mt35xu512aba_post_sfdp_fixup,
+       .late_init = mt35xu512aba_late_init,
 };
 #endif /* CONFIG_SPI_FLASH_MT35XU */
 
@@ -4194,7 +4199,8 @@ static int spi_nor_macronix_octal_dtr_enable(struct spi_nor *nor)
        return 0;
 }
 
-static void macronix_octal_default_init(struct spi_nor *nor)
+static void macronix_octal_late_init(struct spi_nor *nor,
+                                    struct spi_nor_flash_parameter *params)
 {
        nor->octal_dtr_enable = spi_nor_macronix_octal_dtr_enable;
 }
@@ -4211,8 +4217,8 @@ static void macronix_octal_post_sfdp_fixup(struct spi_nor *nor,
 }
 
 static struct spi_nor_fixups macronix_octal_fixups = {
-       .default_init = macronix_octal_default_init,
        .post_sfdp = macronix_octal_post_sfdp_fixup,
+       .late_init = macronix_octal_late_init,
 };
 #endif /* CONFIG_SPI_FLASH_MACRONIX */