Commit 9795f4eb authored by Lee Jones's avatar Lee Jones Committed by Alex Deucher

drm/amd/pm/powerplay/hwmgr/process_pptables_v1_0: Convert to proper kernel-doc format

Fixes the following W=1 kernel build warning(s):

 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:41: warning: Function parameter or member 'hwmgr' not described in 'set_hw_cap'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:41: warning: Function parameter or member 'setIt' not described in 'set_hw_cap'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:41: warning: Function parameter or member 'cap' not described in 'set_hw_cap'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:56: warning: Function parameter or member 'hwmgr' not described in 'set_platform_caps'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:56: warning: Function parameter or member 'powerplay_caps' not described in 'set_platform_caps'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:135: warning: Function parameter or member 'hwmgr' not described in 'get_powerplay_table'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:202: warning: Function parameter or member 'hwmgr' not described in 'get_platform_power_management_table'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:202: warning: Function parameter or member 'atom_ppm_table' not described in 'get_platform_power_management_table'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:246: warning: Function parameter or member 'hwmgr' not described in 'init_dpm_2_parameters'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:246: warning: Function parameter or member 'powerplay_table' not described in 'init_dpm_2_parameters'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:791: warning: Function parameter or member 'hwmgr' not described in 'init_clock_voltage_dependency'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:791: warning: Function parameter or member 'powerplay_table' not described in 'init_clock_voltage_dependency'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:911: warning: Function parameter or member 'hwmgr' not described in 'init_thermal_controller'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:911: warning: Function parameter or member 'powerplay_table' not described in 'init_thermal_controller'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1121: warning: Function parameter or member 'hwmgr' not described in 'check_powerplay_tables'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1121: warning: Function parameter or member 'powerplay_table' not described in 'check_powerplay_tables'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1263: warning: Function parameter or member 'hwmgr' not described in 'make_classification_flags'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1263: warning: Function parameter or member 'classification' not described in 'make_classification_flags'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1263: warning: Function parameter or member 'classification2' not described in 'make_classification_flags'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1370: warning: Function parameter or member 'hwmgr' not described in 'get_powerplay_table_entry_v1_0'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1370: warning: Function parameter or member 'entry_index' not described in 'get_powerplay_table_entry_v1_0'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1370: warning: Function parameter or member 'power_state' not described in 'get_powerplay_table_entry_v1_0'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/process_pptables_v1_0.c:1370: warning: Function parameter or member 'call_back_func' not described in 'get_powerplay_table_entry_v1_0'

