public inbox for intel-gfx@lists.freedesktop.org
 help / color / mirror / Atom feed
From: Ramalingam C <ramalingam.c@intel.com>
To: intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org,
	daniel.vetter@ffwll.ch, tomas.winkler@intel.com,
	uma.shankar@intel.com
Cc: Daniel Vetter <daniel.vetter@intel.com>,
	Russell King - ARM Linux admin <linux@armlinux.org.uk>
Subject: [PATCH v11 03/42] drm/doc: document recommended component helper usage
Date: Thu,  7 Feb 2019 02:33:52 +0530	[thread overview]
Message-ID: <1549487071-15343-4-git-send-email-ramalingam.c@intel.com> (raw)
In-Reply-To: <1549487071-15343-1-git-send-email-ramalingam.c@intel.com>

From: Daniel Vetter <daniel.vetter@intel.com>

Now that component has docs it's worth spending a few words and
hyperlinks on recommended best practices in drm.

Cc: Russell King - ARM Linux admin <linux@armlinux.org.uk>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 Documentation/driver-api/component.rst |  2 ++
 Documentation/gpu/drm-internals.rst    |  5 +++++
 drivers/gpu/drm/drm_drv.c              | 14 ++++++++++++++
 3 files changed, 21 insertions(+)

diff --git a/Documentation/driver-api/component.rst b/Documentation/driver-api/component.rst
index 2da4a8f20607..57e37590733f 100644
--- a/Documentation/driver-api/component.rst
+++ b/Documentation/driver-api/component.rst
@@ -1,3 +1,5 @@
+.. _component:
+
 ======================================
 Component Helper for Aggregate Drivers
 ======================================
diff --git a/Documentation/gpu/drm-internals.rst b/Documentation/gpu/drm-internals.rst
index 3ae23a5454ac..966bd2d9f0cc 100644
--- a/Documentation/gpu/drm-internals.rst
+++ b/Documentation/gpu/drm-internals.rst
@@ -93,6 +93,11 @@ Device Instance and Driver Handling
 Driver Load
 -----------
 
+Component Helper Usage
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. kernel-doc:: drivers/gpu/drm/drm_drv.c
+   :doc: component helper usage recommendations
 
 IRQ Helper Library
 ~~~~~~~~~~~~~~~~~~
