utilHelper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, TUSAS Malaysia
 * All rights reserved. 
 * This file contains proprietary information. This
 * file shall not be duplicated, used, modified,
 * or disclosed in whole or in part without
 * the express written consent of TUSAS.
 */

 
#ifndef INCLUDED_UTIL_HELPER_H
#define INCLUDED_UTIL_HELPER_H
 
#include <INTEGRITY.h>
 
#ifndef M_PI
#define M_PI (3.14159265358979323846)
#endif
 
#ifndef UINT8_MAX
#define UINT8_MAX (255U)
#endif
 
#ifndef UINT16_MAX
#define UINT16_MAX (65535U)
#endif
 
#ifndef UINT32_MAX
#define UINT32_MAX (4294967295U)
#endif
 
#ifndef FLOAT_TOLERANCE
#define FLOAT_TOLERANCE 1E-6
#endif
 
#define NSEC_(x) (x) // Specify period in nanoseconds. (Output in nanoseconds)
#define USEC_(x) (NSEC_(x) * 1000UL) // Specify period in microseconds. (Output in nanoseconds)
#define MSEC_(x) (USEC_(x) * 1000UL) // Specify period in milliseconds. (Output in nanoseconds)
#define SEC_(x)  (MSEC_(x) * 1000UL) // Specify period in seconds. (Output in nanoseconds)
#define HZ_(x)   (SEC_(1UL) / (x)) // Specify frequency in hertz. (Output in nanoseconds)
#define KHZ_(x)  (HZ_((x) * 1000UL)) // Specify frequency in kilohertz. (Output in nanoseconds)
 
#ifndef RANGE_CHECK
#define RANGE_CHECK(val, lo, hi) ((lo) <= (val) && (val) <= (hi))
#endif
 
#ifndef RANGE_CHECK_FLOAT
#define RANGE_CHECK_FLOAT(val, lo, hi) (((val) - (lo) > -FLOAT_TOLERANCE) && ((hi) - (val) > -FLOAT_TOLERANCE))
#endif
 
#ifndef ENDIAN_16
#define ENDIAN_16(data) ((((data) >> 8) & 0x00FF) | (((data) << 8) & 0xFF00))
#endif
 
#ifndef ENDIAN_32
#define ENDIAN_32(data) ((((data) >> 24) & 0x000000FF) | (((data) >> 8) & 0x0000FF00) | (((data) << 8) & 0x00FF0000) | (((data) << 24) & 0xFF000000))
#endif
 
#ifndef BIT_POS
#define BIT_POS(n) (1UL << (n))
#endif
 
#ifndef READ_BIT
#define READ_BIT(var, bit) (((var) & BIT_POS(bit)) >> bit)
#endif
 
#ifndef READ_MASK_VALUE
#define READ_MASK_VALUE(var, mask) ((var) & (mask))
#endif
 
#ifndef WRITE_SET_BIT
#define WRITE_SET_BIT(var, bit) ((var) = ((var) | BIT_POS(bit)))
#endif
 
#ifndef WRITE_CLEAR_BIT
#define WRITE_CLEAR_BIT(var, bit) ((var) = ((var) & ~BIT_POS(bit)))
#endif
 
#ifndef WRITE_MASK_VALUE
#define WRITE_MASK_VALUE(var, mask) ((var) = ((var) | (mask)))
#endif
 
#ifndef TOGGLE_BIT
#define TOGGLE_BIT(var, bit) ((var) = ((var) ^ BIT_POS(bit)))
#endif
 
#endif // INCLUDED_UTIL_HELPER_H