clk.h

Go to the documentation of this file.

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

 
#ifndef _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_CLK_H_
#define _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_CLK_H_
 
#include <zephyr/drivers/firmware/scmi/protocol.h>


#define SCMI_CLK_CONFIG_DISABLE_ENABLE_MASK GENMASK(1, 0)
#define SCMI_CLK_CONFIG_ENABLE_DISABLE(x)\
        ((uint32_t)(x) & SCMI_CLK_CONFIG_DISABLE_ENABLE_MASK)

#define SCMI_CLK_ATTRIBUTES_CLK_NUM(x) ((x) & GENMASK(15, 0))

#define SCMI_CLK_RATE_SET_FLAGS_ASYNC                BIT(0)
#define SCMI_CLK_RATE_SET_FLAGS_IGNORE_DELEAYED_RESP BIT(1)
#define SCMI_CLK_RATE_SET_FLAGS_ROUNDS_UP_DOWN       BIT(2)
#define SCMI_CLK_RATE_SET_FLAGS_ROUNDS_AUTO          BIT(3)

#define SCMI_CLK_PROTOCOL_SUPPORTED_VERSION     0x30000

#define SCMI_PROTO_VER_MAJOR(v) ((v) >> 16)

#define SCMI_PROTO_VER_MINOR(v) ((v) & 0xFFFF)

#define SCMI_CLK_NAME_LEN 16

#define SCMI_CLK_ENABLED(attributes) ((attributes) & BIT(0))

#define SCMI_CLK_HAS_RESTRICTIONS(attributes) ((attributes) & BIT(1))

#define SCMI_CLK_STATE_CONTROL_ALLOWED(permissions) ((permissions) & BIT(31))

struct scmi_clock_config {
        uint32_t clk_id;
        uint32_t attributes;
        uint32_t extended_cfg_val;
};

struct scmi_clock_rate_config {
        uint32_t flags;
        uint32_t clk_id;
        uint32_t rate[2];
};

struct scmi_clock_attributes {
        uint32_t attributes;
        uint8_t clock_name[SCMI_CLK_NAME_LEN];
        uint32_t clock_enable_delay;
};

int scmi_clock_config_set(struct scmi_protocol *proto,
                          struct scmi_clock_config *cfg);
int scmi_clock_rate_get(struct scmi_protocol *proto,
                        uint32_t clk_id, uint32_t *rate);

int scmi_clock_rate_set(struct scmi_protocol *proto, struct scmi_clock_rate_config *cfg);

int scmi_clock_parent_get(struct scmi_protocol *proto, uint32_t clk_id, uint32_t *parent_id);

int scmi_clock_parent_set(struct scmi_protocol *proto, uint32_t clk_id, uint32_t parent_id);

int scmi_clock_attributes(struct scmi_protocol *proto, uint32_t clk_id,
                          struct scmi_clock_attributes *attributes);

int scmi_clock_get_permissions(struct scmi_protocol *proto, uint32_t clk_id,
                               uint32_t *permissions);
 
#endif /* _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_CLK_H_ */