Commit c371aa12 authored by Rodrigo Siqueira's avatar Rodrigo Siqueira Committed by Alex Deucher
Browse files

Documentation/gpu: Add kernel doc entry for DPP 



This commit introduces basic DPP information and the struct scan for
code documentation.

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>
Reviewed-by: default avatarMario Limonciello <mario.limonciello@amd.com>
Acked-by: default avatarChristian König <christian.koenig@amd.com>
Acked-by: default avatarHamza Mahfooz <hamza.mahfooz@amd.com>
Signed-off-by: default avatarRodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent 50d3cf5e

Documentation/gpu/amdgpu/display/dcn-blocks.rst

+12 −0
Original line number Diff line number Diff line
@@ -28,3 +28,15 @@ HUBP 


.. kernel-doc:: drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h

   :internal:



DPP

---



.. 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:

drivers/gpu/drm/amd/display/dc/inc/hw/dpp.h

+25 −0
Original line number Diff line number Diff line
@@ -27,6 +27,31 @@ 
#ifndef __DAL_DPP_H__

#define __DAL_DPP_H__



/**

 * DOC: overview

 *

 * The DPP (Display Pipe and Plane) block is the unified display data

 * processing engine in DCN for processing graphic or video data on per DPP

 * rectangle base. This rectangle can be a part of SLS (Single Large Surface),

 * or a layer to be blended with other DPP, or a rectangle associated with a

 * display tile.

 *

 * It provides various functions including:

 * - graphic color keyer

 * - graphic cursor compositing

 * - graphic or video image source to destination scaling

 * - image sharping

 * - video format conversion from 4:2:0 or 4:2:2 to 4:4:4

 * - Color Space Conversion

 * - Host LUT gamma adjustment

 * - Color Gamut Remap

 * - brightness and contrast adjustment.

 *

 * DPP pipe consists of Converter and Cursor (CNVC), Scaler (DSCL), Color

 * Management (CM), Output Buffer (OBUF) and Digital Bypass (DPB) module

 * connected in a video/graphics pipeline.

 */



#include "transform.h"

#include "cursor_reg_cache.h"