Definition library

Files
file	rkhdef.h
	Defines constants and macros.

Macros
#define	RKH_BIT(bit)   (1u << (bit))
	Create bit mask with single, specified bit set.
#define	RKH_BIT_MASK(bit_mask, bit_shift)    ((bit_mask) << (bit_shift))
	Shift a bit mask.
#define	RKH_BIT_IS_SET(val, mask)
	Determine if specified bit(s) in a value are set.
#define	RKH_BIT_IS_CLR(val, mask)
	Determine if specified bit(s) in a value are clear.
#define	RKH_BIT_IS_SET_ANY(val, mask)    ((((val) & (mask)) == 0u) ? (RKH_NO) : (RKH_YES))
	Determine if any specified bit(s) in a value are set.
#define	RKH_BIT_IS_CLR_ANY(val, mask)    ((((val) & (mask)) == (mask)) ? (RKH_NO) : (RKH_YES))
	Determine if any specified bit(s) in a value are clear.

Detailed Description

Macro Definition Documentation

RKH_BIT

#define RKH_BIT

(

bit

)

(1u << (bit))

Create bit mask with single, specified bit set.

Parameters

[in]

bit

Bit number of bit to set.

Returns

Bit mask with single, specified bit set.

Definition at line 88 of file rkhdef.h.

RKH_BIT08

#define RKH_BIT08

(

bit

)

((rui8_t)((rui8_t) 1u << (bit)))

Create bit mask of specified bit size with single, specified bit set.

Parameters

[in]

bit

Bit number of bit to set.

Returns

Bit mask with single, specified bit set.

Definition at line 101 of file rkhdef.h.

RKH_BIT_MASK

#define RKH_BIT_MASK	(		bit_mask,
			bit_shift
	)		((bit_mask) << (bit_shift))

Shift a bit mask.

Parameters

[in]	bit_mask	Bit mask to shift.
[in]	bit_shift	Number of bit positions to left-shift bit mask.

Returns

Shifted bit mask.

Definition at line 118 of file rkhdef.h.

RKH_BIT_MASK_08

#define RKH_BIT_MASK_08	(		bit_mask,
			bit_shift
	)		((rui8_t)((rui8_t)(bit_mask) << (bit_shift)))

Shift a bit mask of specified bit size.

Parameters

[in]	bit_mask	Bit mask to shift.
[in]	bit_shift	Number of bit positions to left-shift bit mask.

Returns

Shifted bit mask.

Definition at line 133 of file rkhdef.h.

RKH_BIT_SET_08

#define RKH_BIT_SET_08	(		val,
			mask
	)		((val) = (rui8_t)(((rui8_t)(val)) | ((rui8_t)(mask))))

Set specified bit(s) in a value of specified bit size.

Parameters

[in]	val	Value to modify by setting specified bit(s).
[in]	mask	Mask of bits to set.

Returns

Modified value with specified bit(s) set.

Definition at line 153 of file rkhdef.h.

RKH_BIT_CLR_08

#define RKH_BIT_CLR_08	(		val,
			mask
	)		((val) = (rui8_t)(((rui8_t)(val)) & ((rui8_t) ~(mask))))

Clear specified bit(s) in a value of specified bit size.

Parameters

[in]	val	Value to modify by clearing specified bit(s).
[in]	mask	Mask of bits to clear.

Returns

Modified value with specified bit(s) clear.

Definition at line 173 of file rkhdef.h.

RKH_BIT_IS_SET

#define RKH_BIT_IS_SET	(		val,
			mask
	)

Value:

    ((((mask)  !=  0u)  && \
      (((val) & (mask)) == (mask))) ? (RKH_YES) : (RKH_NO))

Determine if specified bit(s) in a value are set.

Parameters

[in]	val	Value to check for specified bit(s) set.
[in]	mask	Mask of bits to check if set.

Returns

RKH_YES, if ALL specified bit(s) are set in value. RKH_NO, if ALL specified bit(s) are NOT set in value.

Definition at line 194 of file rkhdef.h.

RKH_BIT_IS_CLR

#define RKH_BIT_IS_CLR	(		val,
			mask
	)

Value:

    ((((mask)  !=  0u)  && \
      (((val) & (mask)) ==  0u)) ? (RKH_YES) : (RKH_NO))

Determine if specified bit(s) in a value are clear.

Parameters

[in]	val	Value to check for specified bit(s) clear.
[in]	mask	Mask of bits to check if clear.

Returns

RKH_YES, if ALL specified bit(s) are clear in value. RKH_NO, if ALL specified bit(s) are NOT clear in value.

Definition at line 211 of file rkhdef.h.

