aboutsummaryrefslogtreecommitdiffstats
path: root/os/kernel/include
diff options
context:
space:
mode:
Diffstat (limited to 'os/kernel/include')
-rw-r--r--os/kernel/include/ch.h12
-rw-r--r--os/kernel/include/chbsem.h22
-rw-r--r--os/kernel/include/chcond.h2
-rw-r--r--os/kernel/include/chevents.h2
-rw-r--r--os/kernel/include/chheap.h2
-rw-r--r--os/kernel/include/chlists.h8
-rw-r--r--os/kernel/include/chmboxes.h2
-rw-r--r--os/kernel/include/chmempools.h2
-rw-r--r--os/kernel/include/chmsg.h2
-rw-r--r--os/kernel/include/chmtx.h6
-rw-r--r--os/kernel/include/chqueues.h24
-rw-r--r--os/kernel/include/chschd.h4
-rw-r--r--os/kernel/include/chsem.h2
-rw-r--r--os/kernel/include/chthreads.h8
14 files changed, 49 insertions, 49 deletions
diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h
index a7cafb581..83d7e423c 100644
--- a/os/kernel/include/ch.h
+++ b/os/kernel/include/ch.h
@@ -81,22 +81,22 @@
/**
* @brief Generic success constant.
- * @details This constant is functionally equivalent to @p FALSE but more
+ * @details This constant is functionally equivalent to @p false but more
* readable, it can be used as return value of all those functions
- * returning a @p bool_t as a status indicator.
+ * returning a @p bool as a status indicator.
*/
#if !defined(CH_SUCCESS) || defined(__DOXYGEN__)
-#define CH_SUCCESS FALSE
+#define CH_SUCCESS false
#endif
/**
* @brief Generic failure constant.
- * @details This constant is functionally equivalent to @p TRUE but more
+ * @details This constant is functionally equivalent to @p true but more
* readable, it can be used as return value of all those functions
- * returning a @p bool_t as a status indicator.
+ * returning a @p bool as a status indicator.
*/
#if !defined(CH_FAILED) || defined(__DOXYGEN__)
-#define CH_FAILED TRUE
+#define CH_FAILED true
#endif
/** @} */
diff --git a/os/kernel/include/chbsem.h b/os/kernel/include/chbsem.h
index fd9b0d3e2..2808f9c41 100644
--- a/os/kernel/include/chbsem.h
+++ b/os/kernel/include/chbsem.h
@@ -117,15 +117,15 @@ typedef struct {
*
* @param[out] bsp pointer to a @p binary_semaphore_t structure
* @param[in] taken initial state of the binary semaphore:
- * - @a FALSE, the initial state is not taken.
- * - @a TRUE, the initial state is taken.
+ * - @a false, the initial state is not taken.
+ * - @a true, the initial state is taken.
* .
*
* @init
*/
-static inline void chBSemInit(binary_semaphore_t *bsp, bool taken) {
+static inline void chBSemObjectInit(binary_semaphore_t *bsp, bool taken) {
- chSemInit(&bsp->bs_sem, taken ? 0 : 1);
+ chSemObjectInit(&bsp->bs_sem, taken ? 0 : 1);
}
/**
@@ -225,8 +225,8 @@ static inline msg_t chBSemWaitTimeout(binary_semaphore_t *bsp,
*
* @param[in] bsp pointer to a @p binary_semaphore_t structure
* @param[in] taken new state of the binary semaphore
- * - @a FALSE, the new state is not taken.
- * - @a TRUE, the new state is taken.
+ * - @a false, the new state is not taken.
+ * - @a true, the new state is taken.
* .
*
* @iclass
@@ -246,8 +246,8 @@ static inline void chBSemResetI(binary_semaphore_t *bsp, bool taken) {
*
* @param[in] bsp pointer to a @p binary_semaphore_t structure
* @param[in] taken new state of the binary semaphore
- * - @a FALSE, the new state is not taken.
- * - @a TRUE, the new state is taken.
+ * - @a false, the new state is not taken.
+ * - @a true, the new state is taken.
* .
*
* @api
@@ -293,8 +293,8 @@ static inline void chBSemSignal(binary_semaphore_t *bsp) {
*
* @param[in] bsp pointer to a @p binary_semaphore_t structure
* @return The binary semaphore current state.
- * @retval FALSE if the binary semaphore is not taken.
- * @retval TRUE if the binary semaphore is taken.
+ * @retval false if the binary semaphore is not taken.
+ * @retval true if the binary semaphore is taken.
*
* @iclass
*/
@@ -302,7 +302,7 @@ static inline bool chBSemGetStateI(binary_semaphore_t *bsp) {
chDbgCheckClassI();
- return bsp->bs_sem.s_cnt > 0 ? FALSE : TRUE;
+ return bsp->bs_sem.s_cnt > 0 ? false : true;
}
#endif /* CH_USE_SEMAPHORES */
diff --git a/os/kernel/include/chcond.h b/os/kernel/include/chcond.h
index d692310b6..5b26a2281 100644
--- a/os/kernel/include/chcond.h
+++ b/os/kernel/include/chcond.h
@@ -91,7 +91,7 @@ typedef struct condition_variable {
#ifdef __cplusplus
extern "C" {
#endif
- void chCondInit(condition_variable_t *cp);
+ void chCondObjectInit(condition_variable_t *cp);
void chCondSignal(condition_variable_t *cp);
void chCondSignalI(condition_variable_t *cp);
void chCondBroadcast(condition_variable_t *cp);
diff --git a/os/kernel/include/chevents.h b/os/kernel/include/chevents.h
index 4fe072050..327b16c88 100644
--- a/os/kernel/include/chevents.h
+++ b/os/kernel/include/chevents.h
@@ -164,7 +164,7 @@ extern "C" {
*
* @init
*/
-static inline void chEvtInit(event_source_t *esp) {
+static inline void chEvtObjectInit(event_source_t *esp) {
esp->es_next = (event_listener_t *)(void *)esp;
}
diff --git a/os/kernel/include/chheap.h b/os/kernel/include/chheap.h
index 03c1643ab..bc5a9afb4 100644
--- a/os/kernel/include/chheap.h
+++ b/os/kernel/include/chheap.h
@@ -100,7 +100,7 @@ struct memory_heap {
extern "C" {
#endif
void _heap_init(void);
- void chHeapInit(memory_heap_t *heapp, void *buf, size_t size);
+ void chHeapObjectInit(memory_heap_t *heapp, void *buf, size_t size);
void *chHeapAlloc(memory_heap_t *heapp, size_t size);
void chHeapFree(void *p);
size_t chHeapStatus(memory_heap_t *heapp, size_t *sizep);
diff --git a/os/kernel/include/chlists.h b/os/kernel/include/chlists.h
index 83552040a..3f71b2afc 100644
--- a/os/kernel/include/chlists.h
+++ b/os/kernel/include/chlists.h
@@ -87,7 +87,7 @@ static inline void list_init(threads_list_t *tlp) {
}
/**
- * @brief Evaluates to @p TRUE if the specified threads list is empty.
+ * @brief Evaluates to @p true if the specified threads list is empty.
*
* @notapi
*/
@@ -97,7 +97,7 @@ static inline bool list_isempty(threads_list_t *tlp) {
}
/**
- * @brief Evaluates to @p TRUE if the specified threads list is not empty.
+ * @brief Evaluates to @p true if the specified threads list is not empty.
*
* @notapi
*/
@@ -117,7 +117,7 @@ static inline void queue_init(threads_queue_t *tqp) {
}
/**
- * @brief Evaluates to @p TRUE if the specified threads queue is empty.
+ * @brief Evaluates to @p true if the specified threads queue is empty.
*
* @notapi
*/
@@ -127,7 +127,7 @@ static inline bool queue_isempty(threads_queue_t *tqp) {
}
/**
- * @brief Evaluates to @p TRUE if the specified threads queue is not empty.
+ * @brief Evaluates to @p true if the specified threads queue is not empty.
*
* @notapi
*/
diff --git a/os/kernel/include/chmboxes.h b/os/kernel/include/chmboxes.h
index 6cb903e82..f34f32c87 100644
--- a/os/kernel/include/chmboxes.h
+++ b/os/kernel/include/chmboxes.h
@@ -108,7 +108,7 @@ typedef struct {
#ifdef __cplusplus
extern "C" {
#endif
- void chMBInit(mailbox_t *mbp, msg_t *buf, cnt_t n);
+ void chMBObjectInit(mailbox_t *mbp, msg_t *buf, cnt_t n);
void chMBReset(mailbox_t *mbp);
msg_t chMBPost(mailbox_t *mbp, msg_t msg, systime_t timeout);
msg_t chMBPostS(mailbox_t *mbp, msg_t msg, systime_t timeout);
diff --git a/os/kernel/include/chmempools.h b/os/kernel/include/chmempools.h
index f211ec1d1..f09db04ea 100644
--- a/os/kernel/include/chmempools.h
+++ b/os/kernel/include/chmempools.h
@@ -106,7 +106,7 @@ typedef struct {
#ifdef __cplusplus
extern "C" {
#endif
- void chPoolInit(memory_pool_t *mp, size_t size, memgetfunc_t provider);
+ void chPoolObjectInit(memory_pool_t *mp, size_t size, memgetfunc_t provider);
void chPoolLoadArray(memory_pool_t *mp, void *p, size_t n);
void *chPoolAllocI(memory_pool_t *mp);
void *chPoolAlloc(memory_pool_t *mp);
diff --git a/os/kernel/include/chmsg.h b/os/kernel/include/chmsg.h
index 1e9099c73..4461b30dd 100644
--- a/os/kernel/include/chmsg.h
+++ b/os/kernel/include/chmsg.h
@@ -70,7 +70,7 @@ extern "C" {
/*===========================================================================*/
/**
- * @brief Evaluates to TRUE if the thread has pending messages.
+ * @brief Evaluates to @p true if the thread has pending messages.
*
* @iclass
*/
diff --git a/os/kernel/include/chmtx.h b/os/kernel/include/chmtx.h
index 589caccba..d6f2ddf3d 100644
--- a/os/kernel/include/chmtx.h
+++ b/os/kernel/include/chmtx.h
@@ -89,11 +89,11 @@ typedef struct mutex {
#ifdef __cplusplus
extern "C" {
#endif
- void chMtxInit(mutex_t *mp);
+ void chMtxObjectInit(mutex_t *mp);
void chMtxLock(mutex_t *mp);
void chMtxLockS(mutex_t *mp);
- bool_t chMtxTryLock(mutex_t *mp);
- bool_t chMtxTryLockS(mutex_t *mp);
+ bool chMtxTryLock(mutex_t *mp);
+ bool chMtxTryLockS(mutex_t *mp);
mutex_t *chMtxUnlock(void);
mutex_t *chMtxUnlockS(void);
void chMtxUnlockAll(void);
diff --git a/os/kernel/include/chqueues.h b/os/kernel/include/chqueues.h
index 0ea68deb8..acb2f8919 100644
--- a/os/kernel/include/chqueues.h
+++ b/os/kernel/include/chqueues.h
@@ -149,24 +149,24 @@ typedef GenericQueue InputQueue;
#define chIQGetEmptyI(iqp) (chQSizeI(iqp) - chQSpaceI(iqp))
/**
- * @brief Evaluates to @p TRUE if the specified input queue is empty.
+ * @brief Evaluates to @p true if the specified input queue is empty.
*
* @param[in] iqp pointer to an @p InputQueue structure.
* @return The queue status.
- * @retval FALSE if the queue is not empty.
- * @retval TRUE if the queue is empty.
+ * @retval false if the queue is not empty.
+ * @retval true if the queue is empty.
*
* @iclass
*/
#define chIQIsEmptyI(iqp) ((bool_t)(chQSpaceI(iqp) <= 0))
/**
- * @brief Evaluates to @p TRUE if the specified input queue is full.
+ * @brief Evaluates to @p true if the specified input queue is full.
*
* @param[in] iqp pointer to an @p InputQueue structure.
* @return The queue status.
- * @retval FALSE if the queue is not full.
- * @retval TRUE if the queue is full.
+ * @retval false if the queue is not full.
+ * @retval true if the queue is full.
*
* @iclass
*/
@@ -264,12 +264,12 @@ typedef GenericQueue OutputQueue;
#define chOQGetEmptyI(oqp) chQSpaceI(oqp)
/**
- * @brief Evaluates to @p TRUE if the specified output queue is empty.
+ * @brief Evaluates to @p true if the specified output queue is empty.
*
* @param[in] oqp pointer to an @p OutputQueue structure.
* @return The queue status.
- * @retval FALSE if the queue is not empty.
- * @retval TRUE if the queue is empty.
+ * @retval false if the queue is not empty.
+ * @retval true if the queue is empty.
*
* @iclass
*/
@@ -277,12 +277,12 @@ typedef GenericQueue OutputQueue;
((oqp)->q_counter != 0)))
/**
- * @brief Evaluates to @p TRUE if the specified output queue is full.
+ * @brief Evaluates to @p true if the specified output queue is full.
*
* @param[in] oqp pointer to an @p OutputQueue structure.
* @return The queue status.
- * @retval FALSE if the queue is not full.
- * @retval TRUE if the queue is full.
+ * @retval false if the queue is not full.
+ * @retval true if the queue is full.
*
* @iclass
*/
diff --git a/os/kernel/include/chschd.h b/os/kernel/include/chschd.h
index 619800362..3aa189dcd 100644
--- a/os/kernel/include/chschd.h
+++ b/os/kernel/include/chschd.h
@@ -170,7 +170,7 @@ extern "C" {
/**
* @brief Determines if the current thread must reschedule.
- * @details This function returns @p TRUE if there is a ready thread with
+ * @details This function returns @p true if there is a ready thread with
* higher priority.
*
* @iclass
@@ -184,7 +184,7 @@ static inline bool chSchIsRescRequiredI(void) {
/**
* @brief Determines if yielding is possible.
- * @details This function returns @p TRUE if there is a ready thread with
+ * @details This function returns @p true if there is a ready thread with
* equal or higher priority.
*
* @sclass
diff --git a/os/kernel/include/chsem.h b/os/kernel/include/chsem.h
index 78cf8ac37..d8cbdc944 100644
--- a/os/kernel/include/chsem.h
+++ b/os/kernel/include/chsem.h
@@ -89,7 +89,7 @@ typedef struct semaphore {
#ifdef __cplusplus
extern "C" {
#endif
- void chSemInit(semaphore_t *sp, cnt_t n);
+ void chSemObjectInit(semaphore_t *sp, cnt_t n);
void chSemReset(semaphore_t *sp, cnt_t n);
void chSemResetI(semaphore_t *sp, cnt_t n);
msg_t chSemWait(semaphore_t *sp);
diff --git a/os/kernel/include/chthreads.h b/os/kernel/include/chthreads.h
index c46103faf..ef5a0dbe9 100644
--- a/os/kernel/include/chthreads.h
+++ b/os/kernel/include/chthreads.h
@@ -302,8 +302,8 @@ typedef msg_t (*tfunc_t)(void *);
* @note Can be invoked in any context.
*
* @param[in] tp pointer to the thread
- * @retval TRUE thread terminated.
- * @retval FALSE thread not terminated.
+ * @retval true thread terminated.
+ * @retval false thread not terminated.
*
* @special
*/
@@ -313,8 +313,8 @@ typedef msg_t (*tfunc_t)(void *);
* @brief Verifies if the current thread has a termination request pending.
* @note Can be invoked in any context.
*
- * @retval TRUE termination request pending.
- * @retval FALSE termination request not pending.
+ * @retval true termination request pending.
+ * @retval false termination request not pending.
*
* @special
*/
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-25 11:24:50 +0000