/* SPDX-License-Identifier: GPL-2.0-only * * Copyright (C) 2020-21 Intel Corporation. */ #ifndef IOSM_IPC_MUX_H #define IOSM_IPC_MUX_H #include "iosm_ipc_protocol.h" #define IPC_MEM_MAX_UL_DG_ENTRIES … #define IPC_MEM_MAX_TDS_MUX_AGGR_UL … #define IPC_MEM_MAX_TDS_MUX_AGGR_DL … #define IPC_MEM_MAX_ADB_BUF_SIZE … #define IPC_MEM_MAX_UL_ADB_BUF_SIZE … #define IPC_MEM_MAX_DL_ADB_BUF_SIZE … /* Size of the buffer for the IP MUX Lite data buffer. */ #define IPC_MEM_MAX_DL_MUX_LITE_BUF_SIZE … /* TD counts for IP MUX Lite */ #define IPC_MEM_MAX_TDS_MUX_LITE_UL … #define IPC_MEM_MAX_TDS_MUX_LITE_DL … /* open session request (AP->CP) */ #define MUX_CMD_OPEN_SESSION … /* response to open session request (CP->AP) */ #define MUX_CMD_OPEN_SESSION_RESP … /* close session request (AP->CP) */ #define MUX_CMD_CLOSE_SESSION … /* response to close session request (CP->AP) */ #define MUX_CMD_CLOSE_SESSION_RESP … /* Flow control command with mask of the flow per queue/flow. */ #define MUX_LITE_CMD_FLOW_CTL … /* ACK the flow control command. Shall have the same Transaction ID as the * matching FLOW_CTL command. */ #define MUX_LITE_CMD_FLOW_CTL_ACK … /* Command for report packet indicating link quality metrics. */ #define MUX_LITE_CMD_LINK_STATUS_REPORT … /* Response to a report packet */ #define MUX_LITE_CMD_LINK_STATUS_REPORT_RESP … /* Used to reset a command/response state. */ #define MUX_CMD_INVALID … /* command response : command processed successfully */ #define MUX_CMD_RESP_SUCCESS … /* MUX for route link devices */ #define IPC_MEM_WWAN_MUX … /* Initiated actions to change the state of the MUX object. */ enum mux_event { … }; /* MUX session open command. */ struct mux_session_open { … }; /* MUX session close command. */ struct mux_session_close { … }; /* MUX channel close command. */ struct mux_channel_close { … }; /* Default message type to find out the right message type. */ struct mux_common { … }; /* List of ops in MUX mode. */ mux_msg; /* Parameter definition of the open session command. */ struct mux_cmd_open_session { … }; /* Parameter definition of the open session response. */ struct mux_cmd_open_session_resp { … }; /* Parameter definition of the close session response code */ struct mux_cmd_close_session_resp { … }; /* Parameter definition of the flow control command. */ struct mux_cmd_flow_ctl { … }; /* Parameter definition of the link status report code*/ struct mux_cmd_link_status_report { … }; /* Parameter definition of the link status report response code. */ struct mux_cmd_link_status_report_resp { … }; /** * union mux_cmd_param - Union-definition of the command parameters. * @open_session: Inband command for open session * @open_session_resp: Inband command for open session response * @close_session_resp: Inband command for close session response * @flow_ctl: In-band flow control on the opened interfaces * @link_status: In-band Link Status Report * @link_status_resp: In-band command for link status report response */ mux_cmd_param; /* States of the MUX object.. */ enum mux_state { … }; /* Supported MUX protocols. */ enum ipc_mux_protocol { … }; /* Supported UL data transfer methods. */ enum ipc_mux_ul_flow { … }; /* List of the MUX session. */ struct mux_session { … }; /** * struct mux_adth_dg - Structure of the datagram in the Aggregated Datagram * Table Header. * @datagram_index : Index (in bytes) to the k-th datagram in the table. * Index shall count from the start of the block including * the 16-byte header. This value shall be non-zero. * @datagram_length: Length of the k-th datagram including the head padding. * This value shall be non-zero. * @service_class: Service class identifier for the datagram. * @reserved: Reserved bytes. Set to zero */ struct mux_adth_dg { … }; /** * struct mux_qlth_ql - Structure of the queue level in the Aggregated * Datagram Queue Level Table Header. * @nr_of_bytes: Number of bytes available to transmit in the queue. */ struct mux_qlth_ql { … }; /** * struct mux_qlth - Structure of Aggregated Datagram Queue Level Table * Header. * @signature: Signature of the Queue Level Table Header * Value: 0x48544C51 (ASCII characters: 'Q' 'L' 'T' 'H') * @table_length: Length (in bytes) of the datagram table. This length * shall include the queue level table header size. * Minimum value:0x10 * @if_id: ID of the interface the queue levels in the table * belong to. * @reserved: Reserved byte. Set to zero. * @next_table_index: Index (in bytes) to the next table in the buffer. Index * shall count from the start of the block including the * 16-byte header. Value of zero indicates end of the list. * @reserved2: Reserved bytes. Set to zero * @ql: Queue level table with variable length */ struct mux_qlth { … }; /** * struct mux_adb - Structure of State of a single UL data block. * @dest_skb: Current UL skb for the data block. * @buf: ADB memory * @adgh: ADGH pointer * @qlth_skb: QLTH pointer * @next_table_index: Pointer to next table index. * @free_list: List of alloc. ADB for the UL sess. * @size: Size of the ADB memory. * @if_cnt: Statistic counter * @dg_cnt_total: Datagram count total * @payload_size: Payload Size * @dg: Datagram table. * @pp_qlt: Pointers to hold Queue Level Tables of session * @adbh: ADBH pointer * @qlt_updated: Queue level table updated * @dg_count: Datagram count */ struct mux_adb { … }; /** * struct mux_acb - Structure of Temporary ACB state. * @skb: Used UL skb. * @if_id: Session id. * @buf_p: Command buffer. * @wanted_response: Wanted Response * @got_response: Got response * @cmd: command * @got_param: Received command/response parameter */ struct mux_acb { … }; /** * struct iosm_mux - Structure of the data multiplexing over an IP channel. * @dev: Pointer to device structure * @session: Array of the MUX sessions. * @channel: Reference to the IP MUX channel * @pcie: Pointer to iosm_pcie struct * @imem: Pointer to iosm_imem * @wwan: Poinetr to iosm_wwan * @ipc_protocol: Pointer to iosm_protocol * @channel_id: Channel ID for MUX * @protocol: Type of the MUX protocol * @ul_flow: UL Flow type * @nr_sessions: Number of sessions * @instance_id: Instance ID * @state: States of the MUX object * @event: Initiated actions to change the state of the MUX object * @tx_transaction_id: Transaction id for the ACB command. * @rr_next_session: Next session number for round robin. * @ul_adb: State of the UL ADB/ADGH. * @size_needed: Variable to store the size needed during ADB preparation * @ul_data_pend_bytes: Pending UL data to be processed in bytes * @acb: Temporary ACB state * @wwan_q_offset: This will hold the offset of the given instance * Useful while passing or receiving packets from * wwan/imem layer. * @acb_tx_sequence_nr: Sequence number for the ACB header. * @adb_tx_sequence_nr: Sequence number for ADB header * @acc_adb_size: Statistic data for logging * @acc_payload_size: Statistic data for logging * @initialized: MUX object is initialized * @ev_mux_net_transmit_pending: * 0 means inform the IPC tasklet to pass the * accumulated uplink ADB to CP. * @adb_prep_ongoing: Flag for ADB preparation status */ struct iosm_mux { … } __packed; /* MUX configuration structure */ struct ipc_mux_config { … }; /** * ipc_mux_init - Allocates and Init MUX instance * @mux_cfg: Pointer to MUX configuration structure * @ipc_imem: Pointer to imem data-struct * * Returns: Initialized mux pointer on success else NULL */ struct iosm_mux *ipc_mux_init(struct ipc_mux_config *mux_cfg, struct iosm_imem *ipc_imem); /** * ipc_mux_deinit - Deallocates MUX instance * @ipc_mux: Pointer to the MUX instance. */ void ipc_mux_deinit(struct iosm_mux *ipc_mux); /** * ipc_mux_check_n_restart_tx - Checks for pending UL date bytes and then * it restarts the net interface tx queue if * device has set flow control as off. * @ipc_mux: Pointer to MUX data-struct */ void ipc_mux_check_n_restart_tx(struct iosm_mux *ipc_mux); /** * ipc_mux_get_active_protocol - Returns the active MUX protocol type. * @ipc_mux: Pointer to MUX data-struct * * Returns: enum of type ipc_mux_protocol */ enum ipc_mux_protocol ipc_mux_get_active_protocol(struct iosm_mux *ipc_mux); /** * ipc_mux_open_session - Opens a MUX session for IP traffic. * @ipc_mux: Pointer to MUX data-struct * @session_nr: Interface ID or session number * * Returns: channel id on success, failure value on error */ int ipc_mux_open_session(struct iosm_mux *ipc_mux, int session_nr); /** * ipc_mux_close_session - Closes a MUX session. * @ipc_mux: Pointer to MUX data-struct * @session_nr: Interface ID or session number * * Returns: channel id on success, failure value on error */ int ipc_mux_close_session(struct iosm_mux *ipc_mux, int session_nr); /** * ipc_mux_get_max_sessions - Returns the maximum sessions supported on the * provided MUX instance.. * @ipc_mux: Pointer to MUX data-struct * * Returns: Number of sessions supported on Success and failure value on error */ int ipc_mux_get_max_sessions(struct iosm_mux *ipc_mux); #endif
Codebase Browser
linux