diff --git a/drivers/gpu/drm/drm_drv.c b/drivers/gpu/drm/drm_drv.c
index 381581b01d48..aae413003705 100644
--- a/drivers/gpu/drm/drm_drv.c
+++ b/drivers/gpu/drm/drm_drv.c
@@ -457,6 +457,20 @@ static void drm_fs_inode_free(struct inode *inode)
 }
 
 /**
+ * DOC: component helper usage recommendations
+ *
+ * DRM drivers that drive hardware where a logical device consists of a pile of
+ * independent hardware blocks are recommended to use the :ref:`component helper
+ * library<component>`. The entire device initialization procedure should be run
+ * from the &component_master_ops.master_bind callback, starting with
+ * drm_dev_init(), then binding all components with component_bind_all() and
+ * finishing with drm_dev_register(). For consistency and easier sharing of
+ * components across drivers the opaque pointer passed to all components through
+ * component_bind_all() should point at &struct drm_device of the device
+ * instance, not some driver specific private structure.
+ */
+
+/**
  * drm_dev_init - Initialise new DRM device
  * @dev: DRM device
  * @driver: DRM driver
-- 
2.7.4

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

  parent reply	other threads:[~2019-02-06 21:03 UTC|newest]

Thread overview: 74+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-06 21:03 [PATCH v11 00/42] drm/i915: Implement HDCP2.2 Ramalingam C
2019-02-06 21:03 ` [PATCH v11 01/42] component: Add documentation Ramalingam C
2019-02-07 14:54   ` Winkler, Tomas
2019-02-06 21:03 ` [PATCH v11 02/42] components: multiple components for a device Ramalingam C
2019-02-06 21:03 ` Ramalingam C [this message]
2019-02-06 21:03 ` [PATCH v11 04/42] i915/snd_hdac: I915 subcomponent for the snd_hdac Ramalingam C
2019-02-06 21:03 ` [PATCH v11 05/42] drm/i915: Gathering the HDCP1.4 routines together Ramalingam C
2019-02-07 15:00   ` Winkler, Tomas
2019-02-06 21:03 ` [PATCH v11 06/42] drm: header for i915 - MEI_HDCP interface Ramalingam C
2019-02-07 15:06   ` Winkler, Tomas
2019-02-06 21:03 ` [PATCH v11 07/42] drm/i915: Initialize HDCP2.2 Ramalingam C
2019-02-07 15:13   ` Winkler, Tomas
2019-02-07 16:09     ` C, Ramalingam
2019-02-06 21:03 ` [PATCH v11 08/42] drm/i915: MEI interface definition Ramalingam C
2019-02-06 21:34   ` C, Ramalingam
2019-02-07 19:40   ` Daniel Vetter
2019-02-07 19:48     ` Daniel Vetter
2019-02-08  8:48       ` C, Ramalingam
2019-02-06 21:03 ` [PATCH v11 09/42] drm/i915: hdcp1.4 CP_IRQ handling and SW encryption tracking Ramalingam C
2019-02-06 21:03 ` [PATCH v11 10/42] drm/i915: Enable and Disable of HDCP2.2 Ramalingam C
2019-02-06 21:04 ` [PATCH v11 11/42] drm/i915: Implement HDCP2.2 receiver authentication Ramalingam C
2019-02-06 21:04 ` [PATCH v11 12/42] drm: helper functions for hdcp2 seq_num to from u32 Ramalingam C
2019-02-06 21:04 ` [PATCH v11 13/42] drm/i915: Implement HDCP2.2 repeater authentication Ramalingam C
2019-02-06 21:04 ` [PATCH v11 14/42] drm: HDCP2.2 link check period Ramalingam C
2019-02-06 21:04 ` [PATCH v11 15/42] drm/i915: Implement HDCP2.2 link integrity check Ramalingam C
2019-02-06 21:04 ` [PATCH v11 16/42] drm/i915: Handle HDCP2.2 downstream topology change Ramalingam C
2019-02-06 21:04 ` [PATCH v11 17/42] drm: removing the DP Errata msg and its msg id Ramalingam C
2019-02-06 21:04 ` [PATCH v11 18/42] drm/i915: Implement the HDCP2.2 support for DP Ramalingam C
2019-02-06 21:04 ` [PATCH v11 19/42] drm/i915: Implement the HDCP2.2 support for HDMI Ramalingam C
2019-02-06 21:04 ` [PATCH v11 20/42] drm/i915: CP_IRQ handling for DP HDCP2.2 msgs Ramalingam C
2019-02-06 21:04 ` [PATCH v11 21/42] drm/i915: HDCP state handling in ddi_update_pipe Ramalingam C
2019-02-06 21:04 ` [PATCH v11 22/42] drm/i915: Fix KBL HDCP2.2 encrypt status signalling Ramalingam C
2019-02-06 21:04 ` [PATCH v11 23/42] mei: bus: whitelist hdcp client Ramalingam C
2019-02-06 21:04 ` [PATCH v11 24/42] mei: me: add ice lake point device ids Ramalingam C
2019-02-07  7:16   ` Winkler, Tomas
2019-02-07  7:22     ` C, Ramalingam
2019-02-07  7:48       ` Daniel Vetter
2019-02-06 21:04 ` [PATCH v11 25/42] mei: bus: export to_mei_cl_device for mei client device drivers Ramalingam C
2019-02-06 21:04 ` [PATCH v11 26/42] misc/mei/hdcp: Client driver for HDCP application Ramalingam C
2019-02-07 21:07   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 27/42] misc/mei/hdcp: Define ME FW interface for HDCP2.2 Ramalingam C
2019-02-06 21:04 ` [PATCH v11 28/42] misc/mei/hdcp: Initiate Wired HDCP2.2 Tx Session Ramalingam C
2019-02-07 21:35   ` Winkler, Tomas
2019-02-08  5:15     ` C, Ramalingam
2019-02-06 21:04 ` [PATCH v11 29/42] misc/mei/hdcp: Verify Receiver Cert and prepare km Ramalingam C
2019-02-07 21:23   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 30/42] misc/mei/hdcp: Verify H_prime Ramalingam C
2019-02-07 21:37   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 31/42] misc/mei/hdcp: Store the HDCP Pairing info Ramalingam C
2019-02-07 21:39   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 32/42] misc/mei/hdcp: Initiate Locality check Ramalingam C
2019-02-07 21:38   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 33/42] misc/mei/hdcp: Verify L_prime Ramalingam C
2019-02-07 21:41   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 34/42] misc/mei/hdcp: Prepare Session Key Ramalingam C
2019-02-07 21:45   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 35/42] misc/mei/hdcp: Repeater topology verification and ack Ramalingam C
2019-02-07 21:41   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 36/42] misc/mei/hdcp: Verify M_prime Ramalingam C
2019-02-07 21:46   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 37/42] misc/mei/hdcp: Enabling the HDCP authentication Ramalingam C
2019-02-07 21:46   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 38/42] misc/mei/hdcp: Closing wired HDCP2.2 Tx Session Ramalingam C
2019-02-07 21:47   ` Winkler, Tomas
2019-02-06 21:04 ` [PATCH v11 39/42] misc/mei/hdcp: Component framework for I915 Interface Ramalingam C
2019-02-07 22:12   ` Winkler, Tomas
2019-02-08  5:15     ` C, Ramalingam
2019-02-06 21:04 ` [PATCH v11 40/42] FOR_TEST_ONLY: i915/Kconfig: Select mei_hdcp by I915 Ramalingam C
2019-02-06 21:04 ` [PATCH v11 41/42] FOR_TESTING_ONLY: debugfs: Excluding the LSPCon for HDCP1.4 Ramalingam C
2019-02-06 21:39 ` [PATCH v11 42/42] FOR_TESTING_ONLY: ICL: Limit clk to <= 340MHz Ramalingam C
2019-02-06 22:53 ` ✗ Fi.CI.CHECKPATCH: warning for drm/i915: Implement HDCP2.2 (rev17) Patchwork
2019-02-06 23:04 ` ✗ Fi.CI.SPARSE: " Patchwork
2019-02-06 23:12 ` ✓ Fi.CI.BAT: success " Patchwork
2019-02-07  5:00 ` ✓ Fi.CI.IGT: " Patchwork

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=1549487071-15343-4-git-send-email-ramalingam.c@intel.com \
    --to=ramalingam.c@intel.com \
    --cc=daniel.vetter@ffwll.ch \
    --cc=daniel.vetter@intel.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=intel-gfx@lists.freedesktop.org \
    --cc=linux@armlinux.org.uk \
    --cc=tomas.winkler@intel.com \
    --cc=uma.shankar@intel.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