Commit 8c4c0485 authored by Johannes Berg's avatar Johannes Berg
Browse files

wifi: iwlwifi: context-info: add kernel-doc markers 



These comments have kernel-doc markup and were meant to
be handled as such, add the right /** marker to them.

Add missing entries where needed.

Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarMiri Korenblit <miriam.rachel.korenblit@intel.com>
Link: https://patch.msgid.link/20241227095718.c5c04b641479.I702b8122d307a0d9d09df038cda10be063f7f2d7@changeid


Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent 7d89d780

drivers/net/wireless/intel/iwlwifi/iwl-context-info-gen3.h

+14 −11
Original line number Diff line number Diff line
@@ -86,7 +86,7 @@ enum iwl_prph_scratch_ext_flags { 
	IWL_PRPH_SCRATCH_EXT_URM_PERM	= BIT(5),

};



/*

/**

 * struct iwl_prph_scratch_version - version structure

 * @mac_id: SKU and revision id

 * @version: prph scratch information version id
@@ -100,7 +100,7 @@ struct iwl_prph_scratch_version { 
	__le16 reserved;

} __packed; /* PERIPH_SCRATCH_VERSION_S */



/*

/**

 * struct iwl_prph_scratch_control - control structure

 * @control_flags: context information flags see &enum iwl_prph_scratch_flags

 * @control_flags_ext: context information for extended flags,
@@ -111,7 +111,7 @@ struct iwl_prph_scratch_control { 
	__le32 control_flags_ext;

} __packed; /* PERIPH_SCRATCH_CONTROL_S */



/*

/**

 * struct iwl_prph_scratch_pnvm_cfg - PNVM scratch

 * @pnvm_base_addr: PNVM start address

 * @pnvm_size: the size of the PNVM image in bytes
@@ -131,7 +131,8 @@ struct iwl_prph_scratch_pnvm_cfg { 
struct iwl_prph_scrath_mem_desc_addr_array {

	__le64 mem_descs[IPC_DRAM_MAP_ENTRY_NUM_MAX];

} __packed; /* PERIPH_SCRATCH_MEM_DESC_ADDR_ARRAY_S_VER_1 */

/*



/**

 * struct iwl_prph_scratch_hwm_cfg - hwm config

 * @hwm_base_addr: hwm start address

 * @hwm_size: hwm size in DWs
@@ -143,7 +144,7 @@ struct iwl_prph_scratch_hwm_cfg { 
	__le32 debug_token_config;

} __packed; /* PERIPH_SCRATCH_HWM_CFG_S */



/*

/**

 * struct iwl_prph_scratch_rbd_cfg - RBDs configuration

 * @free_rbd_addr: default queue free RB CB base address

 * @reserved: reserved
@@ -153,10 +154,11 @@ struct iwl_prph_scratch_rbd_cfg { 
	__le32 reserved;

} __packed; /* PERIPH_SCRATCH_RBD_CFG_S */



/*

/**

 * struct iwl_prph_scratch_uefi_cfg - prph scratch reduce power table

 * @base_addr: reduce power table address

 * @size: the size of the entire power table image

 * @reserved: (reserved)

 */

struct iwl_prph_scratch_uefi_cfg {

	__le64 base_addr;
@@ -164,7 +166,7 @@ struct iwl_prph_scratch_uefi_cfg { 
	__le32 reserved;

} __packed; /* PERIPH_SCRATCH_UEFI_CFG_S */



/*

/**

 * struct iwl_prph_scratch_step_cfg - prph scratch step configuration

 * @mbx_addr_0: [0:7] revision,

 *		[8:15] cnvi_to_cnvr length,
@@ -178,13 +180,14 @@ struct iwl_prph_scratch_step_cfg { 
	__le32 mbx_addr_1;

} __packed;



/*

/**

 * struct iwl_prph_scratch_ctrl_cfg - prph scratch ctrl and config

 * @version: version information of context info and HW

 * @control: control flags of FH configurations

 * @pnvm_cfg: ror configuration

 * @hwm_cfg: hwm configuration

 * @rbd_cfg: default RX queue configuration

 * @reduce_power_cfg: UEFI power reduction table

 * @step_cfg: step configuration

 */

struct iwl_prph_scratch_ctrl_cfg {
@@ -197,7 +200,7 @@ struct iwl_prph_scratch_ctrl_cfg { 
	struct iwl_prph_scratch_step_cfg step_cfg;

} __packed; /* PERIPH_SCRATCH_CTRL_CFG_S */



/*

/**

 * struct iwl_prph_scratch - peripheral scratch mapping

 * @ctrl_cfg: control and configuration of prph scratch

 * @dram: firmware images addresses in DRAM
@@ -213,7 +216,7 @@ struct iwl_prph_scratch { 
	struct iwl_context_info_dram dram;

} __packed; /* PERIPH_SCRATCH_S */



/*

/**

 * struct iwl_prph_info - peripheral information

 * @boot_stage_mirror: reflects the value in the Boot Stage CSR register

 * @ipc_status_mirror: reflects the value in the IPC Status CSR register
@@ -227,7 +230,7 @@ struct iwl_prph_info { 
	__le32 reserved;

} __packed; /* PERIPH_INFO_S */



/*

/**

 * struct iwl_context_info_gen3 - device INIT configuration

 * @version: version of the context information

 * @size: size of context information in DWs

drivers/net/wireless/intel/iwlwifi/iwl-context-info.h

+20 −10
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */

/*

 * Copyright (C) 2017 Intel Deutschland GmbH

 * Copyright (C) 2018-2020, 2022 Intel Corporation

 * Copyright (C) 2018-2020, 2022, 2024 Intel Corporation

 */

#ifndef __iwl_context_info_file_h__

#define __iwl_context_info_file_h__
@@ -53,11 +53,12 @@ enum iwl_context_info_flags { 
	IWL_CTXT_INFO_RB_SIZE_32K	= 0xe,

};



/*

/**

 * struct iwl_context_info_version - version structure

 * @mac_id: SKU and revision id

 * @version: context information version id

 * @size: the size of the context information in DWs

 * @reserved: (reserved)

 */

struct iwl_context_info_version {

