mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Franklin S Cooper Jr <fcooper@ti.com>
To: <linux-kernel@vger.kernel.org>, <devicetree@vger.kernel.org>,
	<netdev@vger.kernel.org>, <linux-can@vger.kernel.org>,
	<wg@grandegger.com>, <mkl@pengutronix.de>, <robh+dt@kernel.org>,
	<quentin.schulz@free-electrons.com>,
	<dev.kurt@vandijck-laurijssen.be>, <andrew@lunn.ch>
Cc: Franklin S Cooper Jr <fcooper@ti.com>
Subject: [PATCH 2/4] can: fixed-transceiver: Add documentation for CAN fixed transceiver bindings
Date: Wed, 19 Jul 2017 18:36:52 -0500	[thread overview]
Message-ID: <20170719233654.25908-3-fcooper@ti.com> (raw)
In-Reply-To: <20170719233654.25908-1-fcooper@ti.com>

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

Signed-off-by: Franklin S Cooper Jr <fcooper@ti.com>
---
 .../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
+			 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.
+
+Examples:
+
+Based on Texas Instrument's TCAN1042HGV CAN Transceiver
+
+m_can0 {
+	....
+	fixed-transceiver@0 {
+		max-arbitration-speed = <1000000>;
+		max-data-speed = <5000000>;
+	};
+	...
+};
-- 
2.10.0

  parent reply	other threads:[~2017-07-19 23:37 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-19 23:36 [PATCH 0/4] can: Add new binding to limit bit rate used Franklin S Cooper Jr
2017-07-19 23:36 ` [PATCH 1/4] can: dev: Add support for limiting configured bitrate Franklin S Cooper Jr
2017-07-20  7:43   ` Oliver Hartkopp
2017-07-20 15:55     ` Franklin S Cooper Jr
2017-07-26 20:04       ` Kurt Van Dijck
2017-07-27  1:44         ` Franklin S Cooper Jr
2017-07-20  9:52   ` Sergei Shtylyov
2017-07-20 15:59     ` Franklin S Cooper Jr
2017-07-19 23:36 ` Franklin S Cooper Jr [this message]
2017-07-20  9:45   ` [PATCH 2/4] can: fixed-transceiver: Add documentation for CAN fixed transceiver bindings Sergei Shtylyov
2017-07-19 23:36 ` [PATCH 3/4] can: m_can: Update documentation to mention new fixed transceiver binding Franklin S Cooper Jr
2017-07-24 19:50   ` Rob Herring
2017-07-19 23:36 ` [PATCH 4/4] can: m_can: Add call to of_transceiver_is_fixed Franklin S Cooper Jr

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170719233654.25908-3-fcooper@ti.com \
    --to=fcooper@ti.com \
    --cc=andrew@lunn.ch \
    --cc=dev.kurt@vandijck-laurijssen.be \
    --cc=devicetree@vger.kernel.org \
    --cc=linux-can@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mkl@pengutronix.de \
    --cc=netdev@vger.kernel.org \
    --cc=quentin.schulz@free-electrons.com \
    --cc=robh+dt@kernel.org \
    --cc=wg@grandegger.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®