[v4,2/4] dt-bindings: can: can-transceiver: Document new binding

Submitted by Cooper Jr., Franklin on Aug. 10, 2017, 12:59 a.m.

Details

Message ID 20170810005916.27163-3-fcooper@ti.com
State Not Applicable
Headers show

Commit Message

Cooper Jr., Franklin Aug. 10, 2017, 12:59 a.m.
Add documentation to describe usage of the new can-transceiver binding.
This new binding is applicable for any CAN device therefore it exists as
its own document.

Signed-off-by: Franklin S Cooper Jr <fcooper@ti.com>
---
Version 4 changes:
Drop unit address.
Switch from using fixed-transceiver to can-transceiver

 .../bindings/net/can/can-transceiver.txt           | 24 ++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/can/can-transceiver.txt

Comments

Rob Herring Aug. 17, 2017, 3:10 p.m.
On Wed, Aug 09, 2017 at 07:59:14PM -0500, Franklin S Cooper Jr wrote:
> Add documentation to describe usage of the new can-transceiver binding.
> This new binding is applicable for any CAN device therefore it exists as
> its own document.
> 
> Signed-off-by: Franklin S Cooper Jr <fcooper@ti.com>
> ---
> Version 4 changes:
> Drop unit address.
> Switch from using fixed-transceiver to can-transceiver
> 
>  .../bindings/net/can/can-transceiver.txt           | 24 ++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/can/can-transceiver.txt
> 
> diff --git a/Documentation/devicetree/bindings/net/can/can-transceiver.txt b/Documentation/devicetree/bindings/net/can/can-transceiver.txt
> new file mode 100644
> index 0000000..2c31dc0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/can-transceiver.txt
> @@ -0,0 +1,24 @@
> +Generic CAN transceiver Device Tree binding
> +------------------------------
> +
> +CAN transceiver typically limits the max speed in standard CAN and CAN FD
> +modes. Typically these limitations are static and the transceivers themselves
> +provide no way to detect this limitation at runtime. For this situation,
> +the "can-transceiver" node can be used.
> +
> +Required Properties:
> + max-bitrate:	a positive non 0 value that determines the max
> +		speed that CAN/CAN-FD can run. Any other value
> +		will be ignored.
> +
> +Examples:
> +
> +Based on Texas Instrument's TCAN1042HGV CAN Transceiver
> +
> +m_can0 {
> +	....
> +	can-transceiver@ {

Need to drop the @ too. With that,

Acked-by: Rob Herring <robh@kernel.org>


> +		max-bitrate = <5000000>;
> +	};
> +	...
> +};
> -- 
> 2.9.4.dirty
> 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch hide | download patch | download mbox

diff --git a/Documentation/devicetree/bindings/net/can/can-transceiver.txt b/Documentation/devicetree/bindings/net/can/can-transceiver.txt
new file mode 100644
index 0000000..2c31dc0
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/can/can-transceiver.txt
@@ -0,0 +1,24 @@ 
+Generic CAN transceiver Device Tree binding
+------------------------------
+
+CAN transceiver typically limits the max speed in standard CAN and CAN FD
+modes. Typically these limitations are static and the transceivers themselves
+provide no way to detect this limitation at runtime. For this situation,
+the "can-transceiver" node can be used.
+
+Required Properties:
+ max-bitrate:	a positive non 0 value that determines the max
+		speed that CAN/CAN-FD can run. Any other value
+		will be ignored.
+
+Examples:
+
+Based on Texas Instrument's TCAN1042HGV CAN Transceiver
+
+m_can0 {
+	....
+	can-transceiver@ {
+		max-bitrate = <5000000>;
+	};
+	...
+};