Commit b76f0c6c authored by Lee Jones's avatar Lee Jones Committed by Alex Deucher

drm/amd/display/dc/bios/bios_parser: Fix a whole bunch of legacy doc formatting

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

 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:2588:16: warning: no previous prototype for ‘update_slot_layout_info’ [-Wmissing-prototypes]
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:2692:16: warning: no previous prototype for ‘get_bracket_layout_record’ [-Wmissing-prototypes]
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: warning: Function parameter or member 'signal' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: warning: Function parameter or member 'index' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:925: warning: Function parameter or member 'ss_info' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:997: warning: Function parameter or member 'bp' not described in 'get_ss_info_from_tbl'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:997: warning: Function parameter or member 'id' not described in 'get_ss_info_from_tbl'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:997: warning: Function parameter or member 'ss_info' not described in 'get_ss_info_from_tbl'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1022: warning: Function parameter or member 'bp' not described in 'get_ss_info_from_internal_ss_info_tbl_V2_1'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1022: warning: Function parameter or member 'id' not described in 'get_ss_info_from_internal_ss_info_tbl_V2_1'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1022: warning: Function parameter or member 'info' not described in 'get_ss_info_from_internal_ss_info_tbl_V2_1'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1087: warning: Function parameter or member 'bp' not described in 'get_ss_info_from_ss_info_table'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1087: warning: Function parameter or member 'id' not described in 'get_ss_info_from_ss_info_table'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1087: warning: Function parameter or member 'ss_info' not described in 'get_ss_info_from_ss_info_table'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1469: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_encoder_cap_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1469: warning: Function parameter or member 'object_id' not described in 'bios_parser_get_encoder_cap_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1469: warning: Function parameter or member 'info' not described in 'bios_parser_get_encoder_cap_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1508: warning: Function parameter or member 'bp' not described in 'get_encoder_cap_record'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1508: warning: Function parameter or member 'object' not described in 'get_encoder_cap_record'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1566: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_ss_entry_number'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1566: warning: Function parameter or member 'signal' not described in 'bios_parser_get_ss_entry_number'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1619: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number_from_ss_info_tbl'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1619: warning: Function parameter or member 'id' not described in 'get_ss_entry_number_from_ss_info_tbl'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1686: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1686: warning: Function parameter or member 'id' not described in 'get_ss_entry_number'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1705: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_v2_1'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1705: warning: Function parameter or member 'id' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_v2_1'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1740: warning: Function parameter or member 'bp' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_V3_1'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1740: warning: Function parameter or member 'id' not described in 'get_ss_entry_number_from_internal_ss_info_tbl_V3_1'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1783: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_gpio_pin_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1783: warning: Function parameter or member 'gpio_id' not described in 'bios_parser_get_gpio_pin_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:1783: warning: Function parameter or member 'info' not described in 'bios_parser_get_gpio_pin_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:2211: warning: Function parameter or member 'dcb' not described in 'bios_parser_set_scratch_critical_state'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser.c:2211: warning: Function parameter or member 'state' not described in 'bios_parser_set_scratch_critical_state'

Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Leo Li <sunpeng.li@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: Lee Jones <lee.jones@linaro.org>
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 6862bc4a
...@@ -911,11 +911,11 @@ static enum bp_result get_ss_info_from_tbl( ...@@ -911,11 +911,11 @@ static enum bp_result get_ss_info_from_tbl(
* ver 2.1 can co-exist with SS_Info table. Expect ASIC_InternalSS_Info ver 3.1, * ver 2.1 can co-exist with SS_Info table. Expect ASIC_InternalSS_Info ver 3.1,
* there is only one entry for each signal /ss id. However, there is * there is only one entry for each signal /ss id. However, there is
* no planning of supporting multiple spread Sprectum entry for EverGreen * no planning of supporting multiple spread Sprectum entry for EverGreen
* @param [in] this * @dcb: pointer to the DC BIOS
* @param [in] signal, ASSignalType to be converted to info index * @signal: ASSignalType to be converted to info index
* @param [in] index, number of entries that match the converted info index * @index: number of entries that match the converted info index
* @param [out] ss_info, sprectrum information structure, * @ss_info: sprectrum information structure,
* @return Bios parser result code * return: Bios parser result code
*/ */
static enum bp_result bios_parser_get_spread_spectrum_info( static enum bp_result bios_parser_get_spread_spectrum_info(
struct dc_bios *dcb, struct dc_bios *dcb,
...@@ -985,10 +985,10 @@ static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1( ...@@ -985,10 +985,10 @@ static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1(
* There can not be more than 1 entry for ASIC_InternalSS_Info Ver 2.1 or * There can not be more than 1 entry for ASIC_InternalSS_Info Ver 2.1 or
* SS_Info. * SS_Info.
* *
* @param this * @bp: pointer to the BIOS parser
* @param id, spread sprectrum info index * @id: spread sprectrum info index
* @param pSSinfo, sprectrum information structure, * @ssinfo: sprectrum information structure,
* @return Bios parser result code * return:: BIOS parser result code
*/ */
static enum bp_result get_ss_info_from_tbl( static enum bp_result get_ss_info_from_tbl(
struct bios_parser *bp, struct bios_parser *bp,
...@@ -1011,9 +1011,10 @@ static enum bp_result get_ss_info_from_tbl( ...@@ -1011,9 +1011,10 @@ static enum bp_result get_ss_info_from_tbl(
* from the VBIOS * from the VBIOS
* There will not be multiple entry for Ver 2.1 * There will not be multiple entry for Ver 2.1
* *
* @param id, spread sprectrum info index * @bp: pointer to the Bios parser
* @param pSSinfo, sprectrum information structure, * @id: spread sprectrum info index
* @return Bios parser result code * @info: sprectrum information structure,
* return: Bios parser result code
*/ */
static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1( static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1(
struct bios_parser *bp, struct bios_parser *bp,
...@@ -1076,9 +1077,10 @@ static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1( ...@@ -1076,9 +1077,10 @@ static enum bp_result get_ss_info_from_internal_ss_info_tbl_V2_1(
* of entries that matches the id * of entries that matches the id
* for, the SS_Info table, there should not be more than 1 entry match. * for, the SS_Info table, there should not be more than 1 entry match.
* *
* @param [in] id, spread sprectrum id * @bp: pointer to the Bios parser
* @param [out] pSSinfo, sprectrum information structure, * @id: spread sprectrum id
* @return Bios parser result code * @ss_info: sprectrum information structure,
* return: Bios parser result code
*/ */
static enum bp_result get_ss_info_from_ss_info_table( static enum bp_result get_ss_info_from_ss_info_table(
struct bios_parser *bp, struct bios_parser *bp,
...@@ -1451,16 +1453,14 @@ static enum bp_result get_embedded_panel_info_v1_3( ...@@ -1451,16 +1453,14 @@ static enum bp_result get_embedded_panel_info_v1_3(
} }
/** /**
* bios_parser_get_encoder_cap_info * bios_parser_get_encoder_cap_info - get encoder capability
* information of input object id
* *
* @brief * @dcb: pointer to the DC BIOS
* Get encoder capability information of input object id * @object_id: object id
* * @info: encoder cap information structure
* @param object_id, Object id
* @param object_id, encoder cap information structure
*
* @return Bios parser result code
* *
* return: Bios parser result code
*/ */
static enum bp_result bios_parser_get_encoder_cap_info( static enum bp_result bios_parser_get_encoder_cap_info(
struct dc_bios *dcb, struct dc_bios *dcb,
...@@ -1490,17 +1490,12 @@ static enum bp_result bios_parser_get_encoder_cap_info( ...@@ -1490,17 +1490,12 @@ static enum bp_result bios_parser_get_encoder_cap_info(
} }
/** /**
* get_encoder_cap_record * get_encoder_cap_record - Get encoder cap record for the object
*
* @brief
* Get encoder cap record for the object
*
* @param object, ATOM object
* *
* @return atom encoder cap record * @bp: pointer to the BIOS parser
* * @object: ATOM object
* @note * return: atom encoder cap record
* search all records to find the ATOM_ENCODER_CAP_RECORD_V2 record * note: search all records to find the ATOM_ENCODER_CAP_RECORD_V2 record
*/ */
static ATOM_ENCODER_CAP_RECORD_V2 *get_encoder_cap_record( static ATOM_ENCODER_CAP_RECORD_V2 *get_encoder_cap_record(
struct bios_parser *bp, struct bios_parser *bp,
...@@ -1557,8 +1552,9 @@ static uint32_t get_ss_entry_number_from_ss_info_tbl( ...@@ -1557,8 +1552,9 @@ static uint32_t get_ss_entry_number_from_ss_info_tbl(
* Get Number of SpreadSpectrum Entry from the ASIC_InternalSS_Info table from * Get Number of SpreadSpectrum Entry from the ASIC_InternalSS_Info table from
* the VBIOS that match the SSid (to be converted from signal) * the VBIOS that match the SSid (to be converted from signal)
* *
* @param[in] signal, ASSignalType to be converted to SSid * @dcb: pointer to the DC BIOS
* @return number of SS Entry that match the signal * @signal: ASSignalType to be converted to SSid
* return: number of SS Entry that match the signal
*/ */
static uint32_t bios_parser_get_ss_entry_number( static uint32_t bios_parser_get_ss_entry_number(
struct dc_bios *dcb, struct dc_bios *dcb,
...@@ -1608,10 +1604,10 @@ static uint32_t bios_parser_get_ss_entry_number( ...@@ -1608,10 +1604,10 @@ static uint32_t bios_parser_get_ss_entry_number(
* get_ss_entry_number_from_ss_info_tbl * get_ss_entry_number_from_ss_info_tbl
* Get Number of spread spectrum entry from the SS_Info table from the VBIOS. * Get Number of spread spectrum entry from the SS_Info table from the VBIOS.
* *
* @note There can only be one entry for each id for SS_Info Table * @bp: pointer to the BIOS parser
* * @id: spread spectrum id
* @param [in] id, spread spectrum id * return: number of SS Entry that match the id
* @return number of SS Entry that match the id * note: There can only be one entry for each id for SS_Info Table
*/ */
static uint32_t get_ss_entry_number_from_ss_info_tbl( static uint32_t get_ss_entry_number_from_ss_info_tbl(
struct bios_parser *bp, struct bios_parser *bp,
...@@ -1679,8 +1675,9 @@ static uint32_t get_ss_entry_number_from_ss_info_tbl( ...@@ -1679,8 +1675,9 @@ static uint32_t get_ss_entry_number_from_ss_info_tbl(
* There can not be more than 1 entry for ASIC_InternalSS_Info Ver 2.1 or * There can not be more than 1 entry for ASIC_InternalSS_Info Ver 2.1 or
* SS_Info. * SS_Info.
* *
* @param id, spread sprectrum info index * @bp: pointer to the BIOS parser
* @return Bios parser result code * @id: spread sprectrum info index
* return: Bios parser result code
*/ */
static uint32_t get_ss_entry_number(struct bios_parser *bp, uint32_t id) static uint32_t get_ss_entry_number(struct bios_parser *bp, uint32_t id)
{ {
...@@ -1696,8 +1693,9 @@ static uint32_t get_ss_entry_number(struct bios_parser *bp, uint32_t id) ...@@ -1696,8 +1693,9 @@ static uint32_t get_ss_entry_number(struct bios_parser *bp, uint32_t id)
* Ver 2.1 from the VBIOS * Ver 2.1 from the VBIOS
* There will not be multiple entry for Ver 2.1 * There will not be multiple entry for Ver 2.1
* *
* @param id, spread sprectrum info index * @bp: pointer to the BIOS parser
* @return number of SS Entry that match the id * @id: spread sprectrum info index
* return: number of SS Entry that match the id
*/ */
static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_v2_1( static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_v2_1(
struct bios_parser *bp, struct bios_parser *bp,
...@@ -1731,8 +1729,9 @@ static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_v2_1( ...@@ -1731,8 +1729,9 @@ static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_v2_1(
* Get Number of SpreadSpectrum Entry from the ASIC_InternalSS_Info table of * Get Number of SpreadSpectrum Entry from the ASIC_InternalSS_Info table of
* the VBIOS that matches id * the VBIOS that matches id
* *
* @param[in] id, spread sprectrum id * @bp: pointer to the BIOS parser
* @return number of SS Entry that match the id * @id: spread sprectrum id
* return: number of SS Entry that match the id
*/ */
static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_V3_1( static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_V3_1(
struct bios_parser *bp, struct bios_parser *bp,
...@@ -1767,10 +1766,11 @@ static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_V3_1( ...@@ -1767,10 +1766,11 @@ static uint32_t get_ss_entry_number_from_internal_ss_info_tbl_V3_1(
* bios_parser_get_gpio_pin_info * bios_parser_get_gpio_pin_info
* Get GpioPin information of input gpio id * Get GpioPin information of input gpio id
* *
* @param gpio_id, GPIO ID * @dcb: pointer to the DC BIOS
* @param info, GpioPin information structure * @gpio_id: GPIO ID
* @return Bios parser result code * @info: GpioPin information structure
* @note * return: Bios parser result code
* note:
* to get the GPIO PIN INFO, we need: * to get the GPIO PIN INFO, we need:
* 1. get the GPIO_ID from other object table, see GetHPDInfo() * 1. get the GPIO_ID from other object table, see GetHPDInfo()
* 2. in DATA_TABLE.GPIO_Pin_LUT, search all records, to get the registerA * 2. in DATA_TABLE.GPIO_Pin_LUT, search all records, to get the registerA
...@@ -2197,13 +2197,10 @@ static uint32_t get_support_mask_for_device_id(struct device_id device_id) ...@@ -2197,13 +2197,10 @@ static uint32_t get_support_mask_for_device_id(struct device_id device_id)
} }
/** /**
* bios_parser_set_scratch_critical_state * bios_parser_set_scratch_critical_state - update critical state
* * bit in VBIOS scratch register
* @brief * @dcb: pointer to the DC BIOS
* update critical state bit in VBIOS scratch register * @state: set or reset state
*
* @param
* bool - to set or reset state
*/ */
static void bios_parser_set_scratch_critical_state( static void bios_parser_set_scratch_critical_state(
struct dc_bios *dcb, struct dc_bios *dcb,
...@@ -2222,7 +2219,7 @@ static void bios_parser_set_scratch_critical_state( ...@@ -2222,7 +2219,7 @@ static void bios_parser_set_scratch_critical_state(
* bios_parser *bp - [in]BIOS parser handler to get master data table * bios_parser *bp - [in]BIOS parser handler to get master data table
* integrated_info *info - [out] store and output integrated info * integrated_info *info - [out] store and output integrated info
* *
* @return * return:
* enum bp_result - BP_RESULT_OK if information is available, * enum bp_result - BP_RESULT_OK if information is available,
* BP_RESULT_BADBIOSTABLE otherwise. * BP_RESULT_BADBIOSTABLE otherwise.
*/ */
...@@ -2372,7 +2369,7 @@ static enum bp_result get_integrated_info_v8( ...@@ -2372,7 +2369,7 @@ static enum bp_result get_integrated_info_v8(
* bios_parser *bp - [in]BIOS parser handler to get master data table * bios_parser *bp - [in]BIOS parser handler to get master data table
* integrated_info *info - [out] store and output integrated info * integrated_info *info - [out] store and output integrated info
* *
* @return * return:
* enum bp_result - BP_RESULT_OK if information is available, * enum bp_result - BP_RESULT_OK if information is available,
* BP_RESULT_BADBIOSTABLE otherwise. * BP_RESULT_BADBIOSTABLE otherwise.
*/ */
...@@ -2509,7 +2506,7 @@ static enum bp_result get_integrated_info_v9( ...@@ -2509,7 +2506,7 @@ static enum bp_result get_integrated_info_v9(
* bios_parser *bp - [in]BIOS parser handler to get master data table * bios_parser *bp - [in]BIOS parser handler to get master data table
* integrated_info *info - [out] store and output integrated info * integrated_info *info - [out] store and output integrated info
* *
* @return * return:
* enum bp_result - BP_RESULT_OK if information is available, * enum bp_result - BP_RESULT_OK if information is available,
* BP_RESULT_BADBIOSTABLE otherwise. * BP_RESULT_BADBIOSTABLE otherwise.
*/ */
......
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