Re: [PATCH 2/4] can: fixed-transceiver: Add documentation for CAN fixed transceiver bindings

From: Sergei Shtylyov
Date: Thu Jul 20 2017 - 05:46:11 EST


Hello!

On 7/20/2017 2:36 AM, Franklin S Cooper Jr wrote:

Add documentation to describe usage of the new fixed transceiver binding.
This new binding is applicable for any CAN device therefore it exist as

Exists.

its own document.

Signed-off-by: Franklin S Cooper Jr <fcooper@xxxxxx>
---
.../bindings/net/can/fixed-transceiver.txt | 31 ++++++++++++++++++++++
1 file changed, 31 insertions(+)
create mode 100644 Documentation/devicetree/bindings/net/can/fixed-transceiver.txt

diff --git a/Documentation/devicetree/bindings/net/can/fixed-transceiver.txt b/Documentation/devicetree/bindings/net/can/fixed-transceiver.txt
new file mode 100644
index 0000000..7c093c3
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/can/fixed-transceiver.txt
@@ -0,0 +1,31 @@
+Fixed 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 "fixed-transceiver" node can be used.
+
+Properties:
+
+Optional:
+ max-arbitration-speed: a positive value non 0 value that determines the max

Too many values. :-)

+ speed CAN can run in non CAN-FD mode or during the
+ arbitration phase in CAN-FD mode.
+
+ max-data-speed: a positive value that determines the max data rate
+ that can be used in CAN-FD mode. A value of 0
+ implies CAN-FD is not supported by the transceiver.
[...]

MBR, Sergei