Commit cb3abd20 authored by Johannes Berg's avatar Johannes Berg Committed by Luca Coelho

iwlwifi: api: clean up some documentation/bits

Clean up some documentation references and some bits in the enums
to make the documentation more useful.
Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarLuca Coelho <luciano.coelho@intel.com>
Link: https://lore.kernel.org/r/iwlwifi.20210210142629.941d963ceb88.I72a89c0161d7beab99bc3a90707796c2a63e4197@changeidSigned-off-by: default avatarLuca Coelho <luciano.coelho@intel.com>
parent beb44c0c
...@@ -284,7 +284,7 @@ enum iwl_legacy_cmds { ...@@ -284,7 +284,7 @@ enum iwl_legacy_cmds {
/* Phy */ /* Phy */
/** /**
* @PHY_CONFIGURATION_CMD: &struct iwl_phy_cfg_cmd * @PHY_CONFIGURATION_CMD: &struct iwl_phy_cfg_cmd_v1 or &struct iwl_phy_cfg_cmd_v3
*/ */
PHY_CONFIGURATION_CMD = 0x6a, PHY_CONFIGURATION_CMD = 0x6a,
......
...@@ -12,7 +12,12 @@ ...@@ -12,7 +12,12 @@
enum iwl_location_subcmd_ids { enum iwl_location_subcmd_ids {
/** /**
* @TOF_RANGE_REQ_CMD: TOF ranging request, * @TOF_RANGE_REQ_CMD: TOF ranging request,
* uses &struct iwl_tof_range_req_cmd * uses one of &struct iwl_tof_range_req_cmd_v5,
* &struct iwl_tof_range_req_cmd_v7,
* &struct iwl_tof_range_req_cmd_v8,
* &struct iwl_tof_range_req_cmd_v9,
* &struct iwl_tof_range_req_cmd_v11,
* &struct iwl_tof_range_req_cmd_v7
*/ */
TOF_RANGE_REQ_CMD = 0x0, TOF_RANGE_REQ_CMD = 0x0,
/** /**
......
...@@ -20,6 +20,7 @@ ...@@ -20,6 +20,7 @@
* @TX_CMD_FLG_VHT_NDPA: mark frame is NDPA for VHT beamformer sequence * @TX_CMD_FLG_VHT_NDPA: mark frame is NDPA for VHT beamformer sequence
* @TX_CMD_FLG_HT_NDPA: mark frame is NDPA for HT beamformer sequence * @TX_CMD_FLG_HT_NDPA: mark frame is NDPA for HT beamformer sequence
* @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC) * @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC)
* @TX_CMD_FLG_BT_PRIO_MASK: BT priority value
* @TX_CMD_FLG_BT_PRIO_POS: the position of the BT priority (bit 11 is ignored * @TX_CMD_FLG_BT_PRIO_POS: the position of the BT priority (bit 11 is ignored
* on old firmwares). * on old firmwares).
* @TX_CMD_FLG_BT_DIS: disable BT priority for this frame * @TX_CMD_FLG_BT_DIS: disable BT priority for this frame
...@@ -51,6 +52,7 @@ enum iwl_tx_flags { ...@@ -51,6 +52,7 @@ enum iwl_tx_flags {
TX_CMD_FLG_HT_NDPA = BIT(9), TX_CMD_FLG_HT_NDPA = BIT(9),
TX_CMD_FLG_CSI_FDBK2HOST = BIT(10), TX_CMD_FLG_CSI_FDBK2HOST = BIT(10),
TX_CMD_FLG_BT_PRIO_POS = 11, TX_CMD_FLG_BT_PRIO_POS = 11,
TX_CMD_FLG_BT_PRIO_MASK = BIT(11) | BIT(12),
TX_CMD_FLG_BT_DIS = BIT(12), TX_CMD_FLG_BT_DIS = BIT(12),
TX_CMD_FLG_SEQ_CTL = BIT(13), TX_CMD_FLG_SEQ_CTL = BIT(13),
TX_CMD_FLG_MORE_FRAG = BIT(14), TX_CMD_FLG_MORE_FRAG = BIT(14),
...@@ -177,7 +179,7 @@ enum iwl_tx_offload_assist_flags_pos { ...@@ -177,7 +179,7 @@ enum iwl_tx_offload_assist_flags_pos {
* ( TX_CMD = 0x1c ) * ( TX_CMD = 0x1c )
* @len: in bytes of the payload, see below for details * @len: in bytes of the payload, see below for details
* @offload_assist: TX offload configuration * @offload_assist: TX offload configuration
* @tx_flags: combination of TX_CMD_FLG_* * @tx_flags: combination of TX_CMD_FLG_*, see &enum iwl_tx_flags
* @scratch: scratch buffer used by the device * @scratch: scratch buffer used by the device
* @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
* cleared. Combination of RATE_MCS_* * cleared. Combination of RATE_MCS_*
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment