[PATCH] Documentation: Standardize DTS examples to use status "okay", not "ok"

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



While the current kernel code in drivers/of/ allows developers to be
sloppy and use a status value of "ok" in DTS files, the current DTSpec
0.1 makes it clear that the only acceptable spelling of that is
"okay". There's quite a lot of this scattered throughout the kernel
source, but this patch cleans up everything under Documentation/.

Signed-off-by: Robert P. J. Day <rpjday@xxxxxxxxxxxxxx>

---

diff --git a/Documentation/devicetree/bindings/ata/apm-xgene.txt b/Documentation/devicetree/bindings/ata/apm-xgene.txt
index a668f0e..c9fb110 100644
--- a/Documentation/devicetree/bindings/ata/apm-xgene.txt
+++ b/Documentation/devicetree/bindings/ata/apm-xgene.txt
@@ -25,8 +25,8 @@ Required properties:

 Optional properties:
 - dma-coherent		: Present if dma operations are coherent
-- status		: Shall be "ok" if enabled or "disabled" if disabled.
-			  Default is "ok".
+- status		: Shall be "okay" if enabled or "disabled" if disabled.
+			  Default is "okay".

 Example:
 		sataclk: sataclk {
@@ -57,7 +57,7 @@ Example:
 			      <0x0 0x1f227000 0x0 0x1000>;
 			interrupts = <0x0 0x87 0x4>;
 			dma-coherent;
-			status = "ok";
+			status = "okay";
 			clocks = <&sataclk 0>;
 			phys = <&phy2 0>;
 			phy-names = "sata-phy";
@@ -72,7 +72,7 @@ Example:
 			      <0x0 0x1f237000 0x0 0x1000>;
 			interrupts = <0x0 0x88 0x4>;
 			dma-coherent;
-			status = "ok";
+			status = "okay";
 			clocks = <&sataclk 0>;
 			phys = <&phy3 0>;
 			phy-names = "sata-phy";
diff --git a/Documentation/devicetree/bindings/display/hisilicon/dw-dsi.txt b/Documentation/devicetree/bindings/display/hisilicon/dw-dsi.txt
index d270bfe..34f3dde 100644
--- a/Documentation/devicetree/bindings/display/hisilicon/dw-dsi.txt
+++ b/Documentation/devicetree/bindings/display/hisilicon/dw-dsi.txt
@@ -42,7 +42,7 @@ SoC specific:

 Board specific:
 	&dsi {
-		status = "ok";
+		status = "okay";

 		ports {
 			/* 1 for output port */
diff --git a/Documentation/devicetree/bindings/display/ti/ti,omap-dss.txt b/Documentation/devicetree/bindings/display/ti/ti,omap-dss.txt
index e1ef295..b6c5eb3 100644
--- a/Documentation/devicetree/bindings/display/ti/ti,omap-dss.txt
+++ b/Documentation/devicetree/bindings/display/ti/ti,omap-dss.txt
@@ -183,7 +183,7 @@ OMAP HDMI --(HDMI)--> TPD12S015 --(HDMI)--> HDMI Connector
 };

 &dss {
-	status = "ok";
+	status = "okay";

 	pinctrl-names = "default";
 	pinctrl-0 = <&dss_dpi_pins>;
@@ -197,7 +197,7 @@ OMAP HDMI --(HDMI)--> TPD12S015 --(HDMI)--> HDMI Connector
 };

 &hdmi {
-	status = "ok";
+	status = "okay";
 	vdda-supply = <&vdac>;

 	pinctrl-names = "default";
diff --git a/Documentation/devicetree/bindings/dma/qcom_adm.txt b/Documentation/devicetree/bindings/dma/qcom_adm.txt
index 9bcab91..bb6b97e 100644
--- a/Documentation/devicetree/bindings/dma/qcom_adm.txt
+++ b/Documentation/devicetree/bindings/dma/qcom_adm.txt
@@ -48,7 +48,7 @@ Each dmas request consists of 3 cells:
 Example:

 	spi4: spi@1a280000 {
-		status = "ok";
+		status = "okay";
 		spi-max-frequency = <50000000>;

 		pinctrl-0 = <&spi_pins>;
diff --git a/Documentation/devicetree/bindings/i2c/i2c-efm32.txt b/Documentation/devicetree/bindings/i2c/i2c-efm32.txt
index 50b25c3..c8bc220 100644
--- a/Documentation/devicetree/bindings/i2c/i2c-efm32.txt
+++ b/Documentation/devicetree/bindings/i2c/i2c-efm32.txt
@@ -22,7 +22,7 @@ Example:
 		interrupts = <9>;
 		clocks = <&cmu clk_HFPERCLKI2C0>;
 		clock-frequency = <100000>;
-		status = "ok";
+		status = "okay";
 		energymicro,location = <3>;

 		eeprom@50 {
diff --git a/Documentation/devicetree/bindings/media/rcar_vin.txt b/Documentation/devicetree/bindings/media/rcar_vin.txt
index 6e4ef8c..033246a 100644
--- a/Documentation/devicetree/bindings/media/rcar_vin.txt
+++ b/Documentation/devicetree/bindings/media/rcar_vin.txt
@@ -56,7 +56,7 @@ Board setup example (vin1 composite video input)
 ------------------------------------------------

 &i2c2   {
-        status = "ok";
+        status = "okay";
         pinctrl-0 = <&i2c2_pins>;
         pinctrl-names = "default";

@@ -79,7 +79,7 @@ Board setup example (vin1 composite video input)
         pinctrl-0 = <&vin1_pins>;
         pinctrl-names = "default";

-        status = "ok";
+        status = "okay";

         port {
                 #address-cells = <1>;
diff --git a/Documentation/devicetree/bindings/net/apm-xgene-enet.txt b/Documentation/devicetree/bindings/net/apm-xgene-enet.txt
index f591ab7..20c6498 100644
--- a/Documentation/devicetree/bindings/net/apm-xgene-enet.txt
+++ b/Documentation/devicetree/bindings/net/apm-xgene-enet.txt
@@ -38,7 +38,7 @@ Required properties for ethernet interfaces that have external PHY:
   - reg: The ID number for the phy.

 Optional properties:
-- status: Should be "ok" or "disabled" for enabled/disabled. Default is "ok".
+- status: Should be "okay" or "disabled" for enabled/disabled. Default is "okay".
 - tx-delay: Delay value for RGMII bridge TX clock.
 	    Valid values are between 0 to 7, that maps to
 	    417, 717, 1020, 1321, 1611, 1913, 2215, 2514 ps
@@ -55,7 +55,7 @@ Example:
 	menetclk: menetclk {
 		compatible = "apm,xgene-device-clock";
 		clock-output-names = "menetclk";
-		status = "ok";
+		status = "okay";
 	};

 	menet: ethernet@17020000 {
@@ -87,5 +87,5 @@ Example:
 &menet {
 	tx-delay = <4>;
 	rx-delay = <2>;
-        status = "ok";
+        status = "okay";
 };
diff --git a/Documentation/devicetree/bindings/net/rockchip-dwmac.txt b/Documentation/devicetree/bindings/net/rockchip-dwmac.txt
index 8f42755..240af77 100644
--- a/Documentation/devicetree/bindings/net/rockchip-dwmac.txt
+++ b/Documentation/devicetree/bindings/net/rockchip-dwmac.txt
@@ -70,5 +70,5 @@ gmac: ethernet@ff290000 {
 	tx_delay = <0x30>;
 	rx_delay = <0x10>;

-	status = "ok";
+	status = "okay";
 };
diff --git a/Documentation/devicetree/bindings/pci/hisilicon-pcie.txt b/Documentation/devicetree/bindings/pci/hisilicon-pcie.txt
index a339dbb..8c546a4 100644
--- a/Documentation/devicetree/bindings/pci/hisilicon-pcie.txt
+++ b/Documentation/devicetree/bindings/pci/hisilicon-pcie.txt
@@ -17,7 +17,7 @@ Required properties
 - port-id: Should be 0, 1, 2 or 3.

 Optional properties:
-- status: Either "ok" or "disabled".
+- status: Either "okay" or "disabled".
 - dma-coherent: Present if DMA operations are coherent.

 Hip05 Example (note that Hip06 is the same except compatible):
@@ -40,7 +40,7 @@ Hip05 Example (note that Hip06 is the same except compatible):
 				 0x0 0 0 2 &mbigen_pcie 2 11
 				 0x0 0 0 3 &mbigen_pcie 3 12
 				 0x0 0 0 4 &mbigen_pcie 4 13>;
-		status = "ok";
+		status = "okay";
 	};

 HiSilicon Hip06/Hip07 PCIe host bridge DT (almost-ECAM) description.
@@ -83,5 +83,5 @@ Example:
 				 0x0 0 0 2 &mbigen_pcie0 650 4
 				 0x0 0 0 3 &mbigen_pcie0 650 4
 				 0x0 0 0 4 &mbigen_pcie0 650 4>;
-		status = "ok";
+		status = "okay";
 	};
diff --git a/Documentation/devicetree/bindings/pci/xgene-pci.txt b/Documentation/devicetree/bindings/pci/xgene-pci.txt
index 1070b06..e662b67 100644
--- a/Documentation/devicetree/bindings/pci/xgene-pci.txt
+++ b/Documentation/devicetree/bindings/pci/xgene-pci.txt
@@ -20,7 +20,7 @@ Required properties:
 - clocks: from common clock binding: handle to pci clock.

 Optional properties:
-- status: Either "ok" or "disabled".
+- status: Either "okay" or "disabled".
 - dma-coherent: Present if dma operations are coherent

 Example:
@@ -53,5 +53,5 @@ SoC specific DT Entry:

 Board specific DT Entry:
 	&pcie0 {
-		status = "ok";
+		status = "okay";
 	};
diff --git a/Documentation/devicetree/bindings/phy/apm-xgene-phy.txt b/Documentation/devicetree/bindings/phy/apm-xgene-phy.txt
index 5f3a65a..00fca6c 100644
--- a/Documentation/devicetree/bindings/phy/apm-xgene-phy.txt
+++ b/Documentation/devicetree/bindings/phy/apm-xgene-phy.txt
@@ -11,8 +11,8 @@ Required properties:
 			  1 (SGMII), 2 (PCIe), 3 (USB), and 4 (XFI).

 Optional properties:
-- status		: Shall be "ok" if enabled or "disabled" if disabled.
-			  Default is "ok".
+- status		: Shall be "okay" if enabled or "disabled" if disabled.
+			  Default is "okay".
 - clocks		: Reference to the clock entry.
 - apm,tx-eye-tuning	: Manual control to fine tune the capture of the serial
 			  bit lines from the automatic calibrated position.
@@ -68,12 +68,12 @@ Example:
 			compatible = "apm,xgene-phy";
 			reg = <0x0 0x1f22a000 0x0 0x100>;
 			#phy-cells = <1>;
-			status = "ok";
+			status = "okay";
 		};

 		phy3: phy@1f23a000 {
 			compatible = "apm,xgene-phy";
 			reg = <0x0 0x1f23a000 0x0 0x100>;
 			#phy-cells = <1>;
-			status = "ok";
+			status = "okay";
 		};
diff --git a/Documentation/devicetree/bindings/phy/phy-mvebu.txt b/Documentation/devicetree/bindings/phy/phy-mvebu.txt
index f95b626..767e353 100644
--- a/Documentation/devicetree/bindings/phy/phy-mvebu.txt
+++ b/Documentation/devicetree/bindings/phy/phy-mvebu.txt
@@ -18,7 +18,7 @@ Example:
 			clocks = <&gate_clk 15>;
 			clock-names = "sata";
 			#phy-cells = <0>;
-			status = "ok";
+			status = "okay";
 		};

 Armada 375 USB cluster
diff --git a/Documentation/devicetree/bindings/phy/qcom-dwc3-usb-phy.txt b/Documentation/devicetree/bindings/phy/qcom-dwc3-usb-phy.txt
index 86f2dbe..346df82 100644
--- a/Documentation/devicetree/bindings/phy/qcom-dwc3-usb-phy.txt
+++ b/Documentation/devicetree/bindings/phy/qcom-dwc3-usb-phy.txt
@@ -25,7 +25,7 @@ Example:
 			clock-names = "ref";
 			#phy-cells = <0>;

-			status = "ok";
+			status = "okay";
 		};

 		phy@100f8830 {
@@ -35,5 +35,5 @@ Example:
 			clock-names = "ref";
 			#phy-cells = <0>;

-			status = "ok";
+			status = "okay";
 		};
diff --git a/Documentation/devicetree/bindings/serial/qcom,msm-uartdm.txt b/Documentation/devicetree/bindings/serial/qcom,msm-uartdm.txt
index d5f73b8..990bcd4 100644
--- a/Documentation/devicetree/bindings/serial/qcom,msm-uartdm.txt
+++ b/Documentation/devicetree/bindings/serial/qcom,msm-uartdm.txt
@@ -72,13 +72,13 @@ Examples:
 	};

 	uarta: serial@12490000 {
-		status = "ok";
+		status = "okay";
 	};

 	uartb: serial@16340000 {
-		status = "ok";
+		status = "okay";
 	};

 	uartc: serial@1a240000 {
-		status = "ok";
+		status = "okay";
 	};
diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,gsbi.txt b/Documentation/devicetree/bindings/soc/qcom/qcom,gsbi.txt
index 2f5ede3..4f8626a 100644
--- a/Documentation/devicetree/bindings/soc/qcom/qcom,gsbi.txt
+++ b/Documentation/devicetree/bindings/soc/qcom/qcom,gsbi.txt
@@ -78,7 +78,7 @@ Example for APQ8064:
 			interrupts = <0 152 0x0>;
 			clocks = <&gcc GSBI4_UART_CLK>, <&gcc GSBI4_H_CLK>;
 			clock-names = "core", "iface";
-			status = "ok";
+			status = "okay";
 		};
 	};

