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.
Unified · Split
| @@ -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 | }; | ||