]> begriffs open source - cmsis-driver-validation/blob - DoxyGen/src/DV_CAN.txt
Update GitHub Actions runner to ubuntu-22.04 (#18)
[cmsis-driver-validation] / DoxyGen / src / DV_CAN.txt
1 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
2 /**
3 \defgroup can_config Configuration
4 \ingroup  dv_can
5
6 The CAN driver validation settings are available in the <b>DV_CAN_Config.h</b> configuration file.
7
8 \image html dv_can_config_h.png "DV_CAN_Config.h configuration file in Configuration Wizard view mode"
9
10 \section can_config_detail Configuration settings
11
12 <b>Driver_CAN#</b> selects the driver instance that will be tested.<br>
13 For example if we want to test <c>Driver_CAN2</c> then this setting would be set to <c>2</c>.
14
15 <b>CAN bitrates</b> section specifies which bitrate settings will be tested.
16 If a setting is not to be tested then set the value to 0.
17
18 <b>Ratio data/arbitration bitrate</b> setting specifies ratio between data and arbitration bitrate 
19 which is used for CAN FD.
20
21 <b>Percentual trigger for bitrate tests</b> setting specifies allowed deviation of measured bitrate 
22 in comparison to requested bitrate, expressed in percents.
23
24 <b>Transfer timeout</b> setting specifies maximum timeout for a transfer, expressed in microseconds.
25
26 <b>Tests</b> section contains selections of tests to be executed.<br>
27 For details on tests performed by each test function please refer to \ref can_tests "CAN Tests".
28
29 */