[PATCH v2 0/4] clk drivers: Terminate clk_div_table with sentinel element

[PATCH v2 0/4] clk drivers: Terminate clk_div_table with sentinel element

[Jonathan Neuschäfer]

I noticed that some of the clk_div_tables in different drivers are not
terminated with a sentinel element. This may cause the code in
clk-divider.c to read garbage that happens to be beyond the end.

This patchset fixed all instances of this bug that I could find, except
for a case in drivers/phy/ti/phy-j721e-wiz.c that is already fixed in
linux-next:
  https://lore.kernel.org/lkml/20220117110108.4117-1-kishon@ti.com/

v2:
- Add Fixes tags

Jonathan Neuschäfer (4):
  clk: actions: Terminate clk_div_table with sentinel element
  clk: loongson1: Terminate clk_div_table with sentinel element
  clk: hisilicon: Terminate clk_div_table with sentinel element
  clk: clps711x: Terminate clk_div_table with sentinel element

 drivers/clk/actions/owl-s700.c         | 1 +
 drivers/clk/actions/owl-s900.c         | 4 ++--
 drivers/clk/clk-clps711x.c             | 2 ++
 drivers/clk/hisilicon/clk-hi3559a.c    | 4 ++--
 drivers/clk/loongson1/clk-loongson1c.c | 1 +
 5 files changed, 8 insertions(+), 4 deletions(-)

--
2.34.1

[PATCH v2 1/4] clk: actions: Terminate clk_div_table with sentinel element

[Jonathan Neuschäfer]

In order that the end of a clk_div_table can be detected, it must be
terminated with a sentinel element (.div = 0).

Fixes: d47317ca4ade1 ("clk: actions: Add S700 SoC clock support")
Fixes: d85d20053e195 ("clk: actions: Add S900 SoC clock support")
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---

I'm not so sure about usb3_mac_div_table. Maybe the { 0, 8 } element was
meant to be { 0, 0 }? I'd appreciate if someone with access to the
datasheet or hardware could verify what's correct.

