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 phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 37B41C433FE for ; Wed, 5 Oct 2022 07:05:14 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id C164B84E3B; Wed, 5 Oct 2022 09:05:11 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="qWFJZuDm"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id CCECA8317B; Wed, 5 Oct 2022 09:05:09 +0200 (CEST) Received: from mail-ej1-x62e.google.com (mail-ej1-x62e.google.com [IPv6:2a00:1450:4864:20::62e]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id CEE7284E3B for ; Wed, 5 Oct 2022 09:05:04 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=ilias.apalodimas@linaro.org Received: by mail-ej1-x62e.google.com with SMTP id z23so16745358ejw.12 for ; Wed, 05 Oct 2022 00:05:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date; bh=DgCc+qGnEyff5ONmEwWIxW9pmYX9NxF8I6JmiRIV1ZQ=; b=qWFJZuDmKM+mbpt1rEafj5cKRnzj8TtEDBw8gVl7y+mUNJZGLE6GxvwrlBQsUXapSr YOFHZeFNNNAaSYmqjSeFVM2rjDmnsZsQEbeaoUO9Y40Gson7Y0KC057oN1ie18niUPl9 q4KxdQZO3efojlzKiyXb5rsZTrH5GnxH0RjQrrZjphB8YzeL0yfKijjQa4F1eUmCO3Km 7pDm0aMI9IG+qqz/+Dxga3xolXEH3i+1JSp1PHKtlKVT8P4jWeUtuYNM6HzUUqVaTKYy mo7LygRy2GR6zXGQ5SvilvFi/iAAhMiIu4diZQENXjN3jC4zTbVKH8+dIgY6svznVc2b Q5TA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date; bh=DgCc+qGnEyff5ONmEwWIxW9pmYX9NxF8I6JmiRIV1ZQ=; b=UqyabNaaiSHNhqo05YN7LmjBOoAfdjeP9rZjBUhDOIUZDZPXuDvI9+IOkVSrlyjSGJ 0KdPCpTXhdpGeBUhnWiGNadL93DxsC85YiZz3Woew2NuSccn2eXQwxYppdBVzQW6j3X1 RiHO5537dqpoBu0lDBv6cnw1pPNZHMSXiZc8mgveMdTtlmLMxeuG1Q/Gc+nlooMVBu2G TwmF5LtIlmWaSo5qora9yM0xQQ0t+2Ze06bmt47k6AS4g+3ZuW+aYRmNdD7uiki+QPr4 zQfOH+YC4zdb7qqlPF3xCzjlUdaRR/UvbYgqu9nKitTr5GLCutXudI5G3TQFr7v6aUgl gGTA== X-Gm-Message-State: ACrzQf3HWNR1XWrjr74GJJk0PYOQDE4l8mFlf2YtOI2iTNBg5ZY7Np0p J9KZdnv/I2xAA3nD/JbdebtV4w== X-Google-Smtp-Source: AMsMyM5JyXlFBHVIU2gTcN92rSMalMW/Ois5ZaQHyyl/41VG4vKOmEbW70Iu/g9HjxyPdlsAO/3/qg== X-Received: by 2002:a17:906:db07:b0:77b:82cf:54af with SMTP id xj7-20020a170906db0700b0077b82cf54afmr22995252ejb.666.1664953504390; Wed, 05 Oct 2022 00:05:04 -0700 (PDT) Received: from hades (ppp046103015185.access.hol.gr. [46.103.15.185]) by smtp.gmail.com with ESMTPSA id 20-20020a170906329400b0078bfff89de4sm4012485ejw.58.2022.10.05.00.05.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 05 Oct 2022 00:05:04 -0700 (PDT) Date: Wed, 5 Oct 2022 10:05:01 +0300 From: Ilias Apalodimas To: Heinrich Schuchardt Cc: u-boot@lists.denx.de Subject: Re: [PATCH 1/1] doc: documentation of EFI driver binding protocol Message-ID: References: <20221004163034.154292-1-heinrich.schuchardt@canonical.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20221004163034.154292-1-heinrich.schuchardt@canonical.com> X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean Hi Heinrich, On Tue, Oct 04, 2022 at 06:30:34PM +0200, Heinrich Schuchardt wrote: > * Convert code comments in include/efi_driver.h to Sphinx style. > * Add include/efi_driver.h to the HTML documentation. > > Signed-off-by: Heinrich Schuchardt > --- > doc/api/efi.rst | 6 ++++++ > include/efi_driver.h | 19 ++++++++++++------- > 2 files changed, 18 insertions(+), 7 deletions(-) > > diff --git a/doc/api/efi.rst b/doc/api/efi.rst > index 2b96783828..43d6f936fb 100644 > --- a/doc/api/efi.rst > +++ b/doc/api/efi.rst > @@ -172,6 +172,12 @@ Firmware management protocol > .. kernel-doc:: lib/efi_loader/efi_firmware.c > :internal: > > +Driver binding protocol > +~~~~~~~~~~~~~~~~~~~~~~~ > + > +.. kernel-doc:: include/efi_driver.h > + :internal: > + > Unit testing > ------------ > > diff --git a/include/efi_driver.h b/include/efi_driver.h > index dc0c1c7ac0..de38abe83b 100644 > --- a/include/efi_driver.h > +++ b/include/efi_driver.h > @@ -1,6 +1,6 @@ > /* SPDX-License-Identifier: GPL-2.0+ */ > /* > - * EFI application loader > + * Internal structures for the EFI driver binding protocol > * > * Copyright (c) 2017 Heinrich Schuchardt > */ > @@ -10,16 +10,16 @@ > > #include > > -/* > - * Operations supported by an EFI driver with respect to the EFI uclass > +/** > + * struct efi_driver_ops - operations support by an EFI driver > * > - * @protocol The GUID of the protocol which is consumed by the > + * @protocol: The GUID of the protocol which is consumed by the > * driver. This GUID is used by the EFI uclass in the > * supports() and start() methods of the > * EFI_DRIVER_BINDING_PROTOCOL. > - * @child_protocol Protocol supported by the child handles generated by > + * @child_protocol: Protocol supported by the child handles generated by > * the EFI driver. > - * @bind Function called by the EFI uclass to attach the > + * @bind: Function called by the EFI uclass to attach the > * driver to EFI driver to a handle. > */ > struct efi_driver_ops { > @@ -28,8 +28,13 @@ struct efi_driver_ops { > efi_status_t (*bind)(efi_handle_t handle, void *interface); > }; > > -/* > +/** > + * struct efi_driver_binding_extended_protocol - extended driver binding protocol > + * > * This structure adds internal fields to the driver binding protocol. > + * > + * @bp: driver binding protocol > + * @ops: operations supported by the driver > */ > struct efi_driver_binding_extended_protocol { > struct efi_driver_binding_protocol bp; > -- > 2.37.2 > Reviewed-by: Ilias Apalodimas