Correct the model names and descriptions for Pine64 boards

This series corrects and, in a couple of cases, additionally simplifies a bit the model names and the descriptions of a few Pine64 boards and devices based on Allwinner SoCs, according to their official names used in the Pine64 wiki and on the official Pine64 website. [1][2][3]

These corrections ensure consistency between the officially used Pine64 board names and the names and descriptions in the source code. These changes complete the correction of the model names and descriptions of the Pine64 boards and devices, which was started earlier with the Pine64 boards and devices based on Rockchip SoCs. [4][5]

Changes to the model names may cause certain issues if some scripts misuse /proc/device-tree/model to detect the board they're executed on. Though, the right way to detect a board is to use /proc/device-tree/compatible instead, because its contents is part of the ABI. Such scripts, if they actually exist in the field, should be improved to use the right way to detect the board model.

Link to v1: https://lore.kernel.org/linux-sunxi/d2943d9f4c99a239f86188eaf45a73972685c255.1713833436.git.dsimic@manjaro.org/T/#u

Changes in v2:
- Introduced this cover letter, partially by absorbing the notes from the original versions of the individual patches
- Collected a couple of tags, which should still apply after the v2 changes described in the following bullet point
- As pointed out by Icenowy [6] and Andre, [7] historical and factual accuracy trumps the naming consistency; after checking with Pine64, it was concluded not to perform any retroactive naming cleanups, but to preserve the history, so the v2 switches to the historically and factually accurate board names, and introduces a few additional naming corrections, for completeness
- Adjusted the patch descriptions according to the v2 changes

[1] https://wiki.pine64.org/wiki/PINE_A64
[2] https://wiki.pine64.org/wiki/PINE_H64
[3] https://pine64.org/devices/
[4] https://lore.kernel.org/linux-rockchip/ec124dab2b1a8776aa39177ecce34babca3a50e2.1713832790.git.dsimic@manjaro.org/
[5] https://lore.kernel.org/linux-rockchip/06ce014a1dedff11a785fe523056b3b8ffdf21ee.1713832790.git.dsimic@manjaro.org/
[6] https://lore.kernel.org/linux-sunxi/[email protected]/
[7] https://lore.kernel.org/linux-sunxi/[email protected]/

Dragan Simic (2):
dt-bindings: arm: sunxi: Correct the descriptions for Pine64 boards
arm64: dts: allwinner: Correct the model names for Pine64 boards

 Documentation/devicetree/bindings/arm/sunxi.yaml | 16 ++++++++--------
 .../boot/dts/allwinner/sun50i-a64-pine64-lts.dts |  2 +-
 .../dts/allwinner/sun50i-a64-pine64-plus.dts     |  2 +-
 .../boot/dts/allwinner/sun50i-a64-pine64.dts     |  2 +-
 .../boot/dts/allwinner/sun50i-a64-pinebook.dts   |  2 +-
 .../sun50i-a64-pinetab-early-adopter.dts         |  2 +-
 .../boot/dts/allwinner/sun50i-a64-pinetab.dts    |  2 +-
 .../allwinner/sun50i-a64-sopine-baseboard.dts    |  2 +-
 .../dts/allwinner/sun50i-h6-pine-h64-model-b.dts |  2 +-
 .../boot/dts/allwinner/sun50i-h6-pine-h64.dts    |  2 +-
 10 files changed, 17 insertions(+), 17 deletions(-)

Range-diff against v1:
1: 8deaf9d7d1b7 ! 1: 84cd1c708637 dt-bindings: arm: sunxi: Correct the descriptions for Pine64 boards
@@ Commit message
dt-bindings: arm: sunxi: Correct the descriptions for Pine64 boards

Correct the descriptions of a few Pine64 boards and devices, according
- to their official names used on the Pine64 wiki. This ensures consistency
- between the officially used names and the names in the source code.
+ to their official names used in the Pine64 wiki and on the official Pine64
+ website. [1][2][3] This ensures consistency between the officially used
+ names and the names in the source code.

+ [1] https://wiki.pine64.org/wiki/PINE_A64
+ [2] https://wiki.pine64.org/wiki/PINE_H64
+ [3] https://pine64.org/devices/
+
+ Reviewed-by: Rob Herring (Arm) <[email protected]>

