From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 22A2EC433EF for ; Fri, 26 Nov 2021 11:18:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231435AbhKZLVV (ORCPT ); Fri, 26 Nov 2021 06:21:21 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49530 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233004AbhKZLTV (ORCPT ); Fri, 26 Nov 2021 06:19:21 -0500 Received: from mail-wm1-x336.google.com (mail-wm1-x336.google.com [IPv6:2a00:1450:4864:20::336]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7DE30C061758 for ; Fri, 26 Nov 2021 02:35:07 -0800 (PST) Received: by mail-wm1-x336.google.com with SMTP id d72-20020a1c1d4b000000b00331140f3dc8so6467309wmd.1 for ; Fri, 26 Nov 2021 02:35:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-transfer-encoding:content-language; bh=yWMPT9gdUeJoBqjhtlnpMwe+xCg6/aY12TZNureZlQE=; b=L48KoTYS5dIsStjP372ocwxx4k9uRC254TXTt1fOJQ5//81huyKei+Nj8mR151LGf+ R47EetCPNsMiITtcbHWZOvdKSF+S/G52/WuBpgGsCQjhFwJ9M1Sdwj3WGXDdy9VTaVtE PTzKc8ODKvUoDRAY85zp5hglbHlyEREbCufIL2F2d8t/8cY2m2VbaFKMP/BRZtY+8YsM Pco0tFDLXebwJ+TFow3kbHNTCIcmwfPzKExDc9EwuL0BJieyoKt968AfJcVypZ0M2K9J ruUoqVEe5DwFeNtgPlQQcla35vQWaIEckkwA4GQr0KlP+UjAD+dDq42qnskioajlCUBq Vonw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-transfer-encoding :content-language; bh=yWMPT9gdUeJoBqjhtlnpMwe+xCg6/aY12TZNureZlQE=; b=oKR8FFTW7BpU+cZKCbuEa55rDeRSBPl1W0nLB/5eRXn8L9r5hCUGX8y/6CjpSdLZYX djqZ204RhTxTl/cLxuNb/rUkd+tJ51d9n+1eoHmQgXNRZBItepG3rLqVBrnqog9kv5Y7 cRH/31oI+LINvwkbEXdaWTNn22qkDwxylOyr7ZqzTLhVZNWmmbVGnUL79F7CD3DYrCZO FKUGezyq2Z8xNntfT6eQnVWk00rLr2lEt/6HrHpnQqM2Su++6qm8iQSP/a/O+Y0UspIo sHaK+kT288p2SDb61qVd5sZAXs/xzj/bNk/joIk0vY5ZdXIwLsPEVag8ymW+KjaY2D4a YS8g== X-Gm-Message-State: AOAM5300kL0KrQvAwhylODbzq/Tn847SOzyYYyS3skYWC0sBtwQofboR GAGY/ij0UllNZA5l/5Cv5bZIT4nSfI0= X-Google-Smtp-Source: ABdhPJwc/9KgeEHWhy3ewx0imoHrOYefqaEGmG78xusEOMnYDmxuHMddMUdx/gAnsSyZ3YzPxFxo+w== X-Received: by 2002:a05:600c:1d06:: with SMTP id l6mr14084629wms.97.1637922905985; Fri, 26 Nov 2021 02:35:05 -0800 (PST) Received: from ?IPv6:2a02:908:1252:fb60:108:c3ea:37df:ad4c? ([2a02:908:1252:fb60:108:c3ea:37df:ad4c]) by smtp.gmail.com with ESMTPSA id e7sm6986597wrg.31.2021.11.26.02.35.04 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 26 Nov 2021 02:35:05 -0800 (PST) Subject: Re: [PATCH 1/6] Documentation/gpu: Reorganize DC documentation To: Rodrigo Siqueira , Simon Ser , =?UTF-8?Q?Michel_D=c3=a4nzer?= , Bas Nieuwenhuizen , =?UTF-8?B?TWFyZWsgT2zFocOhaw==?= , Roman Gilg , Nicholas Kazlauskas , Harry Wentland , Mark Yacoub , Sean Paul , Pekka Paalanen Cc: linux-doc@vger.kernel.org, qingqing.zhuo@amd.com, roman.li@amd.com, amd-gfx@lists.freedesktop.org, aurabindo.pillai@amd.com, nicholas.choi@amd.com, dri-devel@lists.freedesktop.org, Alex Deucher , bhawanpreet.lakha@amd.com, =?UTF-8?Q?Christian_K=c3=b6nig?= References: <20211125153830.1352994-1-Rodrigo.Siqueira@amd.com> <20211125153830.1352994-2-Rodrigo.Siqueira@amd.com> From: =?UTF-8?Q?Christian_K=c3=b6nig?= Message-ID: Date: Fri, 26 Nov 2021 11:35:03 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.14.0 MIME-Version: 1.0 In-Reply-To: <20211125153830.1352994-2-Rodrigo.Siqueira@amd.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Just a general comment. Could you name the new subdirectory "amdgpu" instead? DC is just a component of the amdgpu driver and I think it would sooner or later make sense to group together the amdgpu documentation in one folder. Regards, Christian. Am 25.11.21 um 16:38 schrieb Rodrigo Siqueira: > Display core documentation is not well organized, and it is hard to find > information due to the lack of sections. This commit reorganizes the > documentation layout, and it is preparation work for future changes. > > Signed-off-by: Rodrigo Siqueira > --- > Documentation/gpu/amdgpu-dc.rst | 74 ------------------- > .../gpu/amdgpu-dc/amdgpu-dc-debug.rst | 4 + > Documentation/gpu/amdgpu-dc/amdgpu-dc.rst | 29 ++++++++ > Documentation/gpu/amdgpu-dc/amdgpu-dm.rst | 42 +++++++++++ > Documentation/gpu/drivers.rst | 2 +- > 5 files changed, 76 insertions(+), 75 deletions(-) > delete mode 100644 Documentation/gpu/amdgpu-dc.rst > create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst > create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dc.rst > create mode 100644 Documentation/gpu/amdgpu-dc/amdgpu-dm.rst > > diff --git a/Documentation/gpu/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc.rst > deleted file mode 100644 > index f7ff7e1309de..000000000000 > --- a/Documentation/gpu/amdgpu-dc.rst > +++ /dev/null > @@ -1,74 +0,0 @@ > -=================================== > -drm/amd/display - Display Core (DC) > -=================================== > - > -*placeholder - general description of supported platforms, what dc is, etc.* > - > -Because it is partially shared with other operating systems, the Display Core > -Driver is divided in two pieces. > - > -1. **Display Core (DC)** contains the OS-agnostic components. Things like > - hardware programming and resource management are handled here. > -2. **Display Manager (DM)** contains the OS-dependent components. Hooks to the > - amdgpu base driver and DRM are implemented here. > - > -It doesn't help that the entire package is frequently referred to as DC. But > -with the context in mind, it should be clear. > - > -When CONFIG_DRM_AMD_DC is enabled, DC will be initialized by default for > -supported ASICs. To force disable, set `amdgpu.dc=0` on kernel command line. > -Likewise, to force enable on unsupported ASICs, set `amdgpu.dc=1`. > - > -To determine if DC is loaded, search dmesg for the following entry: > - > -``Display Core initialized with `` > - > -AMDgpu Display Manager > -====================== > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > - :doc: overview > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h > - :internal: > - > -Lifecycle > ---------- > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > - :doc: DM Lifecycle > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > - :functions: dm_hw_init dm_hw_fini > - > -Interrupts > ----------- > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c > - :doc: overview > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c > - :internal: > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > - :functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq > - > -Atomic Implementation > ---------------------- > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > - :doc: atomic > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > - :functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail > - > -Display Core > -============ > - > -**WIP** > - > -FreeSync Video > --------------- > - > -.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > - :doc: FreeSync Video > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst > new file mode 100644 > index 000000000000..bbb8c3fc8eee > --- /dev/null > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc-debug.rst > @@ -0,0 +1,4 @@ > +Display Core Debug tools > +======================== > + > +TODO > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst > new file mode 100644 > index 000000000000..3685b3b1ad64 > --- /dev/null > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dc.rst > @@ -0,0 +1,29 @@ > +=================================== > +drm/amd/display - Display Core (DC) > +=================================== > + > +*placeholder - general description of supported platforms, what dc is, etc.* > + > +Because it is partially shared with other operating systems, the Display Core > +Driver is divided in two pieces. > + > +1. **Display Core (DC)** contains the OS-agnostic components. Things like > + hardware programming and resource management are handled here. > +2. **Display Manager (DM)** contains the OS-dependent components. Hooks to the > + amdgpu base driver and DRM are implemented here. > + > +It doesn't help that the entire package is frequently referred to as DC. But > +with the context in mind, it should be clear. > + > +When CONFIG_DRM_AMD_DC is enabled, DC will be initialized by default for > +supported ASICs. To force disable, set `amdgpu.dc=0` on kernel command line. > +Likewise, to force enable on unsupported ASICs, set `amdgpu.dc=1`. > + > +To determine if DC is loaded, search dmesg for the following entry: > + > +.. toctree:: > + > + amdgpu-dm.rst > + amdgpu-dc-debug.rst > + > +``Display Core initialized with `` > diff --git a/Documentation/gpu/amdgpu-dc/amdgpu-dm.rst b/Documentation/gpu/amdgpu-dc/amdgpu-dm.rst > new file mode 100644 > index 000000000000..7ce31f89d9a0 > --- /dev/null > +++ b/Documentation/gpu/amdgpu-dc/amdgpu-dm.rst > @@ -0,0 +1,42 @@ > +====================== > +AMDgpu Display Manager > +====================== > + > +.. contents:: Table of Contents > + :depth: 3 > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > + :doc: overview > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h > + :internal: > + > +Lifecycle > +========= > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > + :doc: DM Lifecycle > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > + :functions: dm_hw_init dm_hw_fini > + > +Interrupts > +========== > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c > + :doc: overview > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c > + :internal: > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > + :functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq > + > +Atomic Implementation > +===================== > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > + :doc: atomic > + > +.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c > + :functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail > diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst > index b4a0ed3ca961..dffe52d837cd 100644 > --- a/Documentation/gpu/drivers.rst > +++ b/Documentation/gpu/drivers.rst > @@ -5,7 +5,7 @@ GPU Driver Documentation > .. toctree:: > > amdgpu > - amdgpu-dc > + amdgpu-dc/amdgpu-dc > i915 > mcde > meson