utilHelper.h File Reference

#include <INTEGRITY.h>

Include dependency graph for utilHelper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	M_PI   (3.14159265358979323846)
#define	UINT8_MAX   (255U)
#define	UINT16_MAX   (65535U)
#define	UINT32_MAX   (4294967295U)
#define	FLOAT_TOLERANCE   1E-6
#define	NSEC_(x)
#define	USEC_(x)
#define	MSEC_(x)
#define	SEC_(x)
#define	HZ_(x)
#define	KHZ_(x)
#define	RANGE_CHECK(val, lo, hi)
	Inclusive range check.
#define	RANGE_CHECK_FLOAT(val, lo, hi)
	Inclusive range check for float values with tolerance.
#define	ENDIAN_16(data)
	Swap uint16 value.
#define	ENDIAN_32(data)
	Swap uint32 value.
#define	BIT_POS(n)
	Unsigned integer with bit position n set (signed in assembly language).
#define	READ_BIT(var, bit)
	Read a bit depending on a boolean value.
#define	READ_MASK_VALUE(var, mask)
	Read a value depending on a mask value.
#define	WRITE_SET_BIT(var, bit)
	Set a bit depending on a boolean value.
#define	WRITE_CLEAR_BIT(var, bit)
	Clear a bit depending on a boolean value.
#define	WRITE_MASK_VALUE(var, mask)
	Write a value depending on a mask value.
#define	TOGGLE_BIT(var, bit)
	Toggle a bit value.

Detailed Description

Author

Ramza Anuar ramza.nosp@m..anu.nosp@m.ar@tu.nosp@m.sas..nosp@m.my

Util helper header file

Macro Definition Documentation

BIT_POS

#define BIT_POS

(

n

)

Value:

(1UL << (n))

Unsigned integer with bit position n set (signed in assembly language).

ENDIAN_16

#define ENDIAN_16

(

data

)

Value:

((((data) >> 8) & 0x00FF) | (((data) << 8) & 0xFF00))

Swap uint16 value.

ENDIAN_32

#define ENDIAN_32

(

data

)

Value:

((((data) >> 24) & 0x000000FF) | (((data) >> 8) & 0x0000FF00) | (((data) << 8) & 0x00FF0000) | (((data) << 24) & 0xFF000000))

Swap uint32 value.

FLOAT_TOLERANCE

#define FLOAT_TOLERANCE   1E-6

HZ_

#define HZ_

(

x

)

Value:

(SEC_(1UL) / (x))

KHZ_

#define KHZ_

(

x

)

Value:

(HZ_((x) * 1000UL))

M_PI

#define M_PI   (3.14159265358979323846)

MSEC_

#define MSEC_

(

x

)

Value:

(USEC_(x) * 1000UL)

NSEC_

#define NSEC_

(

x

)

Value:

(x)

RANGE_CHECK

#define RANGE_CHECK	(		val,
			lo,
			hi )

Value:

((lo) <= (val) && (val) <= (hi))

Inclusive range check.

Parameters

val	should be the value to be checked
lo	should be the lower limit
hi	should be the upper limit

RANGE_CHECK_FLOAT

#define RANGE_CHECK_FLOAT	(		val,
			lo,
			hi )

Value:

(((val) - (lo) > -FLOAT_TOLERANCE) && ((hi) - (val) > -FLOAT_TOLERANCE))

Inclusive range check for float values with tolerance.

(1E-6)

Note

This macro uses a tolerance value to handle representational errors in floating-point comparisons.

Parameters

val	The value to be checked.
lo	The threshold value for the lower limit.
hi	The threshold value for the upper limit.

READ_BIT

#define READ_BIT	(		var,
			bit )

Value:

(((var) & BIT_POS(bit)) >> bit)

Read a bit depending on a boolean value.

The argument var is a variable whose value is written to as a side effect.

Parameters

var	Variable to be read
bit	Bit number

READ_MASK_VALUE

#define READ_MASK_VALUE	(		var,
			mask )

Value:

((var) & (mask))

Read a value depending on a mask value.

The argument var is a variable whose value is written to as a side effect.

Parameters

var	Variable to be read
mask	Number to mask

SEC_

#define SEC_

(

x

)

Value:

(MSEC_(x) * 1000UL)

TOGGLE_BIT

#define TOGGLE_BIT	(		var,
			bit )

Value:

((var) = ((var) ^ BIT_POS(bit)))

Toggle a bit value.

The argument var is a variable whose value is written to as a side effect.

Parameters

var	Variable to be toggled
bit	Bit number

UINT16_MAX

#define UINT16_MAX   (65535U)

UINT32_MAX

#define UINT32_MAX   (4294967295U)

UINT8_MAX

#define UINT8_MAX   (255U)

USEC_

#define USEC_

(

x

)

Value:

(NSEC_(x) * 1000UL)

WRITE_CLEAR_BIT

#define WRITE_CLEAR_BIT	(		var,
			bit )

Value:

((var) = ((var) & ~BIT_POS(bit)))

Clear a bit depending on a boolean value.

The argument var is a variable whose value is written to as a side effect.

Parameters

var	Variable to be altered
bit	Bit number

WRITE_MASK_VALUE

#define WRITE_MASK_VALUE	(		var,
			mask )

Value:

((var) = ((var) | (mask)))

Write a value depending on a mask value.

The argument var is a variable whose value is written to as a side effect.

Parameters

var	Variable to be altered
mask	Number to mask

WRITE_SET_BIT

#define WRITE_SET_BIT	(		var,
			bit )

Value:

((var) = ((var) | BIT_POS(bit)))

Set a bit depending on a boolean value.

The argument var is a variable whose value is written to as a side effect.

Parameters

var	Variable to be altered
bit	Bit number