adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

zbus: remove unneeded const qualifiers

Browse source 
Remove `const` qualifiers on fields in structures that are only created
or instantiated as `const`.

This if primarily for consistency, in the same way that `struct device`
fields and `device->config` struct fields are not additionally marked as
`const`.

Signed-off-by: Jordan Yates <jordan@embeint.com>
This commit is contained in:
Jordan Yates 2024-07-05 19:33:16 +10:00 committed by Carles Cufí
parent cbc4100eda
commit 1ed77cb50c
4 changed files with 29 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
include/zephyr/zbus/zbus.h
View file

@ -73,29 +73,29 @@ struct zbus_channel_data {
struct zbus_channel {
#if defined(CONFIG_ZBUS_CHANNEL_NAME) || defined(__DOXYGEN__)
/** Channel name. */
const char *const name;
const char *name;
#endif
/** Message reference. Represents the message's reference that points to the actual
* shared memory region.
*/
void *const message;
void *message;
/** Message size. Represents the channel's message size. */
const size_t message_size;
size_t message_size;
/** User data available to extend zbus features. The channel must be claimed before
* using this field.
*/
void *const user_data;
void *user_data;
/** Message validator. Stores the reference to the function to check the message
* validity before actually performing the publishing. No invalid messages can be
* published. Every message is valid when this field is empty.
*/
bool (*const validator)(const void *msg, size_t msg_size);
bool (*validator)(const void *msg, size_t msg_size);
/** Mutable channel data struct. */
struct zbus_channel_data *const data;
struct zbus_channel_data *data;
};
/**
@ -137,26 +137,26 @@ struct zbus_observer_data {
struct zbus_observer {
#if defined(CONFIG_ZBUS_OBSERVER_NAME) || defined(__DOXYGEN__)
/** Observer name. */
const char *const name;
const char *name;
#endif
/** Type indication. */
enum zbus_observer_type type;
/** Mutable observer data struct. */
struct zbus_observer_data *const data;
struct zbus_observer_data *data;
union {
/** Observer message queue. It turns the observer into a subscriber. */
struct k_msgq *const queue;
struct k_msgq *queue;
/** Observer callback function. It turns the observer into a listener. */
void (*const callback)(const struct zbus_channel *chan);
void (*callback)(const struct zbus_channel *chan);
#if defined(CONFIG_ZBUS_MSG_SUBSCRIBER) || defined(__DOXYGEN__)
/** Observer message FIFO. It turns the observer into a message subscriber. It only
* exists if the @kconfig{CONFIG_ZBUS_MSG_SUBSCRIBER} is enabled.
*/
struct k_fifo *const message_fifo;
struct k_fifo *message_fifo;
#endif /* CONFIG_ZBUS_MSG_SUBSCRIBER */
};
};
@ -167,8 +167,8 @@ struct zbus_channel_observation_mask {
};
struct zbus_channel_observation {
const struct zbus_channel *const chan;
const struct zbus_observer *const obs;
const struct zbus_channel *chan;
const struct zbus_observer *obs;
};
#ifdef __cplusplus
@ -217,7 +217,7 @@ struct zbus_channel_observation {
#define ZBUS_RUNTIME_OBSERVERS_LIST_INIT(_slist_name) /* No runtime observers */
#endif
#define _ZBUS_OBS_EXTERN(_name) extern struct zbus_observer _name
#define _ZBUS_OBS_EXTERN(_name) extern const struct zbus_observer _name
#define _ZBUS_CHAN_EXTERN(_name) extern const struct zbus_channel _name
@ -396,8 +396,8 @@ struct zbus_channel_observation {
*/
#define ZBUS_SUBSCRIBER_DEFINE_WITH_ENABLE(_name, _queue_size, _enable) \
K_MSGQ_DEFINE(_zbus_observer_queue_##_name, \
sizeof(const struct zbus_channel *), \
_queue_size, sizeof(const struct zbus_channel *) \
sizeof(struct zbus_channel *), \
_queue_size, sizeof(struct zbus_channel *) \
); \
static struct zbus_observer_data _CONCAT(_zbus_obs_data_, _name) = { \
.enabled = _enable, \
@ -405,7 +405,7 @@ struct zbus_channel_observation {
.priority = ZBUS_MIN_THREAD_PRIORITY, \
)) \
}; \
STRUCT_SECTION_ITERABLE(zbus_observer, _name) = { \
const STRUCT_SECTION_ITERABLE(zbus_observer, _name) = { \
ZBUS_OBSERVER_NAME_INIT(_name) /* Name field */ \
.type = ZBUS_OBSERVER_SUBSCRIBER_TYPE, \
.data = &_CONCAT(_zbus_obs_data_, _name), \
@ -446,7 +446,7 @@ struct zbus_channel_observation {
.priority = ZBUS_MIN_THREAD_PRIORITY, \
)) \
}; \
STRUCT_SECTION_ITERABLE(zbus_observer, _name) = { \
const STRUCT_SECTION_ITERABLE(zbus_observer, _name) = { \
ZBUS_OBSERVER_NAME_INIT(_name) /* Name field */ \
.type = ZBUS_OBSERVER_LISTENER_TYPE, \
.data = &_CONCAT(_zbus_obs_data_, _name), \
@ -485,7 +485,7 @@ struct zbus_channel_observation {
.priority = ZBUS_MIN_THREAD_PRIORITY, \
)) \
}; \
STRUCT_SECTION_ITERABLE(zbus_observer, _name) = { \
const STRUCT_SECTION_ITERABLE(zbus_observer, _name) = { \
ZBUS_OBSERVER_NAME_INIT(_name) /* Name field */ \
.type = ZBUS_OBSERVER_MSG_SUBSCRIBER_TYPE, \
.data = &_CONCAT(_zbus_obs_data_, _name), \
@ -782,7 +782,7 @@ struct zbus_observer_node {
* @retval -EFAULT A parameter is incorrect, or the function context is invalid (inside an ISR). The
* function only returns this value when the @kconfig{CONFIG_ZBUS_ASSERT_MOCK} is enabled.
*/
int zbus_obs_set_enable(struct zbus_observer *obs, bool enabled);
int zbus_obs_set_enable(const struct zbus_observer *obs, bool enabled);
/**
* @brief Get the observer state.
@ -794,7 +794,7 @@ int zbus_obs_set_enable(struct zbus_observer *obs, bool enabled);
*
* @return Observer state.
*/
static inline int zbus_obs_is_enabled(struct zbus_observer *obs, bool *enable)
static inline int zbus_obs_is_enabled(const struct zbus_observer *obs, bool *enable)
{
_ZBUS_ASSERT(obs != NULL, "obs is required");
_ZBUS_ASSERT(enable != NULL, "enable is required");

2
subsys/zbus/zbus.c
View file

@ -551,7 +551,7 @@ int zbus_obs_is_chan_notification_masked(const struct zbus_observer *obs,
return err;
}
int zbus_obs_set_enable(struct zbus_observer *obs, bool enabled)
int zbus_obs_set_enable(const struct zbus_observer *obs, bool enabled)
{
_ZBUS_ASSERT(obs != NULL, "obs is required");

10
tests/subsys/zbus/hlp_priority_boost/src/main.c
View file

@ -41,7 +41,7 @@ static void consumer_sub_thread(void *ptr1, void *ptr2, void *ptr3)
zbus_obs_attach_to_thread(ptr1);
char *name = ptr2;
struct zbus_observer *sub = ptr1;
const struct zbus_observer *sub = ptr1;
const struct zbus_channel *chan;
struct msg_testing_01 msg;
@ -68,7 +68,7 @@ static void consumer_msg_sub_thread(void *ptr1, void *ptr2, void *ptr3)
zbus_obs_attach_to_thread(ptr1);
char *name = ptr2;
struct zbus_observer *msub = ptr1;
const struct zbus_observer *msub = ptr1;
const struct zbus_channel *chan;
struct msg_testing_01 msg;
@ -126,10 +126,10 @@ ZTEST(hlp_priority_boost, test_priority_elevation)
{
pub_thread_id = k_thread_create(&pub_thread, pub_thread_sz, STACK_SIZE, publisher_thread,
NULL, NULL, NULL, K_PRIO_PREEMPT(8), 0, K_NO_WAIT);
(void)k_thread_create(&s1_thread, s1_thread_sz, STACK_SIZE, consumer_sub_thread, &sub1,
"sub1", NULL, K_PRIO_PREEMPT(3), 0, K_NO_WAIT);
(void)k_thread_create(&s1_thread, s1_thread_sz, STACK_SIZE, consumer_sub_thread,
(void *)&sub1, "sub1", NULL, K_PRIO_PREEMPT(3), 0, K_NO_WAIT);
(void)k_thread_create(&ms1_thread, ms1_thread_sz, STACK_SIZE, consumer_msg_sub_thread,
&msub1, "msub1", NULL, K_PRIO_PREEMPT(2), 0, K_NO_WAIT);
(void *)&msub1, "msub1", NULL, K_PRIO_PREEMPT(2), 0, K_NO_WAIT);
_pub_and_sync();
zassert_true(prio == 1, "The priority must be 1, but it is %d", prio);

4
tests/subsys/zbus/unittests/src/main.c
View file

@ -234,7 +234,7 @@ static struct zbus_observer_data _zbus_obs_data_invalid_obs = {
))
};
STRUCT_SECTION_ITERABLE(zbus_observer, invalid_obs) = {
const STRUCT_SECTION_ITERABLE(zbus_observer, invalid_obs) = {
ZBUS_OBSERVER_NAME_INIT(invalid_obs) /* Name field */
.type = ZBUS_OBSERVER_MSG_SUBSCRIBER_TYPE + 10,
.data = &_zbus_obs_data_invalid_obs,
@ -720,7 +720,7 @@ static struct zbus_observer_data _zbus_obs_data_invalid_sub = {
))
};
STRUCT_SECTION_ITERABLE(zbus_observer, invalid_sub) = {
const STRUCT_SECTION_ITERABLE(zbus_observer, invalid_sub) = {
ZBUS_OBSERVER_NAME_INIT(invalid_sub) /* Name field */
.type = ZBUS_OBSERVER_SUBSCRIBER_TYPE,
.data = &_zbus_obs_data_invalid_sub,