	__le16 mac_id;
@@ -66,16 +67,17 @@ struct iwl_context_info_version { 
	__le16 reserved;

} __packed;



/*

/**

 * struct iwl_context_info_control - version structure

 * @control_flags: context information flags see &enum iwl_context_info_flags

 * @reserved: (reserved)

 */

struct iwl_context_info_control {

	__le32 control_flags;

	__le32 reserved;

} __packed;



/*

/**

 * struct iwl_context_info_dram - images DRAM map

 * each entry in the map represents a DRAM chunk of up to 32 KB

 * @umac_img: UMAC image DRAM map
@@ -88,7 +90,7 @@ struct iwl_context_info_dram { 
	__le64 virtual_img[IWL_MAX_DRAM_ENTRY];

} __packed;



/*

/**

 * struct iwl_context_info_rbd_cfg - RBDs configuration

 * @free_rbd_addr: default queue free RB CB base address

 * @used_rbd_addr: default queue used RB CB base address
@@ -100,10 +102,11 @@ struct iwl_context_info_rbd_cfg { 
	__le64 status_wr_ptr;

} __packed;



/*

/**

 * struct iwl_context_info_hcmd_cfg  - command queue configuration

 * @cmd_queue_addr: address of command queue

 * @cmd_queue_size: number of entries

 * @reserved: (reserved)

 */

struct iwl_context_info_hcmd_cfg {

	__le64 cmd_queue_addr;
@@ -111,10 +114,11 @@ struct iwl_context_info_hcmd_cfg { 
	u8 reserved[7];

} __packed;



/*

/**

 * struct iwl_context_info_dump_cfg - Core Dump configuration

 * @core_dump_addr: core dump (debug DRAM address) start address

 * @core_dump_size: size, in DWs

 * @reserved: (reserved)

 */

struct iwl_context_info_dump_cfg {

	__le64 core_dump_addr;
@@ -122,10 +126,11 @@ struct iwl_context_info_dump_cfg { 
	__le32 reserved;

} __packed;



/*

/**

 * struct iwl_context_info_pnvm_cfg - platform NVM data configuration

 * @platform_nvm_addr: Platform NVM data start address

 * @platform_nvm_size: size in DWs

 * @reserved: (reserved)

 */

struct iwl_context_info_pnvm_cfg {

	__le64 platform_nvm_addr;
@@ -133,11 +138,12 @@ struct iwl_context_info_pnvm_cfg { 
	__le32 reserved;

} __packed;



/*

/**

 * struct iwl_context_info_early_dbg_cfg - early debug configuration for

 *	dumping DRAM addresses

 * @early_debug_addr: early debug start address

 * @early_debug_size: size in DWs

 * @reserved: (reserved)

 */

struct iwl_context_info_early_dbg_cfg {

	__le64 early_debug_addr;
@@ -145,16 +151,20 @@ struct iwl_context_info_early_dbg_cfg { 
	__le32 reserved;

} __packed;



/*

/**

 * struct iwl_context_info - device INIT configuration

 * @version: version information of context info and HW

 * @control: control flags of FH configurations

 * @reserved0: (reserved)

 * @rbd_cfg: default RX queue configuration

 * @hcmd_cfg: command queue configuration

 * @reserved1: (reserved)

 * @dump_cfg: core dump data

 * @edbg_cfg: early debug configuration

 * @pnvm_cfg: platform nvm configuration

 * @reserved2: (reserved)

 * @dram: firmware image addresses in DRAM

 * @reserved3: (reserved)

 */

struct iwl_context_info {

	struct iwl_context_info_version version;