Commit ccb2f72c authored by Johannes Berg's avatar Johannes Berg

wifi: iwlwifi: iwl-fh.h: fix kernel-doc issues

Clean up kernel-doc in iwl-fh.h. In one case, rename the
(otherwise unused) struct member to have the correct name.
Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarMiri Korenblit <miriam.rachel.korenblit@intel.com>
Link: https://msgid.link/20240218194912.4a342ac06f0b.I604ea964a094b43df0ab29b06231c2f42d6bd79b@changeidSigned-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent f63280ab
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
/* /*
* Copyright (C) 2005-2014, 2018-2021, 2023 Intel Corporation * Copyright (C) 2005-2014, 2018-2021, 2023-2024 Intel Corporation
* Copyright (C) 2015-2017 Intel Deutschland GmbH * Copyright (C) 2015-2017 Intel Deutschland GmbH
*/ */
#ifndef __iwl_fh_h__ #ifndef __iwl_fh_h__
...@@ -570,18 +570,19 @@ static inline unsigned int FH_MEM_CBBC_QUEUE(struct iwl_trans *trans, ...@@ -570,18 +570,19 @@ static inline unsigned int FH_MEM_CBBC_QUEUE(struct iwl_trans *trans,
/** /**
* struct iwl_rb_status - reserve buffer status * struct iwl_rb_status - reserve buffer status
* host memory mapped FH registers * host memory mapped FH registers
* @closed_rb_num [0:11] - Indicates the index of the RB which was closed * @closed_rb_num: [0:11] Indicates the index of the RB which was closed
* @closed_fr_num [0:11] - Indicates the index of the RX Frame which was closed * @closed_fr_num: [0:11] Indicates the index of the RX Frame which was closed
* @finished_rb_num [0:11] - Indicates the index of the current RB * @finished_rb_num: [0:11] Indicates the index of the current RB
* in which the last frame was written to * in which the last frame was written to
* @finished_fr_num [0:11] - Indicates the index of the RX Frame * @finished_fr_num: [0:11] Indicates the index of the RX Frame
* which was transferred * which was transferred
* @__spare: reserved
*/ */
struct iwl_rb_status { struct iwl_rb_status {
__le16 closed_rb_num; __le16 closed_rb_num;
__le16 closed_fr_num; __le16 closed_fr_num;
__le16 finished_rb_num; __le16 finished_rb_num;
__le16 finished_fr_nam; __le16 finished_fr_num;
__le32 __spare; __le32 __spare;
} __packed; } __packed;
...@@ -651,15 +652,15 @@ struct iwl_tfd_tb { ...@@ -651,15 +652,15 @@ struct iwl_tfd_tb {
* *
* This structure contains dma address and length of transmission address * This structure contains dma address and length of transmission address
* *
* @tb_len length of the tx buffer * @tb_len: length of the tx buffer
* @addr 64 bits dma address * @addr: 64 bits dma address
*/ */
struct iwl_tfh_tb { struct iwl_tfh_tb {
__le16 tb_len; __le16 tb_len;
__le64 addr; __le64 addr;
} __packed; } __packed;
/** /*
* Each Tx queue uses a circular buffer of 256 TFDs stored in host DRAM. * Each Tx queue uses a circular buffer of 256 TFDs stored in host DRAM.
* Both driver and device share these circular buffers, each of which must be * Both driver and device share these circular buffers, each of which must be
* contiguous 256 TFDs. * contiguous 256 TFDs.
...@@ -698,10 +699,11 @@ struct iwl_tfd { ...@@ -698,10 +699,11 @@ struct iwl_tfd {
/** /**
* struct iwl_tfh_tfd - Transmit Frame Descriptor (TFD) * struct iwl_tfh_tfd - Transmit Frame Descriptor (TFD)
* @ num_tbs 0-4 number of active tbs * @num_tbs:
* 5 -15 reserved * 0-4 number of active tbs
* @ tbs[25] transmit frame buffer descriptors * 5-15 reserved
* @ __pad padding * @tbs: transmit frame buffer descriptors
* @__pad: padding
*/ */
struct iwl_tfh_tfd { struct iwl_tfh_tfd {
__le16 num_tbs; __le16 num_tbs;
...@@ -718,10 +720,12 @@ struct iwl_tfh_tfd { ...@@ -718,10 +720,12 @@ struct iwl_tfh_tfd {
* struct iwlagn_schedq_bc_tbl scheduler byte count table * struct iwlagn_schedq_bc_tbl scheduler byte count table
* base physical address provided by SCD_DRAM_BASE_ADDR * base physical address provided by SCD_DRAM_BASE_ADDR
* For devices up to 22000: * For devices up to 22000:
* @tfd_offset 0-12 - tx command byte count * @tfd_offset:
* For devices up to 22000:
* 0-12 - tx command byte count
* 12-16 - station index * 12-16 - station index
* For 22000: * For 22000:
* @tfd_offset 0-12 - tx command byte count * 0-12 - tx command byte count
* 12-13 - number of 64 byte chunks * 12-13 - number of 64 byte chunks
* 14-16 - reserved * 14-16 - reserved
*/ */
......
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