Skip to content

Commit 3223746

Browse files
committed
added DEVICE_CAN_FD definition in doxyfile_options
1 parent a0c1a64 commit 3223746

File tree

2 files changed

+14
-33
lines changed

2 files changed

+14
-33
lines changed

doxyfile_options

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2305,6 +2305,7 @@ PREDEFINED = DOXYGEN_ONLY \
23052305
DEVICE_ANALOGIN \
23062306
DEVICE_ANALOGOUT \
23072307
DEVICE_CAN \
2308+
DEVICE_CAN_FD \
23082309
DEVICE_CRC \
23092310
DEVICE_EMAC \
23102311
DEVICE_FLASH \

hal/include/hal/can_api.h

Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,6 @@ void can_init(can_t *obj, PinName rd, PinName td);
8484
*/
8585
void can_init_direct(can_t *obj, const can_pinmap_t *pinmap);
8686

87-
#if DEVICE_CAN_FD
8887
/** Initialize the CAN peripheral. It sets the default parameters for CAN
8988
* peripheral, and configures its specifieds pins.
9089
*
@@ -94,7 +93,11 @@ void can_init_direct(can_t *obj, const can_pinmap_t *pinmap);
9493
* @param hz The bus frequency in classical CAN mode, or nominal phase frequency in CAN FD mode
9594
* @param data_hz The data phase frequency in CAN FD mode, the CAN object is put into Classical CAN mode if this parameter is zero
9695
*/
97-
void can_init_freq(can_t *obj, PinName rd, PinName td, int hz, int data_hz);
96+
void can_init_freq(can_t *obj, PinName rd, PinName td, int hz
97+
#ifdef DEVICE_CAN_FD
98+
, int data_hz
99+
#endif
100+
);
98101

99102
/** Initialize the CAN peripheral. It sets the default parameters for CAN
100103
* peripheral, and configures its specifieds pins.
@@ -104,28 +107,11 @@ void can_init_freq(can_t *obj, PinName rd, PinName td, int hz, int data_hz);
104107
* @param hz The bus frequency in classical CAN mode, or nominal phase frequency in CAN FD mode
105108
* @param data_hz The data phase frequency in CAN FD mode, the CAN object is put into Classical CAN mode if this parameter is zero
106109
*/
107-
void can_init_freq_direct(can_t *obj, const can_pinmap_t *pinmap, int hz, int data_hz);
108-
109-
#else
110-
/** Initialize the CAN peripheral. It sets the default parameters for CAN
111-
* peripheral, and configures its specifieds pins.
112-
*
113-
* @param obj CAN object
114-
* @param rd The CAN RD pin name
115-
* @param td The CAN TD pin name
116-
* @param hz The bus frequency
117-
*/
118-
void can_init_freq(can_t *obj, PinName rd, PinName td, int hz);
119-
120-
/** Initialize the CAN peripheral. It sets the default parameters for CAN
121-
* peripheral, and configures its specifieds pins.
122-
*
123-
* @param obj CAN object
124-
* @param pinmap pointer to structure which holds static pinmap
125-
* @param hz The bus frequency
126-
*/
127-
void can_init_freq_direct(can_t *obj, const can_pinmap_t *pinmap, int hz);
110+
void can_init_freq_direct(can_t *obj, const can_pinmap_t *pinmap, int hz
111+
#ifdef DEVICE_CAN_FD
112+
, int data_hz
128113
#endif
114+
);
129115

130116
/** Release the CAN peripheral, not currently invoked. It requires further
131117
* resource management.
@@ -134,23 +120,17 @@ void can_init_freq_direct(can_t *obj, const can_pinmap_t *pinmap, int hz);
134120
*/
135121
void can_free(can_t *obj);
136122

137-
#if DEVICE_CAN_FD
138123
/** Configure the CAN bus frequency
139124
*
140125
* @param obj The CAN object
141126
* @param hz The bus frequency in classical CAN mode, or nominal phase frequency in CAN FD mode
142127
* @param data_hz The data phase frequency in CAN FD mode, the CAN object is put into Classical CAN mode if this parameter is zero
143128
*/
144-
int can_frequency(can_t *obj, int hz, int data_hz);
145-
146-
#else
147-
/** Configure the CAN bus frequency
148-
*
149-
* @param obj The CAN object
150-
* @param hz The bus frequency
151-
*/
152-
int can_frequency(can_t *obj, int hz);
129+
int can_frequency(can_t *obj, int hz
130+
#ifdef DEVICE_CAN_FD
131+
, int data_hz
153132
#endif
133+
);
154134

155135
/** Initialize the CAN IRQ handler
156136
*

0 commit comments

Comments
 (0)