Skip to contentSkip to conversation

phy: tusb1210: use bitmasks to set VENDOR_SPECIFIC2

PATCH Superseded Liam Beguin 4 participants 5 messages Aug 17, 2020 – Aug 22, 2020 Generic PHY framework

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 phy: tusb1210: use bitmasks to set VENDOR_SPECIFIC2

From: Liam Beguin <[email protected]>

Start by reading the content of the VENDOR_SPECIFIC2 register and update each bit field based on device properties when defined.

The use of bit masks prevents fields from overriding each other and enables users to clear bits which are set by default, like datapolarity in this instance.

---
Changes since v1:
- use set_mask_bits

Changes since v2:
- fix missing bit shift dropped in v2
- rebase on 5.9-rc1

 drivers/phy/ti/phy-tusb1210.c | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)
drivers/phy/ti/phy-tusb1210.c +17 -10
index d8d0cc11d187..358842b5790f 100644
@@ -14,8 +14,11 @@
 
 #define TUSB1210_VENDOR_SPECIFIC2		0x80
 #define TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT	0
+#define TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK	GENMASK(3, 0)
 #define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_SHIFT	4
+#define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_MASK	GENMASK(5, 4)
 #define TUSB1210_VENDOR_SPECIFIC2_DP_SHIFT	6
