Commit 0c59e612 authored by Randy Dunlap's avatar Randy Dunlap Committed by Hans de Goede
Browse files

platform/mellanox: mlxbf-pmc: fix kernel-doc notation 



Fix kernel-doc warnings reported by the kernel test robot:

drivers/platform/mellanox/mlxbf-pmc.c:82: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Structure to hold attribute and block info for each sysfs entry
drivers/platform/mellanox/mlxbf-pmc.c:94: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Structure to hold info for each HW block
drivers/platform/mellanox/mlxbf-pmc.c:121: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Structure to hold PMC context info
drivers/platform/mellanox/mlxbf-pmc.c:148: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Structure to hold supported events for each block

Also fix typos in a few struct member names.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Mark Gross <mgross@linux.intel.com>
Cc: Vadim Pasternak <vadimp@nvidia.com>
Cc: platform-driver-x86@vger.kernel.org
Link: https://lore.kernel.org/r/20210822171742.26921-1-rdunlap@infradead.org


Signed-off-by: default avatarHans de Goede <hdegoede@redhat.com>
parent 66a91c00

drivers/platform/mellanox/mlxbf-pmc.c

+7 −6
Original line number Diff line number Diff line
@@ -79,7 +79,8 @@ 
#define MLXBF_PMC_L3C_PERF_CNT_HIGH_VAL GENMASK(24, 0)



/**

 * Structure to hold attribute and block info for each sysfs entry

 * struct mlxbf_pmc_attribute - Structure to hold attribute and block info

 * for each sysfs entry

 * @dev_attr: Device attribute struct

 * @index: index to identify counter number within a block

 * @nr: block number to which the sysfs belongs
@@ -91,7 +92,7 @@ struct mlxbf_pmc_attribute { 
};



/**

 * Structure to hold info for each HW block

 * struct mlxbf_pmc_block_info - Structure to hold info for each HW block

 *

 * @mmio_base: The VA at which the PMC block is mapped

 * @blk_size: Size of each mapped region
@@ -102,7 +103,7 @@ struct mlxbf_pmc_attribute { 
 * @attr_event_list: Attributes for "event_list" sysfs files

 * @attr_enable: Attributes for "enable" sysfs files

 * @block_attr: All attributes needed for the block

 * @blcok_attr_grp: Attribute group for the block

 * @block_attr_grp: Attribute group for the block

 */

struct mlxbf_pmc_block_info {

	void __iomem *mmio_base;
@@ -118,7 +119,7 @@ struct mlxbf_pmc_block_info { 
};



/**

 * Structure to hold PMC context info

 * struct mlxbf_pmc_context - Structure to hold PMC context info

 *

 * @pdev: The kernel structure representing the device

 * @total_blocks: Total number of blocks
@@ -127,7 +128,7 @@ struct mlxbf_pmc_block_info { 
 * @block_name: Block name

 * @block:  Block info

 * @groups:  Attribute groups from each block

 * @sv_sreg_support: Whether SMCs are used to access performance registers

 * @svc_sreg_support: Whether SMCs are used to access performance registers

 * @sreg_tbl_perf: Secure register access table number

 * @event_set: Event set to use

 */
@@ -145,7 +146,7 @@ struct mlxbf_pmc_context { 
};



/**

 * Structure to hold supported events for each block

 * struct mlxbf_pmc_events - Structure to hold supported events for each block

 * @evt_num: Event number used to program counters

 * @evt_name: Name of the event

 */