cpuconf.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_CPUCONF_H_
#define ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_CPUCONF_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <zephyr/drivers/firmware/nrf_ironside/call.h>
#include <zephyr/toolchain/common.h>
#include <nrf.h>
 
#define IRONSIDE_CPUCONF_ERROR_WRONG_CPU         (1)
#define IRONSIDE_CPUCONF_ERROR_MESSAGE_TOO_LARGE (2)
 
#define IRONSIDE_CALL_ID_CPUCONF_V0 2
 
enum {
        IRONSIDE_CPUCONF_SERVICE_CPU_PARAMS_IDX,
        IRONSIDE_CPUCONF_SERVICE_VECTOR_TABLE_IDX,
        IRONSIDE_CPUCONF_SERVICE_MSG_0,
        IRONSIDE_CPUCONF_SERVICE_MSG_1,
        IRONSIDE_CPUCONF_SERVICE_MSG_2,
        IRONSIDE_CPUCONF_SERVICE_MSG_3,
        /* The last enum value is reserved for the number of arguments */
        IRONSIDE_CPUCONF_NUM_ARGS
};
 
/* Maximum size of the CPUCONF message parameter. */
#define IRONSIDE_CPUCONF_SERVICE_MSG_MAX_SIZE (4 * sizeof(uint32_t))
 
/* IDX 0 is re-used by the error return code and the 'cpu' parameter. */
#define IRONSIDE_CPUCONF_SERVICE_RETCODE_IDX 0
 
BUILD_ASSERT(IRONSIDE_CPUCONF_NUM_ARGS <= NRF_IRONSIDE_CALL_NUM_ARGS);
 
int ironside_cpuconf(NRF_PROCESSORID_Type cpu, const void *vector_table, bool cpu_wait,
                     const uint8_t *msg, size_t msg_size);
 
#endif /* ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_CPUCONF_H_ */