sof/src/include/ipc4/handler.h at 922ba5d5e292a702bf44eb10192a3353c932293a · jsarha/sof · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2026 Intel Corporation.
 */

#ifndef __SOF_IPC4_HANDLER_H__
#define __SOF_IPC4_HANDLER_H__

struct ipc4_message_request;

/**
 * \brief Processes IPC4 userspace module message.
 * @param[in] ipc4 IPC4 message request.
 * @param[in] reply IPC message reply structure.
 * @return IPC4_SUCCESS on success, error code otherwise.
 */
int ipc4_user_process_module_message(struct ipc4_message_request *ipc4, struct ipc_msg *reply);

/**
 * \brief Processes IPC4 userspace global message.
 * @param[in] ipc4 IPC4 message request.
 * @param[in] reply IPC message reply structure.
 * @return IPC4_SUCCESS on success, error code otherwise.
 */
int ipc4_user_process_glb_message(struct ipc4_message_request *ipc4, struct ipc_msg *reply);

/**
 * \brief Increment the IPC compound message pre-start counter.
 * @param[in] msg_id IPC message ID.
 */
void ipc_compound_pre_start(int msg_id);

/**
 * \brief Decrement the IPC compound message pre-start counter on return value status.
 * @param[in] msg_id IPC message ID.
 * @param[in] ret Return value of the IPC command.
 * @param[in] delayed True if the reply is delayed.
 */
void ipc_compound_post_start(uint32_t msg_id, int ret, bool delayed);

/**
 * \brief Complete the IPC compound message.
 * @param[in] msg_id IPC message ID.
 * @param[in] error Error code of the IPC command.
 */
void ipc_compound_msg_done(uint32_t msg_id, int error);

/**
 * \brief Wait for the IPC compound message to complete.
 * @return 0 on success, error code otherwise on timeout.
 */
int ipc_wait_for_compound_msg(void);

#endif /* __SOF_IPC4_HANDLER_H__ */