linux-kernel - [PATCH v3 16/18] drivers/fsi: Add documentation for GPIO based FSI master

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20170201165358.45415-17-cbostic@linux.vnet.ibm.com>
Date:   Wed,  1 Feb 2017 10:53:56 -0600
From:   Christopher Bostic <cbostic@...ux.vnet.ibm.com>
To:     robh+dt@...nel.org, mark.rutland@....com, linux@...linux.org.uk,
        gregkh@...uxfoundation.org, mturquette@...libre.com,
        geert+renesas@...der.be, devicetree@...r.kernel.org,
        linux-arm-kernel@...ts.infradead.org, joel@....id.au,
        linux-kernel@...r.kernel.org, andrew@...id.au,
        alistair@...ple.id.au, benh@...nel.crashing.org
Cc:     Chris Bostic <cbostic@...ibm.com>
Subject: [PATCH v3 16/18] drivers/fsi: Add documentation for GPIO based FSI master

From: Chris Bostic <cbostic@...ibm.com>

Define the device tree bindings for the GPIO master type.

Signed-off-by: Chris Bostic <cbostic@...ibm.com>
---
 .../devicetree/bindings/fsi/fsi-master-gpio.txt    | 71 ++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fsi/fsi-master-gpio.txt

diff --git a/Documentation/devicetree/bindings/fsi/fsi-master-gpio.txt b/Documentation/devicetree/bindings/fsi/fsi-master-gpio.txt
new file mode 100644
index 0000000..5d589bf
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/fsi-master-gpio.txt
@@ -0,0 +1,71 @@
+Device-tree bindings for FSI master implemented with GPIO
+---------------------------------------------------------
+
+Typically a FSI master is defined in hardware with output control
+lines designated for Enable, Data, Clock, etc..  In the case of
+a 'GPIO FSI master', however, it may be the case that there is no
+such master defined in hardware and must be implemented in standard
+GPIO to interact with its slaves.  In this 'virtual' FSI master
+case the GPIO pins representing clk and data are directly
+connected to the slaves.
+
+The GPIO FSI master node
+-------------------------
+This node describes a FSI master implmented with GPIO.
+Required property:
+	compatible = "ibm,fsi-master-gpio"
+
+The standard FSI master node
+----------------------------
+This node describes a FSI master implmemented fully in hardware
+with dedicated input/output pins required for its function (i.e.
+not using generic GPIO pins).
+Required property:
+	compatible = "ibm,fsi-master"
+
+
+GPIO FSI master property/pin descriptions
+------------------------------------------
+clk -	The master controlled clock line that indicates to the
+	slave when to read in or send out new data - required.
+data -	The serial data line containing information to be sent or
+	received by the master.  This line is bi-directional.  During
+	command phase the master controls the line and when a response
+	is required the slave takes control - required.
+enable - Controls power state of data line - optional.
+trans - Voltage translator control. In some applications the data line
+	must have its signal levels altered by a translator. If this is
+	necessary then control of signal direction is managed via this
+	line - optional.
+mux -	Multiplexor control.  This activates/deactivates the data line
+	in cases where it is one of many possible selections via mux -
+	optional.
+
+Required properties:
+	- compatible = "ibm,fsi-master-gpio";
+	- clk-gpios;
+	- data-gpios;
+
+Optional properties:
+	- enable-gpios;
+	- trans-gpios;
+	- mux-gpios;
+
+Order of property activation:
+1. clk
+2. data
+3. trans
+4. enable
+5. mux
+
+
+Example:
+
+fsi-master {
+	compatible = "ibm,fsi-master-gpio", "ibm,fsi-master";
+	clk-gpios = <&gpio 0>, <&gpio 6>;
+	data-gpios = <&gpio 1>, <&gpio 7>;
+	enable-gpios = <&gpio 2>, <&gpio 8>;
+	trans-gpios = <&gpio 3>, <&gpio 9>;
+	mux-gpios = <&gpio 4>, <&gpio 10>;
+}
-- 
1.8.2.2