/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ /* * Copyright (C) 2005-2014 Intel Corporation * Copyright (C) 2013-2015 Intel Mobile Communications GmbH * Copyright (C) 2016-2017 Intel Deutschland GmbH */ #ifndef __iwl_fw_api_cmdhdr_h__ #define __iwl_fw_api_cmdhdr_h__ /** * DOC: Host command section * * A host command is a command issued by the upper layer to the fw. There are * several versions of fw that have several APIs. The transport layer is * completely agnostic to these differences. * The transport does provide helper functionality (i.e. SYNC / ASYNC mode), */ #define SEQ_TO_QUEUE(s) … #define QUEUE_TO_SEQ(q) … #define SEQ_TO_INDEX(s) … #define INDEX_TO_SEQ(i) … #define SEQ_RX_FRAME … /* * those functions retrieve specific information from * the id field in the iwl_host_cmd struct which contains * the command id, the group id and the version of the command * and vice versa */ static inline u8 iwl_cmd_opcode(u32 cmdid) { … } static inline u8 iwl_cmd_groupid(u32 cmdid) { … } static inline u8 iwl_cmd_version(u32 cmdid) { … } static inline u32 iwl_cmd_id(u8 opcode, u8 groupid, u8 version) { … } /* make u16 wide id out of u8 group and opcode */ #define WIDE_ID(grp, opcode) … #define DEF_ID(opcode) … /* due to the conversion, this group is special; new groups * should be defined in the appropriate fw-api header files */ #define IWL_ALWAYS_LONG_GROUP … /** * struct iwl_cmd_header - (short) command header format * * This header format appears in the beginning of each command sent from the * driver, and each response/notification received from uCode. */ struct iwl_cmd_header { … } __packed; /** * struct iwl_cmd_header_wide * * This header format appears in the beginning of each command sent from the * driver, and each response/notification received from uCode. * this is the wide version that contains more information about the command * like length, version and command type * * @cmd: command ID, like in &struct iwl_cmd_header * @group_id: group ID, like in &struct iwl_cmd_header * @sequence: sequence, like in &struct iwl_cmd_header * @length: length of the command * @reserved: reserved * @version: command version */ struct iwl_cmd_header_wide { … } __packed; /** * struct iwl_calib_res_notif_phy_db - Receive phy db chunk after calibrations * @type: type of the result - mostly ignored * @length: length of the data * @data: data, length in @length */ struct iwl_calib_res_notif_phy_db { … } __packed; /** * struct iwl_phy_db_cmd - configure operational ucode * @type: type of the data * @length: length of the data * @data: data, length in @length */ struct iwl_phy_db_cmd { … } __packed; /** * struct iwl_cmd_response - generic response struct for most commands * @status: status of the command asked, changes for each one */ struct iwl_cmd_response { … }; #endif /* __iwl_fw_api_cmdhdr_h__ */