wwan/iosm/iosm_ipc_mux.h

1 /* SPDX-License-Identifier: GPL-2.0-only
3  * Copyright (C) 2020-21 Intel Corporation.
19 /* Size of the buffer for the IP MUX Lite data buffer. */
22 /* TD counts for IP MUX Lite */
26 /* open session request (AP->CP) */
29 /* response to open session request (CP->AP) */
32 /* close session request (AP->CP) */
35 /* response to close session request (CP->AP) */
58 /* MUX for route link devices */
61 /* Initiated actions to change the state of the MUX object. */
64 	MUX_E_MUX_SESSION_OPEN, /* Create the MUX channel and a session. */
66 	MUX_E_MUX_CHANNEL_CLOSE, /* Release the MUX channel. */
67 	MUX_E_NO_ORDERS, /* No MUX order. */
68 	MUX_E_NOT_APPLICABLE, /* Defect IP MUX. */
71 /* MUX session open command. */
77 /* MUX session close command. */
83 /* MUX channel close command. */
93 /* List of ops in MUX mode. */
146  * union mux_cmd_param - Union-definition of the command parameters.
150  * @flow_ctl:		In-band flow control on the opened interfaces
151  * @link_status:	In-band Link Status Report
152  * @link_status_resp:	In-band command for link status report response
163 /* States of the MUX object.. */
165 	MUX_S_INACTIVE, /* IP MUX is unused. */
166 	MUX_S_ACTIVE, /* IP MUX channel is available. */
167 	MUX_S_ERROR, /* Defect IP MUX. */
170 /* Supported MUX protocols. */
184 /* List of the MUX session. */
201  * struct mux_adth_dg - Structure of the datagram in the Aggregated Datagram
203  * @datagram_index :	Index (in bytes) to the k-th datagram in the table.
205  *			the 16-byte header. This value shall be non-zero.
206  * @datagram_length:	Length of the k-th datagram including the head padding.
207  *			This value shall be non-zero.
219  * struct mux_qlth_ql - Structure of the queue level in the Aggregated
228  * struct mux_qlth -    Structure of Aggregated Datagram Queue Level Table
240  *                      16-byte header. Value of zero indicates end of the list.
255  * struct mux_adb - Structure of State of a single UL data block.
292  * struct mux_acb - Structure of Temporary ACB state.
312  * struct iosm_mux - Structure of the data multiplexing over an IP channel.
314  * @session:		Array of the MUX sessions.
315  * @channel:		Reference to the IP MUX channel
320  * @channel_id:		Channel ID for MUX
321  * @protocol:		Type of the MUX protocol
325  * @state:		States of the MUX object
326  * @event:		Initiated actions to change the state of the MUX object
340  * @initialized:	MUX object is initialized
377 /* MUX configuration structure */
385  * ipc_mux_init - Allocates and Init MUX instance
386  * @mux_cfg:	Pointer to MUX configuration structure
387  * @ipc_imem:	Pointer to imem data-struct
389  * Returns: Initialized mux pointer on success else NULL
395  * ipc_mux_deinit - Deallocates MUX instance
396  * @ipc_mux:	Pointer to the MUX instance.
401  * ipc_mux_check_n_restart_tx - Checks for pending UL date bytes and then
404  * @ipc_mux:	Pointer to MUX data-struct
409  * ipc_mux_get_active_protocol - Returns the active MUX protocol type.
410  * @ipc_mux:	Pointer to MUX data-struct
417  * ipc_mux_open_session - Opens a MUX session for IP traffic.
418  * @ipc_mux:	Pointer to MUX data-struct
426  * ipc_mux_close_session - Closes a MUX session.
427  * @ipc_mux:	Pointer to MUX data-struct
435  * ipc_mux_get_max_sessions - Returns the maximum sessions supported on the
436  *			      provided MUX instance..
437  * @ipc_mux:	Pointer to MUX data-struct