[1/3] drm/i915: Add microcontrollers documentation section
diff mbox series

Message ID 20190927214243.18558-1-daniele.ceraolospurio@intel.com
State New
Headers show
Series
  • [1/3] drm/i915: Add microcontrollers documentation section
Related show

Commit Message

Daniele Ceraolo Spurio Sept. 27, 2019, 9:42 p.m. UTC
To better organize the information, add a microcontrollers section and
move/link the GuC, HuC and DMC documentation under it. Also add a small
intro.

Signed-off-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
---
 Documentation/gpu/i915.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

Comments

Anna Karas Oct. 7, 2019, 11:04 a.m. UTC | #1
Hello Daniele,

On Fri, Sep 27, 2019 at 02:42:41PM -0700, Daniele Ceraolo Spurio wrote:
> To better organize the information, add a microcontrollers section and
> move/link the GuC, HuC and DMC documentation under it. Also add a small
> intro.
> 
> Signed-off-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
> Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>

Acked-by: Anna Karas <anna.karas@intel.com>

Anna Karas
Martin Peres Oct. 9, 2019, 2:26 p.m. UTC | #2
On 28/09/2019 00:42, Daniele Ceraolo Spurio wrote:
> To better organize the information, add a microcontrollers section and
> move/link the GuC, HuC and DMC documentation under it. Also add a small
> intro.
> 
> Signed-off-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>

Reviewed-by: Martin Peres <martin.peres@linux.intel.com>

> Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
> ---
>  Documentation/gpu/i915.rst | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index 465779670fd4..f1bae7867045 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst
> @@ -415,6 +415,15 @@ Object Tiling IOCTLs
>  .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
>     :doc: buffer object tiling
>  
> +Microcontrollers
> +================
> +
> +Starting from gen9, three microcontrollers are available on the HW: the
> +graphics microcontroller (GuC), the HEVC/H.265 microcontroller (HuC) and the
> +display microcontroller (DMC). The driver is responsible for loading the
> +firmwares on the microcontrollers; the GuC and HuC firmwares are transferred
> +to WOPCM using the DMA engine, while the DMC firmware is written through MMIO.
> +
>  WOPCM
>  -----
>  
> @@ -454,6 +463,15 @@ GuC Address Space
>  .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
>     :doc: GuC Address Space
>  
> +HuC
> +---
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc_fw.c
> +   :doc: HuC Firmware
> +
> +DMC
> +---
> +See `CSR firmware support for DMC`_
> +
>  Tracing
>  =======
>  
>

Patch
diff mbox series

diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 465779670fd4..f1bae7867045 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -415,6 +415,15 @@  Object Tiling IOCTLs
 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
    :doc: buffer object tiling
 
+Microcontrollers
+================
+
+Starting from gen9, three microcontrollers are available on the HW: the
+graphics microcontroller (GuC), the HEVC/H.265 microcontroller (HuC) and the
+display microcontroller (DMC). The driver is responsible for loading the
+firmwares on the microcontrollers; the GuC and HuC firmwares are transferred
+to WOPCM using the DMA engine, while the DMC firmware is written through MMIO.
+
 WOPCM
 -----
 
@@ -454,6 +463,15 @@  GuC Address Space
 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
    :doc: GuC Address Space
 
+HuC
+---
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc_fw.c
+   :doc: HuC Firmware
+
+DMC
+---
+See `CSR firmware support for DMC`_
+
 Tracing
 =======