* [PATCH v2] drm/amd/display: Docs improvement in /dc/inc/hw/mpc.h
[not found] <20240704092039.31264-1-akshaybehl231@gmail.com>
@ 2024-07-05 9:48 ` Akshay Behl
2024-07-05 10:01 ` Akshay Behl
1 sibling, 0 replies; 3+ messages in thread
From: Akshay Behl @ 2024-07-05 9:48 UTC (permalink / raw)
Cc: Akshay Behl, amd-gfx, dri-devel, linux-kernel
- After making the required changes
This patch fixes some of the warnings while building kernel Docs:
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'read_mpcc_state' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'mpc_init_single_inst' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'get_mpcc_for_dpp_from_secondary' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'get_mpcc_for_dpp' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'wait_for_idle' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'assert_mpcc_idle_before_connect' not described in 'mpc_funcs'
by adding descriptions to these struct members
Signed-off-by: Akshay Behl <akshaybehl231@gmail.com>
---
drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 84 ++++++++++++++++++++-
1 file changed, 83 insertions(+), 1 deletion(-)
diff --git a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
index 34a398f23fc6..d2bea0a9699d 100644
--- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
+++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
@@ -282,6 +282,21 @@ struct mpcc_state {
* struct mpc_funcs - funcs
*/
struct mpc_funcs {
+ /**
+ * @read_mpcc_state:
+ *
+ * Read current state of a specified MPCC instance
+ *
+ * Parameters:
+ *
+ * - [in/out] mpc - MPC context.
+ * - [in] mpcc_inst - integer representing specific MPC instance
+ * - [in/out] mpcc_state - MPCC state struct where read information will be stored
+ *
+ * Return:
+ *
+ * void
+ */
void (*read_mpcc_state)(
struct mpc *mpc,
int mpcc_inst,
@@ -352,6 +367,21 @@ struct mpc_funcs {
* void
*/
void (*mpc_init)(struct mpc *mpc);
+
+ /**
+ * @mpc_init_single_inst:
+ *
+ * Reset the MPCC HW status of a single MPCC physical instance.
+ *
+ * Parameters:
+ *
+ * - [in/out] mpc - MPC context.
+ * - [in] mpcc_id - The MPCC physical instance to use for blending.
+ *
+ * Return:
+ *
+ * void
+ */
void (*mpc_init_single_inst)(
struct mpc *mpc,
unsigned int mpcc_id);
@@ -448,17 +478,69 @@ struct mpc_funcs {
struct mpc *mpc,
struct mpc_tree *tree,
struct mpcc *mpcc);
-
+ /**
+ * @get_mpcc_for_dpp_from_secondary:
+ *
+ * Retrieve a specified MPCC struct from the 'secondary' MPC tree using the provided DPP id.
+ *
+ * Parameters:
+ * - [in/out] tree - MPC tree structure that will be searched.
+ * - [in] dpp_id - DPP input for the MPCC.
+ *
+ * Return:
+ *
+ * struct mpcc* - MPCC that matched the input params
+ */
struct mpcc* (*get_mpcc_for_dpp_from_secondary)(
struct mpc_tree *tree,
int dpp_id);
+ /**
+ * @get_mpcc_for_dpp:
+ *
+ * Retrieve a specified MPCC struct from the MPC tree using the provided DPP id.
+ *
+ * Parameters:
+ * - [in/out] tree - MPC tree structure that will be searched.
+ * - [in] dpp_id - DPP input for the MPCC.
+ *
+ * Return:
+ *
+ * struct mpcc* - MPCC that matched the input params
+ */
+
struct mpcc* (*get_mpcc_for_dpp)(
struct mpc_tree *tree,
int dpp_id);
+ /**
+ * @wait_for_idle:
+ *
+ * Wait for a specific MPCC instance to become idle
+ *
+ * Parameters:
+ * - [in/out] mpc - MPC context.
+ * - [in] id - ID of the MPCC instance to wait for
+ *
+ * Return:
+ *
+ * void
+ */
void (*wait_for_idle)(struct mpc *mpc, int id);
+ /**
+ * @assert_mpcc_idle_before_connect:
+ *
+ * Assert that the specific MPCC instance is ideal before attempting to connect.
+ *
+ * Parameters:
+ * - [in/out] mpc - MPC context.
+ * - [in] mpcc_id - ID of the MPCC instance to check for
+ *
+ * Return:
+ *
+ * void
+ */
void (*assert_mpcc_idle_before_connect)(struct mpc *mpc, int mpcc_id);
void (*init_mpcc_list_from_hw)(
--
2.34.1
^ permalink raw reply [flat|nested] 3+ messages in thread* [PATCH v2] drm/amd/display: Docs improvement in /dc/inc/hw/mpc.h
[not found] <20240704092039.31264-1-akshaybehl231@gmail.com>
2024-07-05 9:48 ` [PATCH v2] drm/amd/display: Docs improvement in /dc/inc/hw/mpc.h Akshay Behl
@ 2024-07-05 10:01 ` Akshay Behl
1 sibling, 0 replies; 3+ messages in thread
From: Akshay Behl @ 2024-07-05 10:01 UTC (permalink / raw)
To: airlied, daniel
Cc: Akshay Behl, Xinhui.Pan, Rodrigo.Siqueira, sunpeng.li,
alexander.deucher, amd-gfx, dri-devel, linux-kernel
After making the required changes
This patch fixes some of the warnings while building kernel Docs:
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'read_mpcc_state' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'mpc_init_single_inst' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'get_mpcc_for_dpp_from_secondary' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'get_mpcc_for_dpp' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'wait_for_idle' not described in 'mpc_funcs'
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning: Function parameter or struct member 'assert_mpcc_idle_before_connect' not described in 'mpc_funcs'
by adding descriptions to these struct members
Signed-off-by: Akshay Behl <akshaybehl231@gmail.com>
---
drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 84 ++++++++++++++++++++-
1 file changed, 83 insertions(+), 1 deletion(-)
diff --git a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
index 34a398f23fc6..d2bea0a9699d 100644
--- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
+++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
@@ -282,6 +282,21 @@ struct mpcc_state {
* struct mpc_funcs - funcs
*/
struct mpc_funcs {
+ /**
+ * @read_mpcc_state:
+ *
+ * Read current state of a specified MPCC instance
+ *
+ * Parameters:
+ *
+ * - [in/out] mpc - MPC context.
+ * - [in] mpcc_inst - integer representing specific MPC instance
+ * - [in/out] mpcc_state - MPCC state struct where read information will be stored
+ *
+ * Return:
+ *
+ * void
+ */
void (*read_mpcc_state)(
struct mpc *mpc,
int mpcc_inst,
@@ -352,6 +367,21 @@ struct mpc_funcs {
* void
*/
void (*mpc_init)(struct mpc *mpc);
+
+ /**
+ * @mpc_init_single_inst:
+ *
+ * Reset the MPCC HW status of a single MPCC physical instance.
+ *
+ * Parameters:
+ *
+ * - [in/out] mpc - MPC context.
+ * - [in] mpcc_id - The MPCC physical instance to use for blending.
+ *
+ * Return:
+ *
+ * void
+ */
void (*mpc_init_single_inst)(
struct mpc *mpc,
unsigned int mpcc_id);
@@ -448,17 +478,69 @@ struct mpc_funcs {
struct mpc *mpc,
struct mpc_tree *tree,
struct mpcc *mpcc);
-
+ /**
+ * @get_mpcc_for_dpp_from_secondary:
+ *
+ * Retrieve a specified MPCC struct from the 'secondary' MPC tree using the provided DPP id.
+ *
+ * Parameters:
+ * - [in/out] tree - MPC tree structure that will be searched.
+ * - [in] dpp_id - DPP input for the MPCC.
+ *
+ * Return:
+ *
+ * struct mpcc* - MPCC that matched the input params
+ */
struct mpcc* (*get_mpcc_for_dpp_from_secondary)(
struct mpc_tree *tree,
int dpp_id);
+ /**
+ * @get_mpcc_for_dpp:
+ *
+ * Retrieve a specified MPCC struct from the MPC tree using the provided DPP id.
+ *
+ * Parameters:
+ * - [in/out] tree - MPC tree structure that will be searched.
+ * - [in] dpp_id - DPP input for the MPCC.
+ *
+ * Return:
+ *
+ * struct mpcc* - MPCC that matched the input params
+ */
+
struct mpcc* (*get_mpcc_for_dpp)(
struct mpc_tree *tree,
int dpp_id);
+ /**
+ * @wait_for_idle:
+ *
+ * Wait for a specific MPCC instance to become idle
+ *
+ * Parameters:
+ * - [in/out] mpc - MPC context.
+ * - [in] id - ID of the MPCC instance to wait for
+ *
+ * Return:
+ *
+ * void
+ */
void (*wait_for_idle)(struct mpc *mpc, int id);
+ /**
+ * @assert_mpcc_idle_before_connect:
+ *
+ * Assert that the specific MPCC instance is ideal before attempting to connect.
+ *
+ * Parameters:
+ * - [in/out] mpc - MPC context.
+ * - [in] mpcc_id - ID of the MPCC instance to check for
+ *
+ * Return:
+ *
+ * void
+ */
void (*assert_mpcc_idle_before_connect)(struct mpc *mpc, int mpcc_id);
void (*init_mpcc_list_from_hw)(
--
2.34.1
^ permalink raw reply [flat|nested] 3+ messages in thread