+#define TUSB1210_VENDOR_SPECIFIC2_DP_MASK	BIT(6)
 
 struct tusb1210 {
 	struct ulpi *ulpi;
@@ -118,23 +121,27 @@ static int tusb1210_probe(struct ulpi *ulpi)
 	 * diagram optimization and DP/DM swap.
 	 */
 
+	reg = ulpi_read(ulpi, TUSB1210_VENDOR_SPECIFIC2);
+
 	/* High speed output drive strength configuration */
-	device_property_read_u8(&ulpi->dev, "ihstx", &val);
-	reg = val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT;
+	if (!device_property_read_u8(&ulpi->dev, "ihstx", &val))
+		reg = set_mask_bits(&reg, TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK,
+				    val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT);
 
 	/* High speed output impedance configuration */
-	device_property_read_u8(&ulpi->dev, "zhsdrv", &val);
-	reg |= val << TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_SHIFT;
+	if (!device_property_read_u8(&ulpi->dev, "zhsdrv", &val))
+		reg = set_mask_bits(&reg, TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_MASK,
+				    val << TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_SHIFT);
 
 	/* DP/DM swap control */
-	device_property_read_u8(&ulpi->dev, "datapolarity", &val);
-	reg |= val << TUSB1210_VENDOR_SPECIFIC2_DP_SHIFT;
-
-	if (reg) {
-		ulpi_write(ulpi, TUSB1210_VENDOR_SPECIFIC2, reg);
-		tusb->vendor_specific2 = reg;
+	if (!device_property_read_u8(&ulpi->dev, "datapolarity", &val)) {
+		reg = set_mask_bits(&reg, TUSB1210_VENDOR_SPECIFIC2_DP_MASK,
+				    val << TUSB1210_VENDOR_SPECIFIC2_DP_SHIFT);
 	}
 
+	ulpi_write(ulpi, TUSB1210_VENDOR_SPECIFIC2, reg);
+	tusb->vendor_specific2 = reg;
+
 	tusb->phy = ulpi_phy_create(ulpi, &phy_ops);
 	if (IS_ERR(tusb->phy))
 		return PTR_ERR(tusb->phy);

base-commit: 9123e3a74ec7b934a4a099e98af6a61c2f80bbf5

Signature · 1 line
2.27.0
#1 lore raw
Thank you for the patch! Yet something to improve:

Hi Liam,

Thank you for the patch! Yet something to improve:

[auto build test ERROR on 9123e3a74ec7b934a4a099e98af6a61c2f80bbf5]

url:    https://github.com/0day-ci/linux/commits/Liam-Beguin/phy-tusb1210-use-bitmasks-to-set-VENDOR_SPECIFIC2/20200818-013719
base:    9123e3a74ec7b934a4a099e98af6a61c2f80bbf5
config: sh-allmodconfig (attached as .config)
compiler: sh4-linux-gcc (GCC) 9.3.0

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=sh

If you fix the issue, kindly add following tag as appropriate

All errors (new ones prefixed by >>, old ones prefixed by <<):

ERROR: modpost: "__delay" [drivers/net/phy/mdio-cavium.ko] undefined!

>> ERROR: modpost: "__cmpxchg_called_with_bad_pointer" [drivers/phy/ti/phy-tusb1210.ko] undefined!

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

#2 lore raw
In reply to Liam Beguin

Hi Liam,

Quoted 39 lines · Liam Beguin

From: Liam Beguin <[email protected]>

Start by reading the content of the VENDOR_SPECIFIC2 register and update each bit field based on device properties when defined.

The use of bit masks prevents fields from overriding each other and enables users to clear bits which are set by default, like datapolarity in this instance.

---
Changes since v1:
- use set_mask_bits

Changes since v2:
- fix missing bit shift dropped in v2
- rebase on 5.9-rc1

 drivers/phy/ti/phy-tusb1210.c | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)
drivers/phy/ti/phy-tusb1210.c +3 -0
index d8d0cc11d187..358842b5790f 100644
@@ -14,8 +14,11 @@
 
 #define TUSB1210_VENDOR_SPECIFIC2              0x80
 #define TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT  0
+#define TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK   GENMASK(3, 0)
 #define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_SHIFT 4
+#define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_MASK  GENMASK(5, 4)
 #define TUSB1210_VENDOR_SPECIFIC2_DP_SHIFT     6
+#define TUSB1210_VENDOR_SPECIFIC2_DP_MASK      BIT(6)
 
 struct tusb1210 {
        struct ulpi *ulpi;
@@ -118,23 +121,27 @@ static int tusb1210_probe(struct ulpi *ulpi)
         * diagram optimization and DP/DM swap.

drivers/phy/ti/phy-tusb1210.c static int tusb1210_probe(struct ulpi *ulpi) · line 129

Quoted 10 lines
drivers/phy/ti/phy-tusb1210.c +5 -2
         */
 
+       reg = ulpi_read(ulpi, TUSB1210_VENDOR_SPECIFIC2);
+
        /* High speed output drive strength configuration */
-       device_property_read_u8(&ulpi->dev, "ihstx", &val);
-       reg = val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT;
+       if (!device_property_read_u8(&ulpi->dev, "ihstx", &val))
+               reg = set_mask_bits(&reg, TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK,
+                                   val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT);

Triggered by your patches to add support for cmpxchg on u8 pointers to various architectures (which is a valuable goal in itself ;-), I decided to have a look at the underlying problem you were facing.

IMHO, using set_mask_bits() is overkill here. That helper is meant to update individual bits in a variable that may be accessed concurrently, hence its use of cmpxchg().

In this driver, you just want to modify a local variable, by clearing a field, and setting some bits. No concurrency is involved. Perhaps using FIELD_PREP() from include/linux/bitfield.h is more appropriate?

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds

maintainer
#3 lore raw
Quoted 58 lines · Geert Uytterhoeven

Hi Liam,

Quoted 39 lines · Liam Beguin

From: Liam Beguin <[email protected]>

Start by reading the content of the VENDOR_SPECIFIC2 register and update each bit field based on device properties when defined.

The use of bit masks prevents fields from overriding each other and enables users to clear bits which are set by default, like datapolarity in this instance.

---
Changes since v1:
- use set_mask_bits

Changes since v2:
- fix missing bit shift dropped in v2
- rebase on 5.9-rc1

 drivers/phy/ti/phy-tusb1210.c | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)
drivers/phy/ti/phy-tusb1210.c +3 -0
index d8d0cc11d187..358842b5790f 100644
@@ -14,8 +14,11 @@
 
 #define TUSB1210_VENDOR_SPECIFIC2              0x80
 #define TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT  0
+#define TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK   GENMASK(3, 0)
 #define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_SHIFT 4
+#define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_MASK  GENMASK(5, 4)
 #define TUSB1210_VENDOR_SPECIFIC2_DP_SHIFT     6
+#define TUSB1210_VENDOR_SPECIFIC2_DP_MASK      BIT(6)
 
 struct tusb1210 {
        struct ulpi *ulpi;
@@ -118,23 +121,27 @@ static int tusb1210_probe(struct ulpi *ulpi)
         * diagram optimization and DP/DM swap.

drivers/phy/ti/phy-tusb1210.c static int tusb1210_probe(struct ulpi *ulpi) · line 129

Quoted 10 lines
drivers/phy/ti/phy-tusb1210.c +5 -2
         */
 
+       reg = ulpi_read(ulpi, TUSB1210_VENDOR_SPECIFIC2);
+
        /* High speed output drive strength configuration */
-       device_property_read_u8(&ulpi->dev, "ihstx", &val);
-       reg = val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT;
+       if (!device_property_read_u8(&ulpi->dev, "ihstx", &val))
+               reg = set_mask_bits(&reg, TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK,
+                                   val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT);

Triggered by your patches to add support for cmpxchg on u8 pointers to various architectures (which is a valuable goal in itself ;-), I decided to have a look at the underlying problem you were facing.

Quoted 8 lines

IMHO, using set_mask_bits() is overkill here. That helper is meant to update individual bits in a variable that may be accessed concurrently, hence its use of cmpxchg().

In this driver, you just want to modify a local variable, by clearing a field, and setting some bits. No concurrency is involved. Perhaps using FIELD_PREP() from include/linux/bitfield.h is more appropriate?

Yeah i discovered the include/linux/bitfield.h and yes that looks more apt here. u32_encode_bits() would make sense here and get rid of mask and shift stuff too.

Signature · 1 line
~Vinod
#4 lore raw
In reply to Geert Uytterhoeven

Hi Geert,

Quoted 46 lines · Geert Uytterhoeven

Hi Liam,

Quoted 41 lines · Liam Beguin

From: Liam Beguin <[email protected]>

Start by reading the content of the VENDOR_SPECIFIC2 register and update each bit field based on device properties when defined.

The use of bit masks prevents fields from overriding each other and enables users to clear bits which are set by default, like datapolarity in this instance.

---
Changes since v1:
- use set_mask_bits

Changes since v2:
- fix missing bit shift dropped in v2
- rebase on 5.9-rc1

 drivers/phy/ti/phy-tusb1210.c | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)
drivers/phy/ti/phy-tusb1210.c +3 -0
index d8d0cc11d187..358842b5790f 100644
@@ -14,8 +14,11 @@
 
 #define TUSB1210_VENDOR_SPECIFIC2              0x80
 #define TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT  0
+#define TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK   GENMASK(3, 0)
 #define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_SHIFT 4
+#define TUSB1210_VENDOR_SPECIFIC2_ZHSDRV_MASK  GENMASK(5, 4)
 #define TUSB1210_VENDOR_SPECIFIC2_DP_SHIFT     6
+#define TUSB1210_VENDOR_SPECIFIC2_DP_MASK      BIT(6)
 
 struct tusb1210 {
        struct ulpi *ulpi;
@@ -118,23 +121,27 @@ static int tusb1210_probe(struct ulpi *ulpi)
         * diagram optimization and DP/DM swap.
         */
 
Quoted 13 lines

drivers/phy/ti/phy-tusb1210.c static int tusb1210_probe(struct ulpi *ulpi) · line 129

Quoted 8 lines
drivers/phy/ti/phy-tusb1210.c +5 -2
+       reg = ulpi_read(ulpi, TUSB1210_VENDOR_SPECIFIC2);
+
        /* High speed output drive strength configuration */
-       device_property_read_u8(&ulpi->dev, "ihstx", &val);
-       reg = val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT;
+       if (!device_property_read_u8(&ulpi->dev, "ihstx", &val))
+               reg = set_mask_bits(&reg, TUSB1210_VENDOR_SPECIFIC2_IHSTX_MASK,
+                                   val << TUSB1210_VENDOR_SPECIFIC2_IHSTX_SHIFT);

Triggered by your patches to add support for cmpxchg on u8 pointers to various architectures (which is a valuable goal in itself ;-), I decided to have a look at the underlying problem you were facing.

Thanks for taking the time to look at this, I'll still give the SuperH patch a try if I can test it properly :-).

Quoted 9 lines

IMHO, using set_mask_bits() is overkill here. That helper is meant to update individual bits in a variable that may be accessed concurrently, hence its use of cmpxchg().

In this driver, you just want to modify a local variable, by clearing a field, and setting some bits. No concurrency is involved. Perhaps using FIELD_PREP() from include/linux/bitfield.h is more appropriate?

Using set_mask_bits() does seem overkill seeing that it triggers all these kbot warnings...
I'll prepare a patch using functions from bitfield.h instead. Thanks again,

Liam

Quoted 13 lines

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds