]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
wifi: iwlwifi: pcie: fix kernel-doc warnings
authorJohannes Berg <johannes.berg@intel.com>
Wed, 11 Jun 2025 19:26:30 +0000 (22:26 +0300)
committerMiri Korenblit <miriam.rachel.korenblit@intel.com>
Wed, 25 Jun 2025 07:57:32 +0000 (10:57 +0300)
Also fix the name of the iwl_prph_scratch_mem_desc_addr_array
struct and some related spelling.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Miri Korenblit <miriam.rachel.korenblit@intel.com>
Link: https://patch.msgid.link/20250611222325.ca2dec14f107.Ia4cfeea63e946f3b54e3e6b7bd6ab81130b0a7e6@changeid
drivers/net/wireless/intel/iwlwifi/pcie/ctxt-info-v2.c
drivers/net/wireless/intel/iwlwifi/pcie/gen1_2/internal.h
drivers/net/wireless/intel/iwlwifi/pcie/iwl-context-info-v2.h

index 0df379fda463a9770f9c81da88e2e63037739344..06be929a3ca5a4bb8c5cfe91eb17be8fadcf0fc8 100644 (file)
@@ -391,13 +391,13 @@ static int iwl_pcie_load_payloads_segments
 {
        struct iwl_dram_data *cur_payload_dram = &dram_regions->drams[0];
        struct iwl_dram_data *desc_dram = &dram_regions->prph_scratch_mem_desc;
-       struct iwl_prph_scrath_mem_desc_addr_array *addresses;
+       struct iwl_prph_scratch_mem_desc_addr_array *addresses;
        const void *data;
        u32 len;
        int i;
 
        /* allocate and init DRAM descriptors array */
-       len = sizeof(struct iwl_prph_scrath_mem_desc_addr_array);
+       len = sizeof(struct iwl_prph_scratch_mem_desc_addr_array);
        desc_dram->block = iwl_pcie_ctxt_info_dma_alloc_coherent
                                                (trans,
                                                 len,
index ebcc174f6c623d4491c6e4bde88e02f1c40eed6d..b1dcaae0dc108225721908fdc186100756259cec 100644 (file)
@@ -39,7 +39,7 @@ struct iwl_host_cmd;
  * trans_pcie layer */
 
 /**
- * struct iwl_rx_mem_buffer
+ * struct iwl_rx_mem_buffer - driver-side RX buffer descriptor
  * @page_dma: bus address of rxb page
  * @page: driver's pointer to the rxb page
  * @list: list entry for the membuffer
@@ -190,6 +190,7 @@ struct iwl_rb_allocator {
  * iwl_get_closed_rb_stts - get closed rb stts from different structs
  * @trans: transport pointer (for configuration)
  * @rxq: the rxq to get the rb stts from
+ * Return: last closed RB index
  */
 static inline u16 iwl_get_closed_rb_stts(struct iwl_trans *trans,
                                         struct iwl_rxq *rxq)
@@ -703,6 +704,7 @@ static inline void iwl_txq_stop(struct iwl_trans *trans, struct iwl_txq *txq)
  * iwl_txq_inc_wrap - increment queue index, wrap back to beginning
  * @trans: the transport (for configuration data)
  * @index: current index
+ * Return: the queue index incremented, subject to wrapping
  */
 static inline int iwl_txq_inc_wrap(struct iwl_trans *trans, int index)
 {
@@ -714,6 +716,7 @@ static inline int iwl_txq_inc_wrap(struct iwl_trans *trans, int index)
  * iwl_txq_dec_wrap - decrement queue index, wrap back to end
  * @trans: the transport (for configuration data)
  * @index: current index
+ * Return: the queue index decremented, subject to wrapping
  */
 static inline int iwl_txq_dec_wrap(struct iwl_trans *trans, int index)
 {
index 8c5c0ea46181b0bb89af7f4b4526979170abe754..416baadc50176adaeedfd1221a658fabffdc8bf2 100644 (file)
@@ -130,11 +130,11 @@ struct iwl_prph_scratch_pnvm_cfg {
 } __packed; /* PERIPH_SCRATCH_PNVM_CFG_S */
 
 /**
- * struct iwl_prph_scrath_mem_desc_addr_array
+ * struct iwl_prph_scratch_mem_desc_addr_array - DRAM
  * @mem_descs: array of dram addresses.
- * Each address is the beggining of a pnvm payload.
+ * Each address is the beginning of a PNVM payload.
  */
-struct iwl_prph_scrath_mem_desc_addr_array {
+struct iwl_prph_scratch_mem_desc_addr_array {
        __le64 mem_descs[IPC_DRAM_MAP_ENTRY_NUM_MAX];
 } __packed; /* PERIPH_SCRATCH_MEM_DESC_ADDR_ARRAY_S_VER_1 */