dvfs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_DVFS_H_
#define ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_DVFS_H_
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <errno.h>
 
enum ironside_dvfs_oppoint {
        IRONSIDE_DVFS_OPP_HIGH = 0,
        IRONSIDE_DVFS_OPP_MEDLOW = 1,
        IRONSIDE_DVFS_OPP_LOW = 2
};
 
#define IRONSIDE_DVFS_OPPOINT_COUNT (3)
 
#define IRONSIDE_DVFS_ERROR_WRONG_OPPOINT (1)
#define IRONSIDE_DVFS_ERROR_BUSY (2)
#define IRONSIDE_DVFS_ERROR_OPPOINT_DATA (3)
#define IRONSIDE_DVFS_ERROR_PERMISSION (4)
#define IRONSIDE_DVFS_ERROR_NO_CHANGE_NEEDED (5)
#define IRONSIDE_DVFS_ERROR_TIMEOUT (6)
#define IRONSIDE_DVFS_ERROR_ISR_NOT_ALLOWED (7)
 
/* IRONside call identifiers with implicit versions.
 *
 * With the initial "version 0", the service ABI is allowed to break until the
 * first production release of IRONside SE.
 */
#define IRONSIDE_CALL_ID_DVFS_SERVICE_V0 3
 
/* Index of the DVFS oppoint within the service buffer. */
#define IRONSIDE_DVFS_SERVICE_OPPOINT_IDX (0)
/* Index of the return code within the service buffer. */
#define IRONSIDE_DVFS_SERVICE_RETCODE_IDX (0)
 
int ironside_dvfs_change_oppoint(enum ironside_dvfs_oppoint dvfs_oppoint);
 
static inline bool ironside_dvfs_is_oppoint_valid(enum ironside_dvfs_oppoint dvfs_oppoint)
{
        if (dvfs_oppoint != IRONSIDE_DVFS_OPP_HIGH &&
            dvfs_oppoint != IRONSIDE_DVFS_OPP_MEDLOW &&
            dvfs_oppoint != IRONSIDE_DVFS_OPP_LOW) {
                return false;
        }
 
        return true;
}
 
#endif /* ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_DVFS_H_ */