-
- ## Notes ##
- This completes the correction of the descriptions of the Pine64 boards
- and devices, which was started with the Pine64 boards and devices based
- on Rockchip SoCs. [1]
-
- [1] https://lore.kernel.org/linux-rockchip/ec124dab2b1a8776aa39177ecce34babca3a50e2.1713832790.git.dsimic@manjaro.org/
-
## Documentation/devicetree/bindings/arm/sunxi.yaml ##
@@ Documentation/devicetree/bindings/arm/sunxi.yaml: properties:
+ - const: olimex,a64-teres-i
+ - const: allwinner,sun50i-a64
+
+- - description: Pine64
++ - description: Pine64 PINE A64
+ items:
+ - const: pine64,pine64
+ - const: allwinner,sun50i-a64
+
+- - description: Pine64+
++ - description: Pine64 PINE A64+
+ items:
+ - const: pine64,pine64-plus
+ - const: allwinner,sun50i-a64
+
+ - description: Pine64 PineCube
+ items:
+ - const: pine64,pinecube
- const: sochip,s3
- const: allwinner,sun8i-v3

- - description: Pine64 PineH64 model A
-+ - description: Pine64 H64 Model A
++ - description: Pine64 PINE H64 Model A
items:
- const: pine64,pine-h64
- const: allwinner,sun50i-h6

- - description: Pine64 PineH64 model B
-+ - description: Pine64 H64 Model B
++ - description: Pine64 PINE H64 Model B
items:
- const: pine64,pine-h64-model-b
- const: allwinner,sun50i-h6

- - description: Pine64 LTS
-+ - description: Pine64 A64 LTS
++ - description: Pine64 PINE A64 LTS
items:
- const: pine64,pine64-lts
- const: allwinner,sun50i-r18
@@ Documentation/devicetree/bindings/arm/sunxi.yaml: properties:
- const: allwinner,sun50i-a64