RKH_BIT_IS_SET_ANY

#define RKH_BIT_IS_SET_ANY	(		val,
			mask
	)		((((val) & (mask)) == 0u) ? (RKH_NO) : (RKH_YES))

Determine if any specified bit(s) in a value are set.

Parameters

[in]	val	Value to check for specified bit(s) set.
[in]	mask	Mask of bits to check if set.

Returns

RKH_YES, if ALL specified bit(s) are set in value. RKH_NO, if ALL specified bit(s) are NOT set in value.

Definition at line 228 of file rkhdef.h.

RKH_BIT_IS_CLR_ANY

#define RKH_BIT_IS_CLR_ANY	(		val,
			mask
	)		((((val) & (mask)) == (mask)) ? (RKH_NO) : (RKH_YES))

Determine if any specified bit(s) in a value are clear.

Parameters

[in]	val	Value to check for specified bit(s) clear.
[in]	mask	Mask of bits to check if clear.

Returns

RKH_YES, if ALL specified bit(s) are clear in value. RKH_NO, if ALL specified bit(s) are NOT clear in value.

Definition at line 244 of file rkhdef.h.

RKH_BIT16

#define RKH_BIT16

(

bit

)

((rui16_t)((rui16_t) 1u << (bit)))

Create bit mask of specified bit size with single, specified bit set.

Parameters

[in]

bit

Bit number of bit to set.

Returns

Bit mask with single, specified bit set.

Definition at line 102 of file rkhdef.h.

RKH_BIT32

#define RKH_BIT32

(

bit

)

((rui32_t)((rui32_t) 1u << (bit)))

Create bit mask of specified bit size with single, specified bit set.

Parameters

[in]

bit

Bit number of bit to set.

Returns

Bit mask with single, specified bit set.

Definition at line 103 of file rkhdef.h.

RKH_BIT_MASK_16

#define RKH_BIT_MASK_16	(		bit_mask,
			bit_shift
	)		((rui16_t)((rui16_t)(bit_mask) << (bit_shift)))

Shift a bit mask of specified bit size.

Parameters

[in]	bit_mask	Bit mask to shift.
[in]	bit_shift	Number of bit positions to left-shift bit mask.

Returns

Shifted bit mask.

Definition at line 135 of file rkhdef.h.

RKH_BIT_MASK_32

#define RKH_BIT_MASK_32	(		bit_mask,
			bit_shift
	)		((rui32_t)((rui32_t)(bit_mask) << (bit_shift)))

Shift a bit mask of specified bit size.

Parameters

[in]	bit_mask	Bit mask to shift.
[in]	bit_shift	Number of bit positions to left-shift bit mask.

Returns

Shifted bit mask.

Definition at line 137 of file rkhdef.h.

RKH_BIT_SET_16

#define RKH_BIT_SET_16	(		val,
			mask
	)		((val) = (rui16_t)(((rui16_t)(val)) | ((rui16_t)(mask))))

Set specified bit(s) in a value of specified bit size.

Parameters

[in]	val	Value to modify by setting specified bit(s).
[in]	mask	Mask of bits to set.

Returns

Modified value with specified bit(s) set.

Definition at line 155 of file rkhdef.h.

RKH_BIT_SET_32

#define RKH_BIT_SET_32	(		val,
			mask
	)		((val) = (rui32_t)(((rui32_t)(val)) | ((rui32_t)(mask))))

Set specified bit(s) in a value of specified bit size.

Parameters

[in]	val	Value to modify by setting specified bit(s).
[in]	mask	Mask of bits to set.

Returns

Modified value with specified bit(s) set.

Definition at line 157 of file rkhdef.h.

RKH_BIT_CLR_16

#define RKH_BIT_CLR_16	(		val,
			mask
	)		((val) = (rui16_t)(((rui16_t)(val)) & ((rui16_t) ~(mask))))

Clear specified bit(s) in a value of specified bit size.

Parameters

[in]	val	Value to modify by clearing specified bit(s).
[in]	mask	Mask of bits to clear.

Returns

Modified value with specified bit(s) clear.

Definition at line 175 of file rkhdef.h.

RKH_BIT_CLR_32

#define RKH_BIT_CLR_32	(		val,
			mask
	)		((val) = (rui32_t)(((rui32_t)(val)) & ((rui32_t) ~(mask))))

Clear specified bit(s) in a value of specified bit size.

Parameters

[in]	val	Value to modify by clearing specified bit(s).
[in]	mask	Mask of bits to clear.

Returns

Modified value with specified bit(s) clear.

Definition at line 177 of file rkhdef.h.