Skip to content

Commit 2f7c01b

Browse files
henrikbrixandersencarlescufi
authored andcommitted
drivers: can: rename API functions from timing_*_data to timing_data_*
Rename the CAN data phase API functions to timing_data_* for consistency: - can_get_timing_min_data() -> can_get_timing_data_min() - can_get_timing_max_data() -> can_get_timing_data_max() - .timing_min_data -> timing_data_min - .timing_max_data -> timing_data_max Signed-off-by: Henrik Brix Andersen <[email protected]>
1 parent 1889082 commit 2f7c01b

File tree

8 files changed

+28
-28
lines changed

8 files changed

+28
-28
lines changed

drivers/can/can_common.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ int z_impl_can_calc_timing(const struct device *dev, struct can_timing *res,
151151
int z_impl_can_calc_timing_data(const struct device *dev, struct can_timing *res,
152152
uint32_t bitrate, uint16_t sample_pnt)
153153
{
154-
const struct can_timing *min = can_get_timing_min_data(dev);
155-
const struct can_timing *max = can_get_timing_max_data(dev);
154+
const struct can_timing *min = can_get_timing_data_min(dev);
155+
const struct can_timing *max = can_get_timing_data_max(dev);
156156
uint32_t core_clock;
157157
int ret;
158158

drivers/can/can_handlers.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,21 +90,21 @@ static int z_vrfy_can_calc_timing_data(const struct device *dev, struct can_timi
9090
}
9191
#include <syscalls/can_calc_timing_data_mrsh.c>
9292

93-
static inline const struct can_timing *z_vrfy_can_get_timing_min_data(const struct device *dev)
93+
static inline const struct can_timing *z_vrfy_can_get_timing_data_min(const struct device *dev)
9494
{
9595
Z_OOPS(Z_SYSCALL_OBJ(dev, K_OBJ_DRIVER_CAN));
9696

97-
return z_impl_can_get_timing_min_data(dev);
97+
return z_impl_can_get_timing_data_min(dev);
9898
}
99-
#include <syscalls/can_get_timing_min_data_mrsh.c>
99+
#include <syscalls/can_get_timing_data_min_mrsh.c>
100100

101-
static inline const struct can_timing *z_vrfy_can_get_timing_max_data(const struct device *dev)
101+
static inline const struct can_timing *z_vrfy_can_get_timing_data_max(const struct device *dev)
102102
{
103103
Z_OOPS(Z_SYSCALL_OBJ(dev, K_OBJ_DRIVER_CAN));
104104

105-
return z_impl_can_get_timing_max_data(dev);
105+
return z_impl_can_get_timing_data_max(dev);
106106
}
107-
#include <syscalls/can_get_timing_max_data_mrsh.c>
107+
#include <syscalls/can_get_timing_data_max_mrsh.c>
108108

109109
static inline int z_vrfy_can_set_timing_data(const struct device *dev,
110110
const struct can_timing *timing_data)

drivers/can/can_mcux_mcan.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,14 @@ static const struct can_driver_api mcux_mcan_driver_api = {
103103
* the register field limits are physical values minus 1 (which is
104104
* handled by the register assignments in the common MCAN driver code).
105105
*/
106-
.timing_min_data = {
106+
.timing_data_min = {
107107
.sjw = 1,
108108
.prop_seg = 0,
109109
.phase_seg1 = 1,
110110
.phase_seg2 = 1,
111111
.prescaler = 1,
112112
},
113-
.timing_max_data = {
113+
.timing_data_max = {
114114
.sjw = 16,
115115
.prop_seg = 0,
116116
.phase_seg1 = 16,

drivers/can/can_sam.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,14 @@ static const struct can_driver_api can_sam_driver_api = {
9999
},
100100
#ifdef CONFIG_CAN_FD_MODE
101101
.set_timing_data = can_mcan_set_timing_data,
102-
.timing_min_data = {
102+
.timing_data_min = {
103103
.sjw = 0x01,
104104
.prop_seg = 0x00,
105105
.phase_seg1 = 0x01,
106106
.phase_seg2 = 0x01,
107107
.prescaler = 0x01
108108
},
109-
.timing_max_data = {
109+
.timing_data_max = {
110110
.sjw = 0x10,
111111
.prop_seg = 0x00,
112112
.phase_seg1 = 0x20,

drivers/can/can_stm32fd.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,14 @@ static const struct can_driver_api can_stm32fd_driver_api = {
138138
},
139139
#ifdef CONFIG_CAN_FD_MODE
140140
.set_timing_data = can_mcan_set_timing_data,
141-
.timing_min_data = {
141+
.timing_data_min = {
142142
.sjw = 0x01,
143143
.prop_seg = 0x00,
144144
.phase_seg1 = 0x01,
145145
.phase_seg2 = 0x01,
146146
.prescaler = 0x01
147147
},
148-
.timing_max_data = {
148+
.timing_data_max = {
149149
.sjw = 0x10,
150150
.prop_seg = 0x00,
151151
.phase_seg1 = 0x20,

drivers/can/can_stm32h7.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,14 @@ static const struct can_driver_api can_stm32h7_driver_api = {
132132
* (RM0433 Rev 7), section 56.5.3, FDCAN data bit timing and prescaler
133133
* register (FDCAN_DBTP).
134134
*/
135-
.timing_min_data = {
135+
.timing_data_min = {
136136
.sjw = 0x00,
137137
.prop_seg = 0x00,
138138
.phase_seg1 = 0x00,
139139
.phase_seg2 = 0x00,
140140
.prescaler = 0x00
141141
},
142-
.timing_max_data = {
142+
.timing_data_max = {
143143
.sjw = 0x10,
144144
.prop_seg = 0x00,
145145
.phase_seg1 = 0x20,

include/zephyr/drivers/can.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -396,9 +396,9 @@ __subsystem struct can_driver_api {
396396
#if defined(CONFIG_CAN_FD_MODE) || defined(__DOXYGEN__)
397397
can_set_timing_data_t set_timing_data;
398398
/* Min values for the timing registers during the data phase */
399-
struct can_timing timing_min_data;
399+
struct can_timing timing_data_min;
400400
/* Max values for the timing registers during the data phase */
401-
struct can_timing timing_max_data;
401+
struct can_timing timing_data_max;
402402
#endif /* CONFIG_CAN_FD_MODE */
403403
};
404404

@@ -724,13 +724,13 @@ __syscall int can_calc_timing(const struct device *dev, struct can_timing *res,
724724
* @return Pointer to the minimum supported timing parameter values, or NULL if
725725
* CAN-FD is not supported.
726726
*/
727-
__syscall const struct can_timing *can_get_timing_min_data(const struct device *dev);
727+
__syscall const struct can_timing *can_get_timing_data_min(const struct device *dev);
728728

729-
static inline const struct can_timing *z_impl_can_get_timing_min_data(const struct device *dev)
729+
static inline const struct can_timing *z_impl_can_get_timing_data_min(const struct device *dev)
730730
{
731731
const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
732732

733-
return &api->timing_min_data;
733+
return &api->timing_data_min;
734734
}
735735

736736
/**
@@ -746,13 +746,13 @@ static inline const struct can_timing *z_impl_can_get_timing_min_data(const stru
746746
* @return Pointer to the maximum supported timing parameter values, or NULL if
747747
* CAN-FD is not supported.
748748
*/
749-
__syscall const struct can_timing *can_get_timing_max_data(const struct device *dev);
749+
__syscall const struct can_timing *can_get_timing_data_max(const struct device *dev);
750750

751-
static inline const struct can_timing *z_impl_can_get_timing_max_data(const struct device *dev)
751+
static inline const struct can_timing *z_impl_can_get_timing_data_max(const struct device *dev)
752752
{
753753
const struct can_driver_api *api = (const struct can_driver_api *)dev->api;
754754

755-
return &api->timing_max_data;
755+
return &api->timing_data_max;
756756
}
757757

758758
/**

tests/drivers/can/timing/src/main.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,8 @@ static void test_timing_values(const struct device *dev, const struct can_timing
175175

176176
if (data_phase) {
177177
if (IS_ENABLED(CONFIG_CAN_FD_MODE)) {
178-
min = can_get_timing_min_data(dev);
179-
max = can_get_timing_max_data(dev);
178+
min = can_get_timing_data_min(dev);
179+
max = can_get_timing_data_max(dev);
180180
sp_err = can_calc_timing_data(dev, &timing, test->bitrate, test->sp);
181181
} else {
182182
zassert_unreachable("data phase timing test without CAN-FD support");
@@ -258,7 +258,7 @@ void test_set_timing_min(void)
258258
zassert_equal(err, 0, "failed to set minimum timing parameters (err %d)", err);
259259

260260
if (IS_ENABLED(CONFIG_CAN_FD_MODE)) {
261-
err = can_set_timing_data(dev, can_get_timing_min_data(dev));
261+
err = can_set_timing_data(dev, can_get_timing_data_min(dev));
262262
zassert_equal(err, 0, "failed to set minimum timing data parameters (err %d)", err);
263263
}
264264
}
@@ -275,7 +275,7 @@ void test_set_timing_max(void)
275275
zassert_equal(err, 0, "failed to set maximum timing parameters (err %d)", err);
276276

277277
if (IS_ENABLED(CONFIG_CAN_FD_MODE)) {
278-
err = can_set_timing_data(dev, can_get_timing_max_data(dev));
278+
err = can_set_timing_data(dev, can_get_timing_data_max(dev));
279279
zassert_equal(err, 0, "failed to set maximum timing data parameters (err %d)", err);
280280
}
281281
}

0 commit comments

Comments
 (0)