cpu_load.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024, Nordic Semiconductor ASA
 * Copyright (c) 2025 Analog Devices, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SYS_CPU_LOAD_H_
#define ZEPHYR_INCLUDE_SYS_CPU_LOAD_H_
 
#include <stdbool.h>
#include <stdint.h>
#include <zephyr/toolchain.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define CPU_LOAD_PERMILLE_TO_PERCENT(permille) ((permille) / 10)

int cpu_load_get_cpu(unsigned int cpu_id, bool reset);

int cpu_load_get(bool reset);

void cpu_load_on_enter_idle(void);

void cpu_load_on_exit_idle(void);

void cpu_load_log_control(bool enable);
 
/* Optional callback for cpu_load_cb_reg
 *
 * This will be called from the k_timer expiry_fn used for periodic logging.
 * CONFIG_CPU_LOAD_LOG_PERIODICALLY must be configured to a positive value.
 * Time spent in this callback must be kept to a minimum.
 */
typedef void (*cpu_load_cb_t)(uint8_t percent);

int cpu_load_cb_reg(cpu_load_cb_t cb, uint8_t threshold_percent);

__deprecated static inline int cpu_load_metric_get(int cpu_id)
{
        int load = cpu_load_get_cpu((unsigned int)cpu_id, true);
 
        return (load < 0) ? load : CPU_LOAD_PERMILLE_TO_PERCENT(load);
}

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SYS_CPU_LOAD_H_ */