Commit 4851cdd8 authored Nov 20, 2023 by Andy Shevchenko Committed by Greg Kroah-Hartman Dec 20, 2023

platform/x86: intel_telemetry: Fix kernel doc descriptions



[ Upstream commit a6584711e64d9d12ab79a450ec3628fd35e4f476 ]

LKP found issues with a kernel doc in the driver:

core.c:116: warning: Function parameter or member 'ioss_evtconfig' not described in 'telemetry_update_events'
core.c:188: warning: Function parameter or member 'ioss_evtconfig' not described in 'telemetry_get_eventconfig'

It looks like it were copy'n'paste typos when these descriptions
had been introduced. Fix the typos.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202310070743.WALmRGSY-lkp@intel.com/


Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20231120150756.1661425-1-andriy.shevchenko@linux.intel.com


Reviewed-by: Rajneesh Bhardwaj <irenic.rajneesh@gmail.com>
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Sasha Levin <sashal@kernel.org>

parent 049d7fb7

drivers/platform/x86/intel_telemetry_core.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -111,7 +111,7 @@ static const struct telemetry_core_ops telm_defpltops = {
		/**
		* telemetry_update_events() - Update telemetry Configuration
		* @pss_evtconfig: PSS related config. No change if num_evts = 0.
		* @pss_evtconfig: IOSS related config. No change if num_evts = 0.
		* @ioss_evtconfig: IOSS related config. No change if num_evts = 0.
		*
		* This API updates the IOSS & PSS Telemetry configuration. Old config
		* is overwritten. Call telemetry_reset_events when logging is over
		@@ -185,7 +185,7 @@ EXPORT_SYMBOL_GPL(telemetry_reset_events);
		/**
		* telemetry_get_eventconfig() - Returns the pss and ioss events enabled
		* @pss_evtconfig: Pointer to PSS related configuration.
		* @pss_evtconfig: Pointer to IOSS related configuration.
		* @ioss_evtconfig: Pointer to IOSS related configuration.
		* @pss_len: Number of u32 elements allocated for pss_evtconfig array
		* @ioss_len: Number of u32 elements allocated for ioss_evtconfig array
		*