power.h

Go to the documentation of this file.

/*
 * Copyright 2024 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_POWER_H_
#define _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_POWER_H_
 
#include <zephyr/drivers/firmware/scmi/protocol.h>
 
#define SCMI_POWER_STATE_SET_FLAGS_ASYNC BIT(0)
 
#define SCMI_POWER_DOMAIN_PROTOCOL_SUPPORTED_VERSION    0x30001


#define SCMI_POWER_STATE_TYPE_SHIFT     30U

#define SCMI_POWER_STATE_ID_MASK        (BIT(28) - 1)

#define SCMI_POWER_STATE_PARAM(type, id) \
        ((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \
         ((id) & SCMI_POWER_STATE_ID_MASK))



#define SCMI_POWER_STATE_GENERIC_ON     SCMI_POWER_STATE_PARAM(0, 0)

#define SCMI_POWER_STATE_GENERIC_OFF    SCMI_POWER_STATE_PARAM(1, 0)


struct scmi_power_state_config {
        uint32_t flags;
        uint32_t domain_id;
        uint32_t power_state;
};

enum scmi_power_domain_message {
        SCMI_POWER_DOMAIN_MSG_PROTOCOL_VERSION = 0x0,
        SCMI_POWER_DOMAIN_MSG_PROTOCOL_ATTRIBUTES = 0x1,
        SCMI_POWER_DOMAIN_MSG_PROTOCOL_MESSAGE_ATTRIBUTES = 0x2,
        SCMI_POWER_DOMAIN_MSG_POWER_DOMAIN_ATTRIBUTES = 0x3,
        SCMI_POWER_DOMAIN_MSG_POWER_STATE_SET = 0x4,
        SCMI_POWER_DOMAIN_MSG_POWER_STATE_GET = 0x5,
        SCMI_POWER_DOMAIN_MSG_POWER_STATE_NOTIFY = 0x6,
        SCMI_POWER_DOMAIN_MSG_POWER_STATE_CHANGE_REQEUSTED_NOTIFY = 0x7,
        SCMI_POWER_DOMAIN_MSG_POWER_DOMAIN_NAME_GET = 0x8,
        SCMI_POWER_DOMAIN_MSG_NEGOTIATE_PROTOCOL_VERSION = 0x10,
};

int scmi_power_state_set(struct scmi_power_state_config *cfg);
int scmi_power_state_get(uint32_t domain_id, uint32_t *power_state);
 
#endif /* _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_POWER_H_ */