iwlwifi: mvm: add documentation for all command IDs
authorJohannes Berg <johannes.berg@intel.com>
Tue, 16 May 2017 13:14:19 +0000 (15:14 +0200)
committerLuca Coelho <luciano.coelho@intel.com>
Thu, 29 Jun 2017 10:26:24 +0000 (13:26 +0300)
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Luca Coelho <luciano.coelho@intel.com>
drivers/net/wireless/intel/iwlwifi/iwl-fw-api.h
drivers/net/wireless/intel/iwlwifi/iwl-phy-db.c
drivers/net/wireless/intel/iwlwifi/mvm/fw-api-tx.h
drivers/net/wireless/intel/iwlwifi/mvm/fw-api.h

index a004409fa984dfa17e7290a2f5f8fb2a871db382..0e107f916ce3adef9d6f5ae788062b3b1b91daa6 100644 (file)
@@ -202,4 +202,28 @@ struct iwl_tx_queue_cfg_rsp {
        __le16 reserved;
 } __packed; /* TX_QUEUE_CFG_RSP_API_S_VER_2 */
 
+/**
+ * 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 {
+       __le16 type;
+       __le16 length;
+       u8 data[];
+} __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 {
+       __le16 type;
+       __le16 length;
+       u8 data[];
+} __packed;
+
 #endif /* __iwl_fw_api_h__*/
