From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=66.187.233.73; helo=mx1.redhat.com; envelope-from=lersek@redhat.com; receiver=edk2-devel@lists.01.org Received: from mx1.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id A683C2251213A for ; Fri, 20 Apr 2018 07:56:02 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 9048B40704A9; Fri, 20 Apr 2018 14:56:01 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-120-11.rdu2.redhat.com [10.10.120.11]) by smtp.corp.redhat.com (Postfix) with ESMTP id B0FCF215CDA7; Fri, 20 Apr 2018 14:56:00 +0000 (UTC) From: Laszlo Ersek To: edk2-devel@lists.01.org Cc: Ruiyu Ni , Eric Dong , Star Zeng References: <20180417093038.22093-1-lersek@redhat.com> Message-ID: Date: Fri, 20 Apr 2018 16:55:54 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.7.0 MIME-Version: 1.0 In-Reply-To: <20180417093038.22093-1-lersek@redhat.com> X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.7]); Fri, 20 Apr 2018 14:56:01 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.7]); Fri, 20 Apr 2018 14:56:01 +0000 (UTC) for IP:'10.11.54.6' DOMAIN:'int-mx06.intmail.prod.int.rdu2.redhat.com' HELO:'smtp.corp.redhat.com' FROM:'lersek@redhat.com' RCPT:'' Subject: Re: [PATCH] MdeModulePkg/UefiBootManagerLib: fix AddLoadOptionVariable docs/prototype X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 20 Apr 2018 14:56:02 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Ping -- can I get a review for this please; it's a trivial patch. Thanks Laszlo On 04/17/18 11:30, Laszlo Ersek wrote: > Clean up the leading comment and the prototype of > EfiBootManagerAddLoadOptionVariable(): > > - the function may modify Option on output, annotate the parameter with > OUT and update the documentation; > > - "@retval EFI_STATUS" and "@retval Others" are not idiomatic > documentation, use @return instead; > > - sync comment and prototype between lib instance and lib class header. > > Cc: Eric Dong > Cc: Ruiyu Ni > Cc: Star Zeng > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Laszlo Ersek > --- > > Notes: > Repo: https://github.com/lersek/edk2.git > Branch: add_load_opt_inout > > MdeModulePkg/Include/Library/UefiBootManagerLib.h | 26 +++++++++++++++------- > .../Library/UefiBootManagerLib/BmLoadOption.c | 12 ++++++---- > 2 files changed, 26 insertions(+), 12 deletions(-) > > diff --git a/MdeModulePkg/Include/Library/UefiBootManagerLib.h b/MdeModulePkg/Include/Library/UefiBootManagerLib.h > index 97ac1f233ce9..1d862a4b2684 100644 > --- a/MdeModulePkg/Include/Library/UefiBootManagerLib.h > +++ b/MdeModulePkg/Include/Library/UefiBootManagerLib.h > @@ -176,20 +176,30 @@ EfiBootManagerLoadOptionToVariable ( > ); > > /** > - This function will update the Boot####/Driver####/SysPrep#### and the > - BootOrder/DriverOrder/SysPrepOrder to add a new load option. > + This function will register the new Boot####, Driver#### or SysPrep#### option. > + After the *#### is updated, the *Order will also be updated. > > - @param Option Pointer to load option to add. > - @param Position Position of the new load option to put in the BootOrder/DriverOrder/SysPrepOrder. > + @param Option Pointer to load option to add. If on input > + Option->OptionNumber is LoadOptionNumberUnassigned, > + then on output Option->OptionNumber is updated to > + the number of the new Boot####, > + Driver#### or SysPrep#### option. > + @param Position Position of the new load option to put in the ****Order variable. > + > + @retval EFI_SUCCESS The *#### have been successfully registered. > + @retval EFI_INVALID_PARAMETER The option number exceeds 0xFFFF. > + @retval EFI_ALREADY_STARTED The option number of Option is being used already. > + Note: this API only adds new load option, no replacement support. > + @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used when the > + option number specified in the Option is LoadOptionNumberUnassigned. > + @return Status codes of gRT->SetVariable (). > > - @retval EFI_SUCCESS The load option has been successfully added. > - @retval Others Error status returned by RT->SetVariable. > **/ > EFI_STATUS > EFIAPI > EfiBootManagerAddLoadOptionVariable ( > - IN EFI_BOOT_MANAGER_LOAD_OPTION *Option, > - IN UINTN Position > + IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option, > + IN UINTN Position > ); > > /** > diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c > index 32918caf324c..f88f8e02451c 100644 > --- a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c > +++ b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c > @@ -329,7 +329,11 @@ BmAddOptionNumberToOrderVariable ( > This function will register the new Boot####, Driver#### or SysPrep#### option. > After the *#### is updated, the *Order will also be updated. > > - @param Option Pointer to load option to add. > + @param Option Pointer to load option to add. If on input > + Option->OptionNumber is LoadOptionNumberUnassigned, > + then on output Option->OptionNumber is updated to > + the number of the new Boot####, > + Driver#### or SysPrep#### option. > @param Position Position of the new load option to put in the ****Order variable. > > @retval EFI_SUCCESS The *#### have been successfully registered. > @@ -338,14 +342,14 @@ BmAddOptionNumberToOrderVariable ( > Note: this API only adds new load option, no replacement support. > @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used when the > option number specified in the Option is LoadOptionNumberUnassigned. > - @retval EFI_STATUS Return the status of gRT->SetVariable (). > + @return Status codes of gRT->SetVariable (). > > **/ > EFI_STATUS > EFIAPI > EfiBootManagerAddLoadOptionVariable ( > - IN EFI_BOOT_MANAGER_LOAD_OPTION *Option, > - IN UINTN Position > + IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option, > + IN UINTN Position > ) > { > EFI_STATUS Status; >