Skip to content

include: zephyr: arch: common: fix sys_test_bit() and friends documentation #97487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

include: zephyr: arch: common: fix sys_test_bit() and friends documentation #97487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions include/zephyr/sys/sys_io.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,8 @@ typedef uintptr_t mem_addr_t;
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test (from 0 to 31)
*
* @return 1 if it is set, 0 otherwise
* @return the bitwise AND result of @p addr content and (1 << @p bit).
* Result is 0 only if the bit is cleared otherwise result is a non-0 value.
*/

/**
Expand All @@ -298,7 +299,8 @@ typedef uintptr_t mem_addr_t;
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and set (from 0 to 31)
*
* @return 1 if it was set, 0 otherwise
* @return the bitwise AND result of @p addr content and (1 << @p bit) before target bit
* is set. Result is 0 only if the bit was cleared otherwise result is a non-0 value.
*/

/**
Expand All @@ -311,7 +313,8 @@ typedef uintptr_t mem_addr_t;
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and clear (from 0 to 31)
*
* @return 0 if it was clear, 1 otherwise
* @return the bitwise AND result of @p addr content and (1 << @p bit) before target bit
* is cleared. Result is 0 only if the bit was cleared otherwise result is a non-0 value.
*/

/**
Expand Down Expand Up @@ -344,7 +347,8 @@ typedef uintptr_t mem_addr_t;
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test (arbitrary
*
* @return 1 if it is set, 0 otherwise
* @return the bitwise AND result of @p addr content and (1 << @p bit). Result is 0
* only if the bit is cleared otherwise result is a non-0 value.
*/

/**
Expand All @@ -357,7 +361,8 @@ typedef uintptr_t mem_addr_t;
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and set (arbitrary)
*
* @return 1 if it was set, 0 otherwise
* @return the bitwise AND result of @p addr content and (1 << @p bit) before target bit
* is set. Result is 0 only if the bit was cleared otherwise result is a non-0 value.
*/

/**
Expand All @@ -370,7 +375,8 @@ typedef uintptr_t mem_addr_t;
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and clear (arbitrary)
*
* @return 0 if it was clear, 1 otherwise
* @return the bitwise AND result of @p addr content and (1 << @p bit) before target bit
* is cleared. Result is 0 only if the bit was cleared otherwise result is a non-0 value.
*/


Expand Down