diff --git a/Documentation/devicetree/bindings/spi/efm32-spi.txt b/Documentation/devicetree/bindings/spi/efm32-spi.txt
index 750e29a..ff4ae5c 100644
--- a/Documentation/devicetree/bindings/spi/efm32-spi.txt
+++ b/Documentation/devicetree/bindings/spi/efm32-spi.txt
@@ -36,6 +36,6 @@ spi1: spi@0x4000c400 { /* USART1 */
 		reg = <0>;
 		interrupt-parent = <&boardfpga>;
 		interrupts = <4>;
-		status = "ok";
+		status = "okay";
 	};
 };
diff --git a/Documentation/devicetree/bindings/usb/qcom,dwc3.txt b/Documentation/devicetree/bindings/usb/qcom,dwc3.txt
index 73cc096..0c19e54 100644
--- a/Documentation/devicetree/bindings/usb/qcom,dwc3.txt
+++ b/Documentation/devicetree/bindings/usb/qcom,dwc3.txt
@@ -29,7 +29,7 @@ Example device nodes:
 			clock-names = "ref";
 			#phy-cells = <0>;

-			status = "ok";
+			status = "okay";
 		};

 		ss_phy: phy@100f8830 {
@@ -39,7 +39,7 @@ Example device nodes:
 			clock-names = "ref";
 			#phy-cells = <0>;

-			status = "ok";
+			status = "okay";
 		};

 		usb3_0: usb30@0 {
@@ -51,7 +51,7 @@ Example device nodes:

 			ranges;

-			status = "ok";
+			status = "okay";

 			dwc3@10000000 {
 				compatible = "snps,dwc3";

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux