Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <22850f02-5b5f-ab2d-dda5-47cd6b880708@intel.com>
Date:   Mon, 31 Jul 2023 14:33:17 -0700
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Thunderbird/102.13.0
Subject: Re: [PATCH] drm/i915/huc: fix intel_huc.c doc bulleted list format
 error
Content-Language: en-US
To:     David Reaver <me@davidreaver.com>,
        Jonathan Corbet <corbet@lwn.net>,
        "David Airlie" <airlied@gmail.com>, Daniel Vetter <daniel@ffwll.ch>
CC:     John Harrison <John.C.Harrison@Intel.com>,
        Alan Previn <alan.previn.teres.alexis@intel.com>,
        <linux-doc@vger.kernel.org>, <intel-gfx@lists.freedesktop.org>,
        <dri-devel@lists.freedesktop.org>, <linux-kernel@vger.kernel.org>
References: <20230727025400.372965-1-me@davidreaver.com>
From:   "Ceraolo Spurio, Daniele" <daniele.ceraolospurio@intel.com>
In-Reply-To: <20230727025400.372965-1-me@davidreaver.com>
Content-Type: text/plain; charset="UTF-8"; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?QVNNL0xyWnhGR05GbTVXTkNLaG9SU0ZKNDVra0l5ZHgrTTV0QkhKVnlHdEpS?=
 =?utf-8?B?MGVlS3BkUWhuVWFGNElYTFE1Zk5SeFB6MjdpYW9lK0pDU3FVemlDVzdFREdz?=
 =?utf-8?B?RW1ZbHJpdlFyOTRhUGxtSGRnc2krQ0hlbit5cU15L3VpTVdZcFZKNHNLKytY?=
 =?utf-8?B?SzF3STNRYWJScmJHUUFOQ1hPSnp5dDNCWWlDWmFWdXVUanJUN1hQeWM5MDJx?=
 =?utf-8?B?YVVHWHVkRDl0MXpIbzZIT3NSdE9NcjV1TzFoU09tMkVuRVEzUEtvanVvd3Vh?=
 =?utf-8?B?bzYrc1NGU1hVUjlJYWRjSWJxMnpFMWJ4bDExV3J3UG9pdGd1aFNseTBDaXZ4?=
 =?utf-8?B?bkg5ZTFOdFBrekhCWEdoMWxYQjVGelZHdXlMVVZGdFNoTEw5S1Q3SmpPa3Zw?=
 =?utf-8?B?cDlWbklwOVVQQS9paUluZWFBV29BNy9YcEMrdHJpSFJXSnEvWHI2blZxUkVT?=
 =?utf-8?B?MllMMEdiL2tRWHlRSzEvTjNSSTJjRU5JcDJORTBvWmVqU1FXbzE2YUZqZDJN?=
 =?utf-8?B?NVlJNDR0RnV3c2N5cjRIbDliRXJ5emRDbDh2eGJQMTRtRmNadDREQnVwOWpT?=
 =?utf-8?B?QW5TVE5BSW9SckVBYnhoY052ZnN0OFBmcHltb1U1YlJLSTl3WmtDZjE3Q1ZY?=
 =?utf-8?B?S3lsZU9LeTlTMU5ocmU3c1JiRjd0T3JVRVlNZEpadDg0d3I2LzJLU00yYVN1?=
 =?utf-8?B?SWpHUlZENm03eGtUYmNyYldSa3lSOFBURWZDbUgwZ0I5YlQxcFVrTUEyb3lx?=
 =?utf-8?B?V1Y3NzViVTM3MUdZVHlIb29UalZlRUlpcmhWWXNlUXJTM2FJUjdIUWgxbW01?=
 =?utf-8?B?WnUvdlVoVGVkZkFPZlo2Y0s0VHduS0RLQXNyRnNxN1k4cUlaSUhxeElMcXBB?=
 =?utf-8?B?NG4xc08zbVNCaUU1bXU0akNOd1dKNHlaZGh4ZzQrdXVmRGtkbmNuaTBVVTMr?=
 =?utf-8?B?eExnRWxDWDlIajhqL0VHckF3RVphb3J5N1RLYytEUkpvTmV0YmZTcmI0TVZX?=
 =?utf-8?B?T1RhUWc4bVFjMWEwdnErUmtqbjV2MVQxT01WbzhqcjJhOUFtWHJ6YzVSZGcw?=
 =?utf-8?B?amlocDdOVGFiMVFEM3dZU21saWpreEZLd05yZ2ZnSjJVWFp3WWRkZ0RDdFp1?=
 =?utf-8?B?dWs4QTlVOXhad2duakVSS2haWkZJZ1MyUTFqanNtMTdsZjRWRXFGMm0vRUNl?=
 =?utf-8?B?T2pVOWlTdy95Q0tqN0d2eFl2WG1INkpPMjVvVHRKdEZaNG91cUhMR3VaR285?=
 =?utf-8?B?eVNJN0FiMCtNTjNZU01vaUJOc2xaeERlVFBNQ2t0VzNINmZ2dTdkSzQydVBn?=
 =?utf-8?B?ZFllWFRPak1yRVU0Y0xGL0s5S28zMGlHMklDd281L2ZORUJlQnZ1QzBsS3hp?=
 =?utf-8?B?NzVEQjZzVzVRUUN3ZHB3eDN0c241Z3FUZFdhYTZtZXRPSmtwa2gxNFRvWW5W?=
 =?utf-8?B?dncwa0lTbGRWTmkvMkVaek1UNUdtZWU2QURPdW5xMS9YS05VNnd5aHR0K3hr?=
 =?utf-8?B?WFJYWjg2LzJlRGdFM1MrdU16Mi9rOGxaNyt0UTRGZlhscVRCaWJZZEVEUThR?=
 =?utf-8?B?V3JYa2ltTHE4NWNhaVFnbitPaWk2SUxOcUxXNHNoU2d1YWJWWGhrSElET0Jn?=
 =?utf-8?B?T3NybCtuVENhQTVCaENFZWJmdGhOU0NWZ0grUVFBbU95MDRQUldnM3h6dFlF?=
 =?utf-8?B?dDIrRzZqTGVRaUk0NUdvTEtGc2UwTXkvdENsZjJkYnpHd0lKekZYZndMNHg1?=
 =?utf-8?B?UWw3UFFndjFjU3RxODZmSTVuMlE3QUdHeFBUaEhucUg5dklONWlnMWE1S2Fi?=
 =?utf-8?B?YU1VeDY0V1Z4WXNSOUZUMFNEZVd4R2xMVW5SaWpaS001L21TSmcwUk5PdzJp?=
 =?utf-8?B?VEI5NGk0ck5obmg4TjBGMmdRWXdVWjFySUlsbHUyTkI0ZmRpTkxnN2hIWkRN?=
 =?utf-8?B?OXozL2twR0R4ZjhOM0JSMm1lWDZpNngwSXhXOUNIZEIrd3IvNVM2b3FGV05n?=
 =?utf-8?B?V0MzSEozUERkRG50M1FXMmRydUU5Umh3UkNiTWtzUSs2ZlF4Qm1vUU83bWdJ?=
 =?utf-8?B?aXlhcDRqeEtmdUlGb3J0MENZUEt5QVptUGRZL21ybUEwZ1FwWXdReW9BVG56?=
 =?utf-8?B?N2txQTcwcUd1aGZWUUQzUXZMR2tJOUh4djFLZDg3ZTA3UlF6YVI0UmJMcTdn?=
 =?utf-8?B?THc9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 91c9705a-4d88-47eb-6b37-08db920dc1ea