- - description: Pine64 SoPine Baseboard
-+ - description: Pine64 SOPine
++ - description: Pine64 SOPINE
items:
- const: pine64,sopine-baseboard
- const: pine64,sopine
2: fe5c35b78bef ! 2: 4a988518e0db arm64: dts: allwinner: Correct the model names for Pine64 boards

    @@ Commit message
         arm64: dts: allwinner: Correct the model names for Pine64 boards
     
         Correct the model names of a few Pine64 boards and devices, according
    -    to their official names used on the Pine64 wiki.  This ensures consistency
    -    between the officially used names and the names in the source code.
    +    to their official names used in the Pine64 wiki and on the official Pine64
    +    website. [1][2][3]  This ensures consistency between the officially used
    +    names and the names in the source code.
     
    +    [1] https://wiki.pine64.org/wiki/PINE_A64
    +    [2] https://wiki.pine64.org/wiki/PINE_H64
    +    [3] https://pine64.org/devices/
    +
    +    Acked-by: Jernej Skrabec <[email protected]>
         Cc: Marek Kraus <[email protected]>
         Signed-off-by: Dragan Simic <[email protected]>
     
    -
    - ## Notes ##
    -    This completes the correction of the model names of the Pine64 boards
    -    and devices, which was started with the Pine64 boards and devices based
    -    on Rockchip SoCs. [1]
    -
    -    These improvements may cause certain issues if some scripts misuse
    -    /proc/device-tree/model to detect the board they're executed on.  Though,
    -    the right way to detect a board is to use /proc/device-tree/compatible
    -    instead, because its contents is part of the ABI.  Such scripts, if they
    -    actually exist in the field, should be improved to use the right way to
    -    detect the board model.
    -
    -    [1] https://lore.kernel.org/linux-rockchip/06ce014a1dedff11a785fe523056b3b8ffdf21ee.1713832790.git.dsimic@manjaro.org/
    -
      ## arch/arm64/boot/dts/allwinner/sun50i-a64-pine64-lts.dts ##
     @@
      #include "sun50i-a64-sopine-baseboard.dts"
      
      / {
     -	model = "Pine64 LTS";
    -+	model = "Pine64 A64 LTS";
    ++	model = "Pine64 PINE A64 LTS";
      	compatible = "pine64,pine64-lts", "allwinner,sun50i-r18",
      		     "allwinner,sun50i-a64";
      
     
    + ## arch/arm64/boot/dts/allwinner/sun50i-a64-pine64-plus.dts ##
    +@@
    + #include "sun50i-a64-pine64.dts"
    + 
    + / {
    +-	model = "Pine64+";
    ++	model = "Pine64 PINE A64+";
    + 	compatible = "pine64,pine64-plus", "allwinner,sun50i-a64";
    + 
    + 	/* TODO: Camera, touchscreen, etc. */
    +
    + ## arch/arm64/boot/dts/allwinner/sun50i-a64-pine64.dts ##
    +@@
    + #include <dt-bindings/gpio/gpio.h>
    + 
    + / {
    +-	model = "Pine64";
    ++	model = "Pine64 PINE A64";
    + 	compatible = "pine64,pine64", "allwinner,sun50i-a64";
    + 
    + 	aliases {
    +
      ## arch/arm64/boot/dts/allwinner/sun50i-a64-pinebook.dts ##
     @@
      #include <dt-bindings/pwm/pwm.h>
    @@ arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts
      
      / {
     -	model = "SoPine with baseboard";
    -+	model = "Pine64 SOPine on Baseboard carrier board";
    ++	model = "Pine64 SOPINE on Baseboard carrier board";
      	compatible = "pine64,sopine-baseboard", "pine64,sopine",
      		     "allwinner,sun50i-a64";
      
     
      ## arch/arm64/boot/dts/allwinner/sun50i-h6-pine-h64-model-b.dts ##
     @@
      /delete-node/ &reg_gmac_3v3;
      
      / {
     -	model = "Pine H64 model B";
    -+	model = "Pine64 H64 Model B";
    ++	model = "Pine64 PINE H64 Model B";
      	compatible = "pine64,pine-h64-model-b", "allwinner,sun50i-h6";
      
      	wifi_pwrseq: pwrseq {
     
      ## arch/arm64/boot/dts/allwinner/sun50i-h6-pine-h64.dts ##
     @@
      #include <dt-bindings/gpio/gpio.h>
      
      / {
     -	model = "Pine H64 model A";
    -+	model = "Pine64 H64 Model A";
    ++	model = "Pine64 PINE H64 Model A";
      	compatible = "pine64,pine-h64", "allwinner,sun50i-h6";
      
      	aliases {

Correct the descriptions of a few Pine64 boards and devices, according to their official names used in the Pine64 wiki and on the official Pine64 website. [1][2][3] This ensures consistency between the officially used names and the names in the source code.

[1] https://wiki.pine64.org/wiki/PINE_A64
[2] https://wiki.pine64.org/wiki/PINE_H64
[3] https://pine64.org/devices/

---
 Documentation/devicetree/bindings/arm/sunxi.yaml | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

index c6d0d8d81ed4..3196dbeb0cbb 100644
@@ -708,33 +708,33 @@ properties:
           - const: olimex,a64-teres-i
           - const: allwinner,sun50i-a64
 
-      - description: Pine64
+      - description: Pine64 PINE A64
         items:
           - const: pine64,pine64
           - const: allwinner,sun50i-a64
 
-      - description: Pine64+
+      - description: Pine64 PINE A64+
         items:
           - const: pine64,pine64-plus
           - const: allwinner,sun50i-a64
 
       - description: Pine64 PineCube
         items:
           - const: pine64,pinecube
           - const: sochip,s3
           - const: allwinner,sun8i-v3
 
-      - description: Pine64 PineH64 model A
+      - description: Pine64 PINE H64 Model A
         items:
           - const: pine64,pine-h64
           - const: allwinner,sun50i-h6
 
-      - description: Pine64 PineH64 model B
+      - description: Pine64 PINE H64 Model B
         items:
           - const: pine64,pine-h64-model-b
           - const: allwinner,sun50i-h6
 
-      - description: Pine64 LTS
+      - description: Pine64 PINE A64 LTS
         items:
           - const: pine64,pine64-lts
           - const: allwinner,sun50i-r18

@@ -763,17 +763,17 @@ properties:
           - const: pine64,pinephone
           - const: allwinner,sun50i-a64
 
-      - description: Pine64 PineTab, Development Sample
+      - description: Pine64 PineTab Developer Sample
         items:
           - const: pine64,pinetab
           - const: allwinner,sun50i-a64
 
-      - description: Pine64 PineTab, Early Adopter's batch (and maybe later ones)
+      - description: Pine64 PineTab Early Adopter
         items:
           - const: pine64,pinetab-early-adopter
           - const: allwinner,sun50i-a64
 
-      - description: Pine64 SoPine Baseboard
+      - description: Pine64 SOPINE
         items:
           - const: pine64,sopine-baseboard
           - const: pine64,sopine

Correct the model names of a few Pine64 boards and devices, according to their official names used in the Pine64 wiki and on the official Pine64 website. [1][2][3] This ensures consistency between the officially used names and the names in the source code.

[1] https://wiki.pine64.org/wiki/PINE_A64
[2] https://wiki.pine64.org/wiki/PINE_H64
[3] https://pine64.org/devices/

---
 arch/arm64/boot/dts/allwinner/sun50i-a64-pine64-lts.dts         | 2 +-
 arch/arm64/boot/dts/allwinner/sun50i-a64-pine64-plus.dts        | 2 +-
 arch/arm64/boot/dts/allwinner/sun50i-a64-pine64.dts             | 2 +-
 arch/arm64/boot/dts/allwinner/sun50i-a64-pinebook.dts           | 2 +-
 .../boot/dts/allwinner/sun50i-a64-pinetab-early-adopter.dts     | 2 +-
 arch/arm64/boot/dts/allwinner/sun50i-a64-pinetab.dts            | 2 +-
 arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts   | 2 +-
 arch/arm64/boot/dts/allwinner/sun50i-h6-pine-h64-model-b.dts    | 2 +-
 arch/arm64/boot/dts/allwinner/sun50i-h6-pine-h64.dts            | 2 +-
 9 files changed, 9 insertions(+), 9 deletions(-)

index 596a25907432..709fe650a360 100644
@@ -5,7 +5,7 @@
 #include "sun50i-a64-sopine-baseboard.dts"
 
 / {
-	model = "Pine64 LTS";
+	model = "Pine64 PINE A64 LTS";
 	compatible = "pine64,pine64-lts", "allwinner,sun50i-r18",
 		     "allwinner,sun50i-a64";
 

index b54099b654c8..026d843cd7e0 100644
@@ -4,7 +4,7 @@
 #include "sun50i-a64-pine64.dts"
 
 / {
-	model = "Pine64+";
+	model = "Pine64 PINE A64+";
 	compatible = "pine64,pine64-plus", "allwinner,sun50i-a64";
 
 	/* TODO: Camera, touchscreen, etc. */

index 2accb5ddf783..09e71fd60785 100644
@@ -9,7 +9,7 @@
 #include <dt-bindings/gpio/gpio.h>
 
 / {
-	model = "Pine64";
+	model = "Pine64 PINE A64";
 	compatible = "pine64,pine64", "allwinner,sun50i-a64";
 
 	aliases {

index 6c65d5bc16ba..379c2c8466f5 100644
@@ -13,7 +13,7 @@
 #include <dt-bindings/pwm/pwm.h>
 
 / {
-	model = "Pinebook";
+	model = "Pine64 Pinebook";
 	compatible = "pine64,pinebook", "allwinner,sun50i-a64";
 	chassis-type = "laptop";
 

index 6265360ce623..86cc85eb3d48 100644
@@ -9,7 +9,7 @@
 #include "sun50i-a64-pinetab.dts"
 
 / {
-	model = "PineTab, Early Adopter's version";
+	model = "Pine64 PineTab Early Adopter";
 	compatible = "pine64,pinetab-early-adopter", "allwinner,sun50i-a64";
 };
 

index c6007df99938..f5fb1ee32dad 100644
@@ -14,7 +14,7 @@
 #include <dt-bindings/pwm/pwm.h>
 
 / {
-	model = "PineTab, Development Sample";
+	model = "Pine64 PineTab Developer Sample";
 	compatible = "pine64,pinetab", "allwinner,sun50i-a64";
 	chassis-type = "tablet";
 

index 5e66ce1a334f..be2347c8f267 100644
@@ -8,7 +8,7 @@
 #include "sun50i-a64-sopine.dtsi"
 
 / {
-	model = "SoPine with baseboard";
+	model = "Pine64 SOPINE on Baseboard carrier board";
 	compatible = "pine64,sopine-baseboard", "pine64,sopine",
 		     "allwinner,sun50i-a64";
 

index 66fe03910d5e..066fbeff8bfa 100644
@@ -8,7 +8,7 @@
 /delete-node/ &reg_gmac_3v3;
 
 / {
-	model = "Pine H64 model B";
+	model = "Pine64 PINE H64 Model B";
 	compatible = "pine64,pine-h64-model-b", "allwinner,sun50i-h6";
 
 	wifi_pwrseq: pwrseq {

index 3910393be1f9..c8b275552872 100644
@@ -9,7 +9,7 @@
 #include <dt-bindings/gpio/gpio.h>
 
 / {
-	model = "Pine H64 model A";
+	model = "Pine64 PINE H64 Model A";
 	compatible = "pine64,pine-h64", "allwinner,sun50i-h6";
 
 	aliases {

Applied to sunxi/dt-for-6.11 in sunxi/linux.git, thanks!

[1/2] dt-bindings: arm: sunxi: Correct the descriptions for Pine64 boards

      https://git.kernel.org/sunxi/linux/c/e1410c817ac4
[2/2] arm64: dts: allwinner: Correct the model names for Pine64 boards
      https://git.kernel.org/sunxi/linux/c/a72cf19bf50c

Best regards,

Chen-Yu Tsai <[email protected]>

I had to do a quick rebase as the branch start point was incorrect. The commit hashes will have changed. Rest assured that the patch is indeed merged.

ChenYu