index 2893826d7d2b0b393694aaddd5387d64bf76e4cc..b7cd813ba70f1b9caf782e98166331b91073b005 100644 (file)
@@ -112,30 +112,12 @@ enum iwl_phy_db_section_type {
 
 #define PHY_DB_CMD 0x6c
 
-/*
- * phy db - configure operational ucode
- */
-struct iwl_phy_db_cmd {
-       __le16 type;
-       __le16 length;
-       u8 data[];
-} __packed;
-
 /* for parsing of tx power channel group data that comes from the firmware*/
 struct iwl_phy_db_chg_txp {
        __le32 space;
        __le16 max_channel_idx;
 } __packed;
 
-/*
- * phy db - Receive phy db chunk after calibrations
- */
-struct iwl_calib_res_notif_phy_db {
-       __le16 type;
-       __le16 length;
-       u8 data[];
-} __packed;
-
 struct iwl_phy_db *iwl_phy_db_init(struct iwl_trans *trans)
 {
        struct iwl_phy_db *phy_db = kzalloc(sizeof(struct iwl_phy_db),
index 4a6b919f13de39c14ef3c36141139323f33447e1..9d2a991221cfb6d9f34caff5740585ebfa9fd280 100644 (file)
@@ -595,6 +595,7 @@ struct iwl_mvm_tx_resp_v3 {
  * @ra_tid: bits [3:0] = ra, bits [7:4] = tid
  * @frame_ctrl: frame control
  * @tx_queue: TX queue for this response
+ * @reserved2: reserved for padding/alignment
  * @status: for non-agg:  frame status TX_STATUS_*
  *     For version 6 TX response isn't received for aggregation at all.
  *
index 60f86997f8cf40db5b803336bb2a6ebc332c966a..89e5ba3f4e42e04202da0c1b87964b236bdf7fe6 100644 (file)
@@ -185,7 +185,15 @@ enum iwl_legacy_cmds {
         * uses &struct iwl_scan_config_v1 or &struct iwl_scan_config
         */
        SCAN_CFG_CMD = 0xc,
+
+       /**
+        * @SCAN_REQ_UMAC: uses &struct iwl_scan_req_umac
+        */
        SCAN_REQ_UMAC = 0xd,
+
+       /**
+        * @SCAN_ABORT_UMAC: uses &struct iwl_umac_scan_abort
+        */
        SCAN_ABORT_UMAC = 0xe,
 
        /**
@@ -193,6 +201,10 @@ enum iwl_legacy_cmds {
         */
        SCAN_COMPLETE_UMAC = 0xf,
 
+       /**
+        * @BA_WINDOW_STATUS_NOTIFICATION_ID:
+        * uses &struct iwl_ba_window_status_notif
+        */
        BA_WINDOW_STATUS_NOTIFICATION_ID = 0x13,
 
        /**
@@ -207,12 +219,15 @@ enum iwl_legacy_cmds {
         * &struct iwl_mvm_add_sta_cmd or &struct iwl_mvm_add_sta_cmd_v7.
         */
        ADD_STA = 0x18,
+
        /**
         * @REMOVE_STA: &struct iwl_mvm_rm_sta_cmd
         */
        REMOVE_STA = 0x19,
 
-       /* paging get item */
+       /**
+        * @FW_GET_ITEM_CMD: uses &struct iwl_fw_get_item_cmd
+        */
        FW_GET_ITEM_CMD = 0x1a,
 
        /**
@@ -242,15 +257,33 @@ enum iwl_legacy_cmds {
         */
        SCD_QUEUE_CFG = 0x1d,
 
-       /* global key */
+       /**
+        * @WEP_KEY: uses &struct iwl_mvm_wep_key_cmd
+        */
        WEP_KEY = 0x20,
 
-       /* Memory */
+       /**
+        * @SHARED_MEM_CFG:
+        * retrieve shared memory configuration - response in
+        * &struct iwl_shared_mem_cfg
+        */
        SHARED_MEM_CFG = 0x25,
 
-       /* TDLS */
+       /**
+        * @TDLS_CHANNEL_SWITCH_CMD: uses &struct iwl_tdls_channel_switch_cmd
+        */
        TDLS_CHANNEL_SWITCH_CMD = 0x27,
+
+       /**
+        * @TDLS_CHANNEL_SWITCH_NOTIFICATION:
+        * uses &struct iwl_tdls_channel_switch_notif
+        */
        TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa,
+
+       /**
+        * @TDLS_CONFIG_CMD:
+        * &struct iwl_tdls_config_cmd, response in &struct iwl_tdls_config_res
+        */
        TDLS_CONFIG_CMD = 0xa7,
 
        /**
@@ -263,19 +296,27 @@ enum iwl_legacy_cmds {
         * &struct iwl_time_event_cmd, response in &struct iwl_time_event_resp
         */
        TIME_EVENT_CMD = 0x29, /* both CMD and response */
+
        /**
         * @TIME_EVENT_NOTIFICATION: &struct iwl_time_event_notif
         */
        TIME_EVENT_NOTIFICATION = 0x2a,
+
        /**
         * @BINDING_CONTEXT_CMD:
         * &struct iwl_binding_cmd or &struct iwl_binding_cmd_v1
         */
        BINDING_CONTEXT_CMD = 0x2b,
+
        /**
         * @TIME_QUOTA_CMD: &struct iwl_time_quota_cmd
         */
        TIME_QUOTA_CMD = 0x2c,
+
+       /**
+        * @NON_QOS_TX_COUNTER_CMD:
+        * command is &struct iwl_nonqos_seq_query_cmd
+        */
        NON_QOS_TX_COUNTER_CMD = 0x2d,
 
        /**
@@ -289,13 +330,42 @@ enum iwl_legacy_cmds {
         */
        FW_PAGING_BLOCK_CMD = 0x4f,
 
-       /* Scan offload */
+       /**
+        * @SCAN_OFFLOAD_REQUEST_CMD: uses &struct iwl_scan_req_lmac
+        */
        SCAN_OFFLOAD_REQUEST_CMD = 0x51,
+
+       /**
+        * @SCAN_OFFLOAD_ABORT_CMD: abort the scan - no further contents
+        */
        SCAN_OFFLOAD_ABORT_CMD = 0x52,
+
+       /**
+        * @HOT_SPOT_CMD: uses &struct iwl_hs20_roc_req
+        */
        HOT_SPOT_CMD = 0x53,
+
+       /**
+        * @SCAN_OFFLOAD_COMPLETE:
+        * notification, &struct iwl_periodic_scan_complete
+        */
        SCAN_OFFLOAD_COMPLETE = 0x6D,
+
+       /**
+        * @SCAN_OFFLOAD_UPDATE_PROFILES_CMD:
+        * update scan offload (scheduled scan) profiles/blacklist/etc.
+        */
        SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
+
+       /**
+        * @MATCH_FOUND_NOTIFICATION: scan match found
+        */
        MATCH_FOUND_NOTIFICATION = 0xd9,
+
+       /**
+        * @SCAN_ITERATION_COMPLETE:
+        * uses &struct iwl_lmac_scan_complete_notif
+        */
        SCAN_ITERATION_COMPLETE = 0xe7,
 
        /* Phy */
@@ -303,24 +373,55 @@ enum iwl_legacy_cmds {
         * @PHY_CONFIGURATION_CMD: &struct iwl_phy_cfg_cmd
         */
        PHY_CONFIGURATION_CMD = 0x6a,
+
+       /**
+        * @CALIB_RES_NOTIF_PHY_DB: &struct iwl_calib_res_notif_phy_db
+        */
        CALIB_RES_NOTIF_PHY_DB = 0x6b,
+
+       /**
+        * @PHY_DB_CMD: &struct iwl_phy_db_cmd
+        */
        PHY_DB_CMD = 0x6c,
 
-       /* ToF - 802.11mc FTM */
+       /**
+        * @TOF_CMD: &struct iwl_tof_config_cmd
+        */
        TOF_CMD = 0x10,
+
+       /**
+        * @TOF_NOTIFICATION: &struct iwl_tof_gen_resp_cmd
+        */
        TOF_NOTIFICATION = 0x11,
 
        /**
         * @POWER_TABLE_CMD: &struct iwl_device_power_cmd
         */
        POWER_TABLE_CMD = 0x77,
+
+       /**
+        * @PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION:
+        * &struct iwl_uapsd_misbehaving_ap_notif
+        */
        PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
+
+       /**
+        * @LTR_CONFIG: &struct iwl_ltr_config_cmd
+        */
        LTR_CONFIG = 0xee,
 
-       /* Thermal Throttling*/
+       /**
+        * @REPLY_THERMAL_MNG_BACKOFF:
+        * Thermal throttling command
+        */
        REPLY_THERMAL_MNG_BACKOFF = 0x7e,
 
-       /* Set/Get DC2DC frequency tune */
+       /**
+        * @DC2DC_CONFIG_CMD:
+        * Set/Get DC2DC frequency tune
+        * Command is &struct iwl_dc2dc_config_cmd,
+        * response is &struct iwl_dc2dc_config_resp
+        */
        DC2DC_CONFIG_CMD = 0x83,
 
        /**
@@ -328,7 +429,11 @@ enum iwl_legacy_cmds {
         */
        NVM_ACCESS_CMD = 0x88,
 
+       /**
+        * @BEACON_NOTIFICATION: &struct iwl_extended_beacon_notif
+        */
        BEACON_NOTIFICATION = 0x90,
+
        /**
         * @BEACON_TEMPLATE_CMD:
         *      Uses one of &struct iwl_mac_beacon_cmd_v6,
@@ -353,6 +458,12 @@ enum iwl_legacy_cmds {
         * &struct iwl_notif_statistics_cdb
         */
        STATISTICS_NOTIFICATION = 0x9d,
+
+       /**
+        * @EOSP_NOTIFICATION:
+        * Notify that a service period ended,
+        * &struct iwl_mvm_eosp_notification
+        */
        EOSP_NOTIFICATION = 0x9e,
 
        /**
@@ -361,8 +472,16 @@ enum iwl_legacy_cmds {
         */
        REDUCE_TX_POWER_CMD = 0x9f,
 
+       /**
+        * @CARD_STATE_NOTIFICATION:
+        * Card state (RF/CT kill) notification,
+        * uses &struct iwl_card_state_notif
+        */
        CARD_STATE_NOTIFICATION = 0xa1,
 
+       /**
+        * @MISSED_BEACONS_NOTIFICATION: &struct iwl_missed_beacons_notif
+        */
        MISSED_BEACONS_NOTIFICATION = 0xa2,
 
        /**
@@ -390,7 +509,19 @@ enum iwl_legacy_cmds {
         * &struct iwl_rx_mpdu_res_start or &struct iwl_rx_mpdu_desc
         */
        REPLY_RX_MPDU_CMD = 0xc1,
+
+       /**
+        * @FRAME_RELEASE:
+        * Frame release (reorder helper) notification, uses
+        * &struct iwl_frame_release
+        */
        FRAME_RELEASE = 0xc3,
+
+       /**
+        * @BA_NOTIF:
+        * BlockAck notification, uses &struct iwl_mvm_compressed_ba_notif
+        * or &struct iwl_mvm_ba_notif depending on the HW
+        */
        BA_NOTIF = 0xc5,
 
        /* Location Aware Regulatory */
@@ -404,18 +535,33 @@ enum iwl_legacy_cmds {
         */
        MCC_CHUB_UPDATE_CMD = 0xc9,
 
+       /**
+        * @MARKER_CMD: trace marker command, uses &struct iwl_mvm_marker
+        */
        MARKER_CMD = 0xcb,
 
        /**
         * @BT_PROFILE_NOTIFICATION: &struct iwl_bt_coex_profile_notif
         */
        BT_PROFILE_NOTIFICATION = 0xce,
+
        /**
         * @BT_CONFIG: &struct iwl_bt_coex_cmd
         */
        BT_CONFIG = 0x9b,
+
+       /**
+        * @BT_COEX_UPDATE_CORUN_LUT:
+        * &struct iwl_bt_coex_corun_lut_update_cmd
+        */
        BT_COEX_UPDATE_CORUN_LUT = 0x5b,
+
+       /**
+        * @BT_COEX_UPDATE_REDUCED_TXP:
+        * &struct iwl_bt_coex_reduced_txp_update_cmd
+        */
        BT_COEX_UPDATE_REDUCED_TXP = 0x5c,
+
        /**
         * @BT_COEX_CI: &struct iwl_bt_coex_ci_cmd
         */
@@ -430,21 +576,60 @@ enum iwl_legacy_cmds {
         */
        REPLY_BEACON_FILTERING_CMD = 0xd2,
 
+       /**
+        * @DTS_MEASUREMENT_NOTIFICATION:
+        * &struct iwl_dts_measurement_notif_v1 or
+        * &struct iwl_dts_measurement_notif_v2
+        */
        DTS_MEASUREMENT_NOTIFICATION = 0xdd,
 
+       /**
+        * @LDBG_CONFIG_CMD: configure continuous trace recording
+        */
        LDBG_CONFIG_CMD = 0xf6,
+
+       /**
+        * @DEBUG_LOG_MSG: Debugging log data from firmware
+        */
        DEBUG_LOG_MSG = 0xf7,
 
+       /**
+        * @BCAST_FILTER_CMD: &struct iwl_bcast_filter_cmd
+        */
        BCAST_FILTER_CMD = 0xcf,
+
+       /**
+        * @MCAST_FILTER_CMD: &struct iwl_mcast_filter_cmd
+        */
        MCAST_FILTER_CMD = 0xd0,
 
        /**
         * @D3_CONFIG_CMD: &struct iwl_d3_manager_config
         */
        D3_CONFIG_CMD = 0xd3,
+
+       /**
+        * @PROT_OFFLOAD_CONFIG_CMD: Depending on firmware, uses one of
+        * &struct iwl_proto_offload_cmd_v1, &struct iwl_proto_offload_cmd_v2,
+        * &struct iwl_proto_offload_cmd_v3_small,
+        * &struct iwl_proto_offload_cmd_v3_large
+        */
        PROT_OFFLOAD_CONFIG_CMD = 0xd4,
+
+       /**
+        * @OFFLOADS_QUERY_CMD:
+        * No data in command, response in &struct iwl_wowlan_status
+        */
        OFFLOADS_QUERY_CMD = 0xd5,
+
+       /**
+        * @REMOTE_WAKE_CONFIG_CMD: &struct iwl_wowlan_remote_wake_config
+        */
        REMOTE_WAKE_CONFIG_CMD = 0xd6,
+
+       /**
+        * @D0I3_END_CMD: End D0i3/D3 state, no command data
+        */
        D0I3_END_CMD = 0xed,
 
        /**
@@ -456,24 +641,31 @@ enum iwl_legacy_cmds {
         * @WOWLAN_CONFIGURATION: &struct iwl_wowlan_config_cmd
         */
        WOWLAN_CONFIGURATION = 0xe1,
+
        /**
         * @WOWLAN_TSC_RSC_PARAM: &struct iwl_wowlan_rsc_tsc_params_cmd
         */
        WOWLAN_TSC_RSC_PARAM = 0xe2,
+
        /**
         * @WOWLAN_TKIP_PARAM: &struct iwl_wowlan_tkip_params_cmd
         */
        WOWLAN_TKIP_PARAM = 0xe3,
+
        /**
         * @WOWLAN_KEK_KCK_MATERIAL: &struct iwl_wowlan_kek_kck_material_cmd
         */
        WOWLAN_KEK_KCK_MATERIAL = 0xe4,
+
        /**
         * @WOWLAN_GET_STATUSES: response in &struct iwl_wowlan_status
         */
        WOWLAN_GET_STATUSES = 0xe5,
 
-       /* and for NetDetect */
+       /**
+        * @SCAN_OFFLOAD_PROFILES_QUERY_CMD:
+        * No command data, response is &struct iwl_scan_offload_profiles_query
+        */
        SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56,
 };
 
@@ -490,15 +682,38 @@ enum iwl_mac_conf_subcmd_ids {
  * enum iwl_phy_ops_subcmd_ids - PHY group commands
  */
 enum iwl_phy_ops_subcmd_ids {
+       /**
+        * @CMD_DTS_MEASUREMENT_TRIGGER_WIDE:
+        * Uses either &struct iwl_dts_measurement_cmd or
+        * &struct iwl_ext_dts_measurement_cmd
+        */
        CMD_DTS_MEASUREMENT_TRIGGER_WIDE = 0x0,
+
+       /**
+        * @CTDP_CONFIG_CMD: &struct iwl_mvm_ctdp_cmd
+        */
        CTDP_CONFIG_CMD = 0x03,
 
        /**
         * @TEMP_REPORTING_THRESHOLDS_CMD: &struct temp_report_ths_cmd
         */
        TEMP_REPORTING_THRESHOLDS_CMD = 0x04,
+
+       /**
+        * @GEO_TX_POWER_LIMIT: &struct iwl_geo_tx_power_profiles_cmd
+        */
        GEO_TX_POWER_LIMIT = 0x05,
+
+       /**
+        * @CT_KILL_NOTIFICATION: &struct ct_kill_notif
+        */
        CT_KILL_NOTIFICATION = 0xFE,
+
+       /**
+        * @DTS_MEASUREMENT_NOTIF_WIDE:
+        * &struct iwl_dts_measurement_notif_v1 or
+        * &struct iwl_dts_measurement_notif_v2
+        */
        DTS_MEASUREMENT_NOTIF_WIDE = 0xFF,
 };
 
@@ -512,6 +727,10 @@ enum iwl_system_subcmd_ids {
         * &struct iwl_shared_mem_cfg_v1
         */
        SHARED_MEM_CFG_CMD = 0x0,
+
+       /**
+        * @INIT_EXTENDED_CFG_CMD: &struct iwl_init_extended_cfg_cmd
+        */
        INIT_EXTENDED_CFG_CMD = 0x03,
 };
 
@@ -523,19 +742,57 @@ enum iwl_data_path_subcmd_ids {
         * @DQA_ENABLE_CMD: &struct iwl_dqa_enable_cmd
         */
        DQA_ENABLE_CMD = 0x0,
+
+       /**
+        * @UPDATE_MU_GROUPS_CMD: &struct iwl_mu_group_mgmt_cmd
+        */
        UPDATE_MU_GROUPS_CMD = 0x1,
+
+       /**
+        * @TRIGGER_RX_QUEUES_NOTIF_CMD: &struct iwl_rxq_sync_cmd
+        */
        TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
+
+       /**
+        * @STA_PM_NOTIF: &struct iwl_mvm_pm_state_notification
+        */
        STA_PM_NOTIF = 0xFD,
+
+       /**
+        * @MU_GROUP_MGMT_NOTIF: &struct iwl_mu_group_mgmt_notif
+        */
        MU_GROUP_MGMT_NOTIF = 0xFE,
+
+       /**
+        * @RX_QUEUES_NOTIFICATION: &struct iwl_rxq_sync_notification
+        */
        RX_QUEUES_NOTIFICATION = 0xFF,
 };
 
+/**
+ * enum iwl_prot_offload_subcmd_ids - protocol offload commands
+ */
 enum iwl_prot_offload_subcmd_ids {
+       /**
+        * @STORED_BEACON_NTF: &struct iwl_stored_beacon_notif
+        */
        STORED_BEACON_NTF = 0xFF,
 };
 
+/**
+ * enum iwl_regulatory_and_nvm_subcmd_ids - regulatory/NVM commands
+ */
 enum iwl_regulatory_and_nvm_subcmd_ids {
+       /**
+        * @NVM_ACCESS_COMPLETE: &struct iwl_nvm_access_complete_cmd
+        */
        NVM_ACCESS_COMPLETE = 0x0,
+
+       /**
+        * @NVM_GET_INFO:
+        * Command is &struct iwl_nvm_get_info,
+        * response is &struct iwl_nvm_get_info_rsp
+        */
        NVM_GET_INFO = 0x2,
 };
 
@@ -2605,6 +2862,7 @@ struct iwl_nvm_get_info_phy {
  * struct iwl_nvm_get_info_regulatory - regulatory information
  * @lar_enabled: is LAR enabled
  * @channel_profile: regulatory data of this channel
+ * @reserved: reserved
  */
 struct iwl_nvm_get_info_regulatory {
        __le32 lar_enabled;