diff options
| author | Franklin S Cooper Jr <fcooper@ti.com> | 2018-01-16 06:37:11 -0500 |
|---|---|---|
| committer | Marc Kleine-Budde <mkl@pengutronix.de> | 2018-01-16 09:11:31 -0500 |
| commit | 54a7fbcc17bc2881807ea8e65fa0857ec8a3a863 (patch) | |
| tree | cb737cfb99a3db05b8bd1136e068d1197ad17fea | |
| parent | 79d891c1bbb6573cef31dbc2030fba61cfa1df6d (diff) | |
dt-bindings: can: can-transceiver: Document new binding
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>
Signed-off-by: Sekhar Nori <nsekhar@ti.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Faiz Abbas <faiz_abbas@ti.com>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
| -rw-r--r-- | Documentation/devicetree/bindings/net/can/can-transceiver.txt | 24 |
1 files changed, 24 insertions, 0 deletions
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 000000000000..0011f53ff159 --- /dev/null +++ b/Documentation/devicetree/bindings/net/can/can-transceiver.txt | |||
| @@ -0,0 +1,24 @@ | |||
| 1 | Generic CAN transceiver Device Tree binding | ||
| 2 | ------------------------------ | ||
| 3 | |||
| 4 | CAN transceiver typically limits the max speed in standard CAN and CAN FD | ||
| 5 | modes. Typically these limitations are static and the transceivers themselves | ||
| 6 | provide no way to detect this limitation at runtime. For this situation, | ||
| 7 | the "can-transceiver" node can be used. | ||
| 8 | |||
| 9 | Required Properties: | ||
| 10 | max-bitrate: a positive non 0 value that determines the max | ||
| 11 | speed that CAN/CAN-FD can run. Any other value | ||
| 12 | will be ignored. | ||
| 13 | |||
| 14 | Examples: | ||
| 15 | |||
| 16 | Based on Texas Instrument's TCAN1042HGV CAN Transceiver | ||
| 17 | |||
| 18 | m_can0 { | ||
| 19 | .... | ||
| 20 | can-transceiver { | ||
| 21 | max-bitrate = <5000000>; | ||
| 22 | }; | ||
| 23 | ... | ||
| 24 | }; | ||