Cc: Evan Quan <evan.quan@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: amd-gfx@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent b4643c50
...@@ -32,10 +32,10 @@ ...@@ -32,10 +32,10 @@
#include "pptable_v1_0.h" #include "pptable_v1_0.h"
/** /**
* Private Function used during initialization. * set_hw_cap - Private Function used during initialization.
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param setIt A flag indication if the capability should be set (TRUE) or reset (FALSE). * @setIt: A flag indication if the capability should be set (TRUE) or reset (FALSE).
* @param cap Which capability to set/reset. * @cap: Which capability to set/reset.
*/ */
static void set_hw_cap(struct pp_hwmgr *hwmgr, bool setIt, enum phm_platform_caps cap) static void set_hw_cap(struct pp_hwmgr *hwmgr, bool setIt, enum phm_platform_caps cap)
{ {
...@@ -47,10 +47,10 @@ static void set_hw_cap(struct pp_hwmgr *hwmgr, bool setIt, enum phm_platform_cap ...@@ -47,10 +47,10 @@ static void set_hw_cap(struct pp_hwmgr *hwmgr, bool setIt, enum phm_platform_cap
/** /**
* Private Function used during initialization. * set_platform_caps - Private Function used during initialization.
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param powerplay_caps the bit array (from BIOS) of capability bits. * @powerplay_caps: the bit array (from BIOS) of capability bits.
* @exception the current implementation always returns 1. * Exception: the current implementation always returns 1.
*/ */
static int set_platform_caps(struct pp_hwmgr *hwmgr, uint32_t powerplay_caps) static int set_platform_caps(struct pp_hwmgr *hwmgr, uint32_t powerplay_caps)
{ {
...@@ -128,7 +128,7 @@ static int set_platform_caps(struct pp_hwmgr *hwmgr, uint32_t powerplay_caps) ...@@ -128,7 +128,7 @@ static int set_platform_caps(struct pp_hwmgr *hwmgr, uint32_t powerplay_caps)
return 0; return 0;
} }
/** /*
* Private Function to get the PowerPlay Table Address. * Private Function to get the PowerPlay Table Address.
*/ */
static const void *get_powerplay_table(struct pp_hwmgr *hwmgr) static const void *get_powerplay_table(struct pp_hwmgr *hwmgr)
...@@ -191,10 +191,10 @@ static int get_vddc_lookup_table( ...@@ -191,10 +191,10 @@ static int get_vddc_lookup_table(
} }
/** /**
* Private Function used during initialization. * get_platform_power_management_table - Private Function used during initialization.
* Initialize Platform Power Management Parameter table * Initialize Platform Power Management Parameter table
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param atom_ppm_table Pointer to PPM table in VBIOS * @atom_ppm_table: Pointer to PPM table in VBIOS
*/ */
static int get_platform_power_management_table( static int get_platform_power_management_table(
struct pp_hwmgr *hwmgr, struct pp_hwmgr *hwmgr,
...@@ -234,10 +234,10 @@ static int get_platform_power_management_table( ...@@ -234,10 +234,10 @@ static int get_platform_power_management_table(
} }
/** /**
* Private Function used during initialization. * init_dpm_2_parameters - Private Function used during initialization.
* Initialize TDP limits for DPM2 * Initialize TDP limits for DPM2
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param powerplay_table Pointer to the PowerPlay Table. * @powerplay_table: Pointer to the PowerPlay Table.
*/ */
static int init_dpm_2_parameters( static int init_dpm_2_parameters(
struct pp_hwmgr *hwmgr, struct pp_hwmgr *hwmgr,
...@@ -779,10 +779,10 @@ static int get_gpio_table(struct pp_hwmgr *hwmgr, ...@@ -779,10 +779,10 @@ static int get_gpio_table(struct pp_hwmgr *hwmgr,
return 0; return 0;
} }
/** /**
* Private Function used during initialization. * init_clock_voltage_dependency - Private Function used during initialization.
* Initialize clock voltage dependency * Initialize clock voltage dependency
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param powerplay_table Pointer to the PowerPlay Table. * @powerplay_table: Pointer to the PowerPlay Table.
*/ */
static int init_clock_voltage_dependency( static int init_clock_voltage_dependency(
struct pp_hwmgr *hwmgr, struct pp_hwmgr *hwmgr,
...@@ -871,15 +871,16 @@ static int init_clock_voltage_dependency( ...@@ -871,15 +871,16 @@ static int init_clock_voltage_dependency(
return result; return result;
} }
/** Retrieves the (signed) Overdrive limits from VBIOS. /**
* init_over_drive_limits - Retrieves the (signed) Overdrive limits from VBIOS.
* The max engine clock, memory clock and max temperature come from the firmware info table. * The max engine clock, memory clock and max temperature come from the firmware info table.
* *
* The information is placed into the platform descriptor. * The information is placed into the platform descriptor.
* *
* @param hwmgr source of the VBIOS table and owner of the platform descriptor to be updated. * @hwmgr: source of the VBIOS table and owner of the platform descriptor to be updated.
* @param powerplay_table the address of the PowerPlay table. * @powerplay_table: the address of the PowerPlay table.
* *
* @return 1 as long as the firmware info table was present and of a supported version. * Return: 1 as long as the firmware info table was present and of a supported version.
*/ */
static int init_over_drive_limits( static int init_over_drive_limits(
struct pp_hwmgr *hwmgr, struct pp_hwmgr *hwmgr,
...@@ -898,11 +899,11 @@ static int init_over_drive_limits( ...@@ -898,11 +899,11 @@ static int init_over_drive_limits(
} }
/** /**
* Private Function used during initialization. * init_thermal_controller - Private Function used during initialization.
* Inspect the PowerPlay table for obvious signs of corruption. * Inspect the PowerPlay table for obvious signs of corruption.
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param powerplay_table Pointer to the PowerPlay Table. * @powerplay_table: Pointer to the PowerPlay Table.
* @exception This implementation always returns 1. * Exception: This implementation always returns 1.
*/ */
static int init_thermal_controller( static int init_thermal_controller(
struct pp_hwmgr *hwmgr, struct pp_hwmgr *hwmgr,
...@@ -1108,11 +1109,11 @@ static int init_thermal_controller( ...@@ -1108,11 +1109,11 @@ static int init_thermal_controller(
} }
/** /**
* Private Function used during initialization. * check_powerplay_tables - Private Function used during initialization.
* Inspect the PowerPlay table for obvious signs of corruption. * Inspect the PowerPlay table for obvious signs of corruption.
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param powerplay_table Pointer to the PowerPlay Table. * @powerplay_table: Pointer to the PowerPlay Table.
* @exception 2 if the powerplay table is incorrect. * Exception: 2 if the powerplay table is incorrect.
*/ */
static int check_powerplay_tables( static int check_powerplay_tables(
struct pp_hwmgr *hwmgr, struct pp_hwmgr *hwmgr,
...@@ -1255,9 +1256,9 @@ int get_number_of_powerplay_table_entries_v1_0(struct pp_hwmgr *hwmgr) ...@@ -1255,9 +1256,9 @@ int get_number_of_powerplay_table_entries_v1_0(struct pp_hwmgr *hwmgr)
return (uint32_t)(state_arrays->ucNumEntries); return (uint32_t)(state_arrays->ucNumEntries);
} }
/** /*
* Private function to convert flags stored in the BIOS to software flags in PowerPlay. * Private function to convert flags stored in the BIOS to software flags in PowerPlay.
*/ */
static uint32_t make_classification_flags(struct pp_hwmgr *hwmgr, static uint32_t make_classification_flags(struct pp_hwmgr *hwmgr,
uint16_t classification, uint16_t classification2) uint16_t classification, uint16_t classification2)
{ {
...@@ -1356,13 +1357,13 @@ static int ppt_get_vce_state_table_entry_v1_0(struct pp_hwmgr *hwmgr, uint32_t i ...@@ -1356,13 +1357,13 @@ static int ppt_get_vce_state_table_entry_v1_0(struct pp_hwmgr *hwmgr, uint32_t i
} }
/** /**
* Create a Power State out of an entry in the PowerPlay table. * get_powerplay_table_entry_v1_0 - Create a Power State out of an entry in the PowerPlay table.
* This function is called by the hardware back-end. * This function is called by the hardware back-end.
* @param hwmgr Pointer to the hardware manager. * @hwmgr: Pointer to the hardware manager.
* @param entry_index The index of the entry to be extracted from the table. * @entry_index: The index of the entry to be extracted from the table.
* @param power_state The address of the PowerState instance being created. * @power_state: The address of the PowerState instance being created.
* @return -1 if the entry cannot be retrieved. * Return: -1 if the entry cannot be retrieved.
*/ */
int get_powerplay_table_entry_v1_0(struct pp_hwmgr *hwmgr, int get_powerplay_table_entry_v1_0(struct pp_hwmgr *hwmgr,
uint32_t entry_index, struct pp_power_state *power_state, uint32_t entry_index, struct pp_power_state *power_state,
int (*call_back_func)(struct pp_hwmgr *, void *, int (*call_back_func)(struct pp_hwmgr *, void *,
......
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