[PATCH 1/3] doc: dt: add documentation for Mediatek spi-nor controller
From: Jagan Teki <hidden>
Date: 2015-09-08 11:34:10
Also in:
linux-devicetree, linux-mediatek, lkml
On 8 September 2015 at 15:19, Bayi Cheng [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Add device tree binding documentation for serial flash with Mediatek serial flash controller Signed-off-by: Bayi Cheng <redacted> --- Documentation/devicetree/bindings/mtd/mtk_nor.txt | 25 +++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/mtk_nor.txtdiff --git a/Documentation/devicetree/bindings/mtd/mtk_nor.txt b/Documentation/devicetree/bindings/mtd/mtk_nor.txt new file mode 100644 index 0000000..0eca0cd --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/mtk_nor.txt
IMHO - looks like the name of the driver file not resembles controller driver, usually spi-nor framework has a name include 'nor' and related controller drivers uses simple notion with vendor/soc_name-quadspi or something similar. cadence-quadspi.c fsl-quadspi.c Simple suggestion - mtk-quadspi.c (since it supports quad)
quoted hunk ↗ jump to hunk
@@ -0,0 +1,25 @@ +* MTD SPI nor driver for MTK MT81xx (and similar) serial flash controller + +MTK MT81xx serial flash controller is designed for serial Flash device. +It supports one Flash device with signal mode, dual mode and quad mode. + +Required properties: +- compatible: should be "mediatek,mt8173-nor"; +- reg: physical base address and length of the controller's register +- clocks: spi nor source clock +- clock-names: "spi_clk", "axi_clk", "mux_clk", "sf_clk" + +See Documentation/devicetree/bindings/clock/clock-bindings.txt
As this related to clock-names, just add this line in-continuous with clock-name property description.
+and Documentation/mtd/spi-nor.txt for details.
This explicit mentioning about spi-nor documentation is may not required as this .txt will describe how spi-nor works and not related to bindings.
+
+Example:
+nor_flash: nor at 1100d000 {
+ compatible = "mediatek,mt8173-nor";
+ reg = <0 0x1100d000 0 0xe0>;
+ clocks = <&pericfg CLK_PERI_SPI>,
+ <&topckgen CLK_TOP_AXI_SEL>,
+ <&topckgen CLK_TOP_UNIVPLL2_D8>,
+ <&topckgen CLK_TOP_SPINFI_IFR_SEL>;
+ clock-names = "spi_clk", "axi_clk", "mux_clk", "sf_clk";
+};
+
--
1.8.1.1.dirtythanks! -- Jagan | openedev.