root/include/linux/firmware/samsung/exynos-acpm-protocol.h
/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright 2020 Samsung Electronics Co., Ltd.
 * Copyright 2020 Google LLC.
 * Copyright 2024 Linaro Ltd.
 */

#ifndef __EXYNOS_ACPM_PROTOCOL_H
#define __EXYNOS_ACPM_PROTOCOL_H

#include <linux/types.h>

struct acpm_handle;
struct device_node;

struct acpm_dvfs_ops {
        int (*set_rate)(const struct acpm_handle *handle,
                        unsigned int acpm_chan_id, unsigned int clk_id,
                        unsigned long rate);
        unsigned long (*get_rate)(const struct acpm_handle *handle,
                                  unsigned int acpm_chan_id,
                                  unsigned int clk_id);
};

struct acpm_pmic_ops {
        int (*read_reg)(const struct acpm_handle *handle,
                        unsigned int acpm_chan_id, u8 type, u8 reg, u8 chan,
                        u8 *buf);
        int (*bulk_read)(const struct acpm_handle *handle,
                         unsigned int acpm_chan_id, u8 type, u8 reg, u8 chan,
                         u8 count, u8 *buf);
        int (*write_reg)(const struct acpm_handle *handle,
                         unsigned int acpm_chan_id, u8 type, u8 reg, u8 chan,
                         u8 value);
        int (*bulk_write)(const struct acpm_handle *handle,
                          unsigned int acpm_chan_id, u8 type, u8 reg, u8 chan,
                          u8 count, const u8 *buf);
        int (*update_reg)(const struct acpm_handle *handle,
                          unsigned int acpm_chan_id, u8 type, u8 reg, u8 chan,
                          u8 value, u8 mask);
};

struct acpm_ops {
        struct acpm_dvfs_ops dvfs_ops;
        struct acpm_pmic_ops pmic_ops;
};

/**
 * struct acpm_handle - Reference to an initialized protocol instance
 * @ops:
 */
struct acpm_handle {
        struct acpm_ops ops;
};

struct device;

#if IS_ENABLED(CONFIG_EXYNOS_ACPM_PROTOCOL)
const struct acpm_handle *devm_acpm_get_by_node(struct device *dev,
                                                struct device_node *np);
#else

static inline const struct acpm_handle *devm_acpm_get_by_node(struct device *dev,
                                                              struct device_node *np)
{
        return NULL;
}
#endif

#endif /* __EXYNOS_ACPM_PROTOCOL_H */