X-MS-Exchange-CrossTenant-AuthSource: PH7PR11MB7605.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Jul 2023 21:33:19.0235
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: H/GmbOC1V7x2oYhYz8oNDcswwaufSeVPsbYgNX7vTwAV5NBKq6EHmxNlxUEqTcX723lRNWvZL8m/4bL1F0YWfUMFq6wpaH36ZBILjpH3YNA=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR11MB8012
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-4.5 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,
        RCVD_IN_DNSWL_MED,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,
        SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no
        version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


On 7/26/2023 7:54 PM, David Reaver wrote:
> Fix the following make htmldocs errors/warnings:
>
> ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:29: ERROR: Unexpected indentation.
> ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:30: WARNING: Block quote ends without a blank line; unexpected unindent.
> ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:35: WARNING: Bullet list ends without a blank line; unexpected unindent.
>
> This output is a bit misleading. The real issue here is we need a blank
> line before and after the bulleted list.
>
> Link: https://www.kernel.org/doc/html/latest/gpu/i915.html#huc
> Link: https://lore.kernel.org/dri-devel/20230530152958.1384061-1-daniele.ceraolospurio@intel.com/
>
> Signed-off-by: David Reaver <me@davidreaver.com>

Reviewed-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>

and pushed to drm-intel-gt-next.

thanks for the fix,
Daniele

> ---
>   drivers/gpu/drm/i915/gt/uc/intel_huc.c | 2 ++
>   1 file changed, 2 insertions(+)
>
> diff --git a/drivers/gpu/drm/i915/gt/uc/intel_huc.c b/drivers/gpu/drm/i915/gt/uc/intel_huc.c
> index ddd146265beb..fa70defcb5b2 100644
> --- a/drivers/gpu/drm/i915/gt/uc/intel_huc.c
> +++ b/drivers/gpu/drm/i915/gt/uc/intel_huc.c
> @@ -26,6 +26,7 @@
>    * The kernel driver is only responsible for loading the HuC firmware and
>    * triggering its security authentication. This is done differently depending
>    * on the platform:
> + *
>    * - older platforms (from Gen9 to most Gen12s): the load is performed via DMA
>    *   and the authentication via GuC
>    * - DG2: load and authentication are both performed via GSC.
> @@ -33,6 +34,7 @@
>    *   not-DG2 older platforms), while the authentication is done in 2-steps,
>    *   a first auth for clear-media workloads via GuC and a second one for all
>    *   workloads via GSC.
> + *
>    * On platforms where the GuC does the authentication, to correctly do so the
>    * HuC binary must be loaded before the GuC one.
>    * Loading the HuC is optional; however, not using the HuC might negatively