AMD-GFX Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
To: "Alex Deucher" <alexander.deucher@amd.com>,
	"Christian König" <christian.koenig@amd.com>,
	"Mario Limonciello" <mario.limonciello@amd.com>,
	"Harry Wentland" <harry.wentland@amd.com>,
	"Leo Li" <sunpeng.li@amd.com>,
	"Hamza Mahfooz" <hamza.mahfooz@amd.com>,
	"Aurabindo Pillai" <aurabindo.pillai@amd.com>,
	"Jani Nikula" <jani.nikula@linux.intel.com>
Cc: Harry Wentland <Harry.Wentland@amd.com>,
	Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>,
	amd-gfx@lists.freedesktop.org, linux-doc@vger.kernel.org
Subject: [PATCH v2 2/8] Documentation/gpu: Add simple doc page for DCHUBBUB
Date: Mon, 22 Jan 2024 14:24:55 -0700	[thread overview]
Message-ID: <20240122212719.647008-3-Rodrigo.Siqueira@amd.com> (raw)
In-Reply-To: <20240122212719.647008-1-Rodrigo.Siqueira@amd.com>

Enable the documentation to extract code documentation from dchubbub.h
file.

Cc: Mario Limonciello <mario.limonciello@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Harry Wentland <Harry.Wentland@amd.com>
Cc: Hamza Mahfooz <hamza.mahfooz@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Aurabindo Pillai <aurabindo.pillai@amd.com>
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
 Documentation/gpu/amdgpu/display/dcn-blocks.rst  | 12 ++++++++++++
 drivers/gpu/drm/amd/display/dc/inc/hw/dchubbub.h |  6 ++++++
 2 files changed, 18 insertions(+)

diff --git a/Documentation/gpu/amdgpu/display/dcn-blocks.rst b/Documentation/gpu/amdgpu/display/dcn-blocks.rst
index 5da34d5b73d8..e4e0a4ddca4e 100644
--- a/Documentation/gpu/amdgpu/display/dcn-blocks.rst
+++ b/Documentation/gpu/amdgpu/display/dcn-blocks.rst
@@ -5,6 +5,18 @@ DCN Blocks
 In this section, you will find some extra details about some of the DCN blocks
 and the code documentation when it is automatically generated.
 
+DCHUBBUB
+--------
+
+.. kernel-doc:: drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h
+   :doc: overview
+
+.. kernel-doc:: drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h
+   :export:
+
+.. kernel-doc:: drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h
+   :internal:
+
 HUBP
 ----
 
diff --git a/drivers/gpu/drm/amd/display/dc/inc/hw/dchubbub.h b/drivers/gpu/drm/amd/display/dc/inc/hw/dchubbub.h
index 901891316dfb..2ae7484d18af 100644
--- a/drivers/gpu/drm/amd/display/dc/inc/hw/dchubbub.h
+++ b/drivers/gpu/drm/amd/display/dc/inc/hw/dchubbub.h
@@ -26,6 +26,12 @@
 #ifndef __DAL_DCHUBBUB_H__
 #define __DAL_DCHUBBUB_H__
 
+/**
+ * DOC: overview
+ *
+ * There is only one common DCHUBBUB. It contains the common request and return
+ * blocks for the Data Fabric Interface that are not clock/power gated.
+ */
 
 enum dcc_control {
 	dcc_control__256_256_xxx,
-- 
2.43.0


  parent reply	other threads:[~2024-01-22 21:28 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-22 21:24 [PATCH v2 0/8] Expand and improve AMDGPU documentation Rodrigo Siqueira
2024-01-22 21:24 ` [PATCH v2 1/8] Documentation/gpu: Add basic page for HUBP Rodrigo Siqueira
2024-01-22 21:24 ` Rodrigo Siqueira [this message]
2024-01-22 21:24 ` [PATCH v2 3/8] Documentation/gpu: Add kernel doc entry for DPP Rodrigo Siqueira
2024-01-22 21:24 ` [PATCH v2 4/8] Documentation/gpu: Add kernel doc entry for MPC Rodrigo Siqueira
2024-01-22 21:24 ` [PATCH v2 5/8] Documentation/gpu: Add entry for OPP in the kernel doc Rodrigo Siqueira
2024-01-22 21:24 ` [PATCH v2 6/8] Documentation/gpu: Add entry for the DIO component Rodrigo Siqueira
2024-01-22 21:25 ` [PATCH v2 7/8] Documentation/gpu: Add an explanation about the DC weekly patches Rodrigo Siqueira
2024-01-22 21:25 ` [PATCH v2 8/8] Documentation/gpu: Introduce a simple contribution list for display code Rodrigo Siqueira
2024-01-22 22:48 ` [PATCH v2 0/8] Expand and improve AMDGPU documentation Mario Limonciello
2024-01-23  9:28 ` Christian König
2024-01-23 16:19 ` Hamza Mahfooz
2024-01-25 18:49   ` Rodrigo Siqueira Jordao

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240122212719.647008-3-Rodrigo.Siqueira@amd.com \
    --to=rodrigo.siqueira@amd.com \
    --cc=alexander.deucher@amd.com \
    --cc=amd-gfx@lists.freedesktop.org \
    --cc=aurabindo.pillai@amd.com \
    --cc=christian.koenig@amd.com \
    --cc=hamza.mahfooz@amd.com \
    --cc=harry.wentland@amd.com \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=mario.limonciello@amd.com \
    --cc=sunpeng.li@amd.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox