intel_adsp_host_ipc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022, 2025 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_IPC_BACKEND_INTEL_ADSP_IPC_H
#define ZEPHYR_INCLUDE_IPC_BACKEND_INTEL_ADSP_IPC_H
 
#include <intel_adsp_ipc_devtree.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/pm/device.h>
 
#include <zephyr/ipc/ipc_service_backend.h>

enum intel_adsp_send_len {
        INTEL_ADSP_IPC_SEND_MSG,

        INTEL_ADSP_IPC_SEND_MSG_SYNC,

        INTEL_ADSP_IPC_SEND_MSG_EMERGENCY,

        INTEL_ADSP_IPC_SEND_DONE,

        INTEL_ADSP_IPC_SEND_IS_COMPLETE,
};

enum intel_adsp_cb_ret {
        INTEL_ADSP_IPC_CB_RET_OKAY = 0,

        INTEL_ADSP_IPC_CB_RET_EXT_COMPLETE,
};

enum intel_adsp_cb_len {
        INTEL_ADSP_IPC_CB_MSG,

        INTEL_ADSP_IPC_CB_DONE,
};

struct intel_adsp_ipc_msg {
        uint32_t data;

        uint32_t ext_data;

        k_timeout_t timeout;
};
 
#ifdef CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE

typedef bool (*intel_adsp_ipc_handler_t)(const struct device *dev, void *arg, uint32_t data,
                                         uint32_t ext_data);

typedef bool (*intel_adsp_ipc_done_t)(const struct device *dev, void *arg);
 
#endif /* CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE */
 
#ifdef CONFIG_PM_DEVICE
typedef int (*intel_adsp_ipc_resume_handler_t)(const struct device *dev, void *arg);
 
typedef int (*intel_adsp_ipc_suspend_handler_t)(const struct device *dev, void *arg);
#endif /* CONFIG_PM_DEVICE */

struct intel_adsp_ipc_config {
        volatile struct intel_adsp_ipc *regs;
};

struct intel_adsp_ipc_data {
        struct k_sem sem;

        struct k_spinlock lock;

        bool tx_ack_pending;

        const struct ipc_ept_cfg *ept_cfg;
 
#ifdef CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE
        intel_adsp_ipc_handler_t handle_message;

        void *handler_arg;

        intel_adsp_ipc_done_t done_notify;

        void *done_arg;
#endif /* CONFIG_INTEL_ADSP_IPC_OLD_INTERFACE */
 
#ifdef CONFIG_PM_DEVICE
        intel_adsp_ipc_resume_handler_t resume_fn;

        void *resume_fn_args;

        intel_adsp_ipc_suspend_handler_t suspend_fn;

        void *suspend_fn_args;
#endif /* CONFIG_PM_DEVICE */
};

struct intel_adsp_ipc_ept_priv_data {
        int cb_ret;

        void *priv;
};
 
#ifdef CONFIG_PM_DEVICE

void intel_adsp_ipc_set_resume_handler(const struct device *dev, intel_adsp_ipc_resume_handler_t fn,
                                       void *arg);

void intel_adsp_ipc_set_suspend_handler(const struct device *dev,
                                        intel_adsp_ipc_suspend_handler_t fn, void *arg);
 
#endif /* CONFIG_PM_DEVICE */
 
#endif /* ZEPHYR_INCLUDE_IPC_BACKEND_INTEL_ADSP_IPC_H */