wwan/iosm/iosm_ipc_protocol_ops.h

1 /* SPDX-License-Identifier: GPL-2.0-only
3  * Copyright (C) 2020-21 Intel Corporation.
14  * enum ipc_mem_td_cs - Completion status of a TD
15  * @IPC_MEM_TD_CS_INVALID:	      Initial status - td not yet used.
16  * @IPC_MEM_TD_CS_PARTIAL_TRANSFER:   More data pending -> next TD used for this
33  * enum ipc_mem_msg_cs - Completion status of IPC Message
45  * struct ipc_msg_prep_args_pipe - struct for pipe args for message preparation
53  * struct ipc_msg_prep_args_sleep - struct for sleep args for message
56  * @state:	0=enter sleep, 1=exit sleep
64  * struct ipc_msg_prep_feature_set - struct for feature set argument for
66  * @reset_enable:	0=out-of-band, 1=in-band-crash notification
73  * struct ipc_msg_prep_map - struct for map argument for message preparation
74  * @region_id:	Region to map
75  * @addr:	Pcie addr of region to map
76  * @size:	Size of the region to map
85  * struct ipc_msg_prep_unmap - struct for unmap argument for message preparation
93  * struct ipc_msg_prep_args - Union to handle different message types
96  * @sleep:		Sleep message preparation struct
98  * @map:		Memory map message preparation struct
104 	struct ipc_msg_prep_args_sleep sleep;  member
106 	struct ipc_msg_prep_map map;  member
111  * enum ipc_msg_prep_type - Enum for message prepare actions
112  * @IPC_MSG_PREP_SLEEP:		Sleep message preparation type
116  * @IPC_MSG_PREP_MAP:		Memory map message preparation type
129  * struct ipc_rsp - Response to sent message
139  * enum ipc_mem_msg - Type-definition of the messages.
140  * @IPC_MEM_MSG_OPEN_PIPE:	AP ->CP: Open a pipe
141  * @IPC_MEM_MSG_CLOSE_PIPE:	AP ->CP: Close a pipe
142  * @IPC_MEM_MSG_ABORT_PIPE:	AP ->CP: wait for completion of the
144  *				IO-transfers for the pipe
145  * @IPC_MEM_MSG_SLEEP:		AP ->CP: host enter or exit sleep
146  * @IPC_MEM_MSG_FEATURE_SET:	AP ->CP: Intel feature configuration
157  * struct ipc_mem_msg_open_pipe - Message structure for open pipe
177  * struct ipc_mem_msg_close_pipe - Message structure for close pipe
197  * struct ipc_mem_msg_abort_pipe - Message structure for abort pipe
217  * struct ipc_mem_msg_host_sleep - Message structure for sleep message.
221  * @state:		0=enter sleep, 1=exit sleep,
222  *			2=enter sleep no protocol
241  * struct ipc_mem_msg_feature_set - Message structure for feature_set message
244  * @reset_enable:		0=out-of-band, 1=in-band-crash notification
261  * struct ipc_mem_msg_common - Message structure for completion status update.
279  * union ipc_mem_msg_entry - Union with all possible messages.
283  * @host_sleep:		Host sleep message struct
299 		/*   0 :  63 - 64-bit address of a buffer in host memory. */
302 			/*   0 :  31 - 32 bit address */
304 			/*  32 :  63 - corresponding descriptor */
309 	/*	0 - 2nd byte - Size of the buffer.
314 	 *	3rd byte - This field provides the completion status
321 	/*	0th - nr of following descriptors
322 	 *	1 - 3rd byte - reserved
328  * ipc_protocol_msg_prep - Prepare message based upon message type
340  * ipc_protocol_msg_hp_update - Function for head pointer update
347  * ipc_protocol_msg_process - Function for processing responses
357  * ipc_protocol_ul_td_send - Function for sending the data to CP
369  * ipc_protocol_ul_td_process - Function for processing the sent data
379  * ipc_protocol_dl_td_prepare - Function for providing DL TDs to CP
389  * ipc_protocol_dl_td_process - Function for processing the DL data
399  * ipc_protocol_get_head_tail_index - Function for getting Head and Tail
410  * ipc_protocol_get_ipc_status - Function for getting the IPC Status
419  * ipc_protocol_pipe_cleanup - Function to cleanup pipe resources
427  * ipc_protocol_get_ap_exec_stage - Function for getting AP Exec Stage
436  * ipc_protocol_pm_dev_get_sleep_notification - Function for getting Dev Sleep