common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef __COMMON_H__
#define __COMMON_H__
 
#include <stdint.h>
#include <string.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define NULL_CHECK(x)                                   \
        do {                                            \
                if ((x) == NULL) {                      \
                        return STATUS_NULL_ARGUMENT;    \
                }                                       \
        } while (0)
 
#define VERIFY_VALID_ARG(is_valid)                      \
do {                                                    \
        if (!(is_valid)) {                              \
                return STATUS_INVALID_ARGUMENT;         \
        }                                               \
} while (0)
 
#define HW_RETURN_IF(err_cond, err) __RETURN_CONDITIONAL(err_cond, err)
 
#ifndef __RETURN_CONDITIONAL
#    define __RETURN_CONDITIONAL(expr, ret_val)         \
                do {                                    \
                        if ((expr) == true) {           \
                                return ret_val;         \
                        }                               \
                }                                       \
                while (0)
#endif
 
typedef void(*generic_cb_t)(void);
 
typedef generic_cb_t irq_handler_t;
 
typedef void(*async_drdy_cb_t)(void *data, uint32_t data_size);
 
typedef enum status_e {
        STATUS_SUCCESS,
 
        STATUS_ALREADY_IN_MODE,
 
        STATUS_HARDWARE_ERROR,
 
        STATUS_UNSPECIFIED_ERROR,
 
        STATUS_INVALID_ARGUMENT,
 
        STATUS_NULL_ARGUMENT,
 
        STATUS_BUSY,
 
        STATUS_UNAVAILABLE,
 
        STATUS_NOT_SUPPORTED,
 
        STATUS_TIMEOUT,
} status_t;
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
 
#endif /* __COMMON_H__ */