v2:
- Add Fixes tags
---
 drivers/clk/actions/owl-s700.c | 1 +
 drivers/clk/actions/owl-s900.c | 4 ++--
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/clk/actions/owl-s700.c b/drivers/clk/actions/owl-s700.c
index a2f34d13fb543..617174644f728 100644
--- a/drivers/clk/actions/owl-s700.c
+++ b/drivers/clk/actions/owl-s700.c
@@ -162,6 +162,7 @@ static struct clk_div_table hdmia_div_table[] = {

 static struct clk_div_table rmii_div_table[] = {
 	{0, 4},   {1, 10},
+	{0, 0},
 };

 /* divider clocks */
diff --git a/drivers/clk/actions/owl-s900.c b/drivers/clk/actions/owl-s900.c
index 790890978424a..f6f49100a865b 100644
--- a/drivers/clk/actions/owl-s900.c
+++ b/drivers/clk/actions/owl-s900.c
@@ -139,8 +139,8 @@ static struct clk_div_table rmii_ref_div_table[] = {
 };

 static struct clk_div_table usb3_mac_div_table[] = {
-	{ 1, 2 }, { 2, 3 }, { 3, 4 },
-	{ 0, 8 },
+	{ 1, 2 }, { 2, 3 }, { 3, 4 }, { 0, 8 },
+	{ 0, 0 },
 };

 static struct clk_div_table i2s_div_table[] = {
--
2.34.1

Re: [PATCH v2 1/4] clk: actions: Terminate clk_div_table with sentinel element

[Manivannan Sadhasivam]

On Thu, Feb 03, 2022 at 03:21:50PM +0100, Jonathan Neuschäfer wrote:
> In order that the end of a clk_div_table can be detected, it must be
> terminated with a sentinel element (.div = 0).
> 
> Fixes: d47317ca4ade1 ("clk: actions: Add S700 SoC clock support")
> Fixes: d85d20053e195 ("clk: actions: Add S900 SoC clock support")
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> ---
> 
> I'm not so sure about usb3_mac_div_table. Maybe the { 0, 8 } element was
> meant to be { 0, 0 }? I'd appreciate if someone with access to the
> datasheet or hardware could verify what's correct.

USB3 factor table is not documented in the datasheet I have access to. But by
looking at the value, it looks to be a typo. So please change the last entry.
With that,

Reviewed-by: Manivannan Sadhasivam <mani@kernel.org>

Thanks,
Mani

> 
> v2:
> - Add Fixes tags
> ---
>  drivers/clk/actions/owl-s700.c | 1 +
>  drivers/clk/actions/owl-s900.c | 4 ++--
>  2 files changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/clk/actions/owl-s700.c b/drivers/clk/actions/owl-s700.c
> index a2f34d13fb543..617174644f728 100644
> --- a/drivers/clk/actions/owl-s700.c
> +++ b/drivers/clk/actions/owl-s700.c
> @@ -162,6 +162,7 @@ static struct clk_div_table hdmia_div_table[] = {
> 
>  static struct clk_div_table rmii_div_table[] = {
>  	{0, 4},   {1, 10},
> +	{0, 0},
>  };
> 
>  /* divider clocks */
> diff --git a/drivers/clk/actions/owl-s900.c b/drivers/clk/actions/owl-s900.c
> index 790890978424a..f6f49100a865b 100644
> --- a/drivers/clk/actions/owl-s900.c
> +++ b/drivers/clk/actions/owl-s900.c
> @@ -139,8 +139,8 @@ static struct clk_div_table rmii_ref_div_table[] = {
>  };
> 
>  static struct clk_div_table usb3_mac_div_table[] = {
> -	{ 1, 2 }, { 2, 3 }, { 3, 4 },
> -	{ 0, 8 },
> +	{ 1, 2 }, { 2, 3 }, { 3, 4 }, { 0, 8 },
> +	{ 0, 0 },
>  };
> 
>  static struct clk_div_table i2s_div_table[] = {
> --
> 2.34.1
> 

Re: [PATCH v2 1/4] clk: actions: Terminate clk_div_table with sentinel element

[Jonathan Neuschäfer]

[-- Attachment #1: Type: text/plain, Size: 979 bytes --]

On Thu, Feb 03, 2022 at 09:42:10PM +0530, Manivannan Sadhasivam wrote:
> On Thu, Feb 03, 2022 at 03:21:50PM +0100, Jonathan Neuschäfer wrote:
> > In order that the end of a clk_div_table can be detected, it must be
> > terminated with a sentinel element (.div = 0).
> > 
> > Fixes: d47317ca4ade1 ("clk: actions: Add S700 SoC clock support")
> > Fixes: d85d20053e195 ("clk: actions: Add S900 SoC clock support")
> > Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> > ---
> > 
> > I'm not so sure about usb3_mac_div_table. Maybe the { 0, 8 } element was
> > meant to be { 0, 0 }? I'd appreciate if someone with access to the
> > datasheet or hardware could verify what's correct.
> 
> USB3 factor table is not documented in the datasheet I have access to. But by
> looking at the value, it looks to be a typo. So please change the last entry.

Okay.

> With that,
> 
> Reviewed-by: Manivannan Sadhasivam <mani@kernel.org>

Thanks!

Jonathan

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[PATCH v2 2/4] clk: loongson1: Terminate clk_div_table with sentinel element

[Jonathan Neuschäfer]

In order that the end of a clk_div_table can be detected, it must be
terminated with a sentinel element (.div = 0).

Fixes: b4626a7f4892 ("CLK: Add Loongson1C clock support")
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---

v2:
- Add Fixes and R-b tags
- Change sentinel element a bit
---
 drivers/clk/loongson1/clk-loongson1c.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/clk/loongson1/clk-loongson1c.c b/drivers/clk/loongson1/clk-loongson1c.c
index 703f87622cf5f..a6f9f20fc8b99 100644
--- a/drivers/clk/loongson1/clk-loongson1c.c
+++ b/drivers/clk/loongson1/clk-loongson1c.c
@@ -37,6 +37,7 @@ static const struct clk_div_table ahb_div_table[] = {
 	[1] = { .val = 1, .div = 4 },
 	[2] = { .val = 2, .div = 3 },
 	[3] = { .val = 3, .div = 3 },
+	[4] = { /* sentinel */ },
 };

 void __init ls1x_clk_init(void)
--
2.34.1

[PATCH v2 3/4] clk: hisilicon: Terminate clk_div_table with sentinel element

[Jonathan Neuschäfer]

In order that the end of a clk_div_table can be detected, it must be
terminated with a sentinel element (.div = 0).

Fixes: 6c81966107dc0 ("clk: hisilicon: Add clock driver for hi3559A SoC")
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---

v2:
- Add Fixes tag
---
 drivers/clk/hisilicon/clk-hi3559a.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/clk/hisilicon/clk-hi3559a.c b/drivers/clk/hisilicon/clk-hi3559a.c
index 56012a3d02192..28c2a0630474d 100644
--- a/drivers/clk/hisilicon/clk-hi3559a.c
+++ b/drivers/clk/hisilicon/clk-hi3559a.c
@@ -611,8 +611,8 @@ static struct hisi_mux_clock hi3559av100_shub_mux_clks[] = {


 /* shub div clk */
-static struct clk_div_table shub_spi_clk_table[] = {{0, 8}, {1, 4}, {2, 2}};
-static struct clk_div_table shub_uart_div_clk_table[] = {{1, 8}, {2, 4}};
+static struct clk_div_table shub_spi_clk_table[] = {{0, 8}, {1, 4}, {2, 2}, {}};
+static struct clk_div_table shub_uart_div_clk_table[] = {{1, 8}, {2, 4}, {}};

 static struct hisi_divider_clock hi3559av100_shub_div_clks[] = {
 	{ HI3559AV100_SHUB_SPI_SOURCE_CLK, "clk_spi_clk", "shub_clk", 0, 0x20, 24, 2,
--
2.34.1

[PATCH v2 4/4] clk: clps711x: Terminate clk_div_table with sentinel element

[Jonathan Neuschäfer]

In order that the end of a clk_div_table can be detected, it must be
terminated with a sentinel element (.div = 0).

Fixes: 631c53478973d ("clk: Add CLPS711X clk driver")
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---

v2:
- Add Fixes tag
---
 drivers/clk/clk-clps711x.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/clk/clk-clps711x.c b/drivers/clk/clk-clps711x.c
index a2c6486ef1708..d96d96c8752c7 100644
--- a/drivers/clk/clk-clps711x.c
+++ b/drivers/clk/clk-clps711x.c
@@ -28,11 +28,13 @@ static const struct clk_div_table spi_div_table[] = {
 	{ .val = 1, .div = 8, },
 	{ .val = 2, .div = 2, },
 	{ .val = 3, .div = 1, },
+	{}
 };

 static const struct clk_div_table timer_div_table[] = {
 	{ .val = 0, .div = 256, },
 	{ .val = 1, .div = 1, },
+	{}
 };

 struct clps711x_clk {
--
2.34.1