public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Zeng, Star" <star.zeng@intel.com>
To: Marvin H?user <Marvin.Haeuser@outlook.com>,
	"edk2-devel@lists.01.org" <edk2-devel@lists.01.org>
Cc: "Zeng, Star" <star.zeng@intel.com>
Subject: Re: [UEFI PI 1.6/EDK2] Missing decorators for EFI_PEI_GET_VARIABLE2.
Date: Tue, 25 Jul 2017 08:24:47 +0000	[thread overview]
Message-ID: <0C09AFA07DD0434D9E2A0C6AEB0483103B8F5988@shsmsx102.ccr.corp.intel.com> (raw)
In-Reply-To: <AM4PR06MB1491EE1E0FEAD1B7B170573B80BB0@AM4PR06MB1491.eurprd06.prod.outlook.com>

Marvin,

I think you are right about the statement of decorator 'OPTIONAL', you can submit PI ECR, then it can be aligned with UEFI EFI_GET_VARIABLE.
typedef
EFI_STATUS
(EFIAPI *EFI_GET_VARIABLE)(
  IN     CHAR16                      *VariableName,
  IN     EFI_GUID                    *VendorGuid,
  OUT    UINT32                      *Attributes,    OPTIONAL
  IN OUT UINTN                       *DataSize,
  OUT    VOID                        *Data           OPTIONAL
  );

And since the passed-in state of the referenced data is not used by the routine, I don't think decorator 'IN' should be added.



Thanks,
Star
-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Marvin H?user
Sent: Tuesday, July 25, 2017 12:42 AM
To: edk2-devel@lists.01.org
Subject: [edk2] [UEFI PI 1.6/EDK2] Missing decorators for EFI_PEI_GET_VARIABLE2.

Dear developers,

I noticed that EFI_PEI_GET_VARIABLE2 is lacking decorators in both the UEFI PI 1.6 specification and the EDK2 codebase. The parameter description for 'Attributes' starts with 'If non-NULL', hence it may be NULL, which is not reflected in the function prototype with the decorator 'OPTIONAL'. Furthermore, as the possibility of it being NULL is not coupled to the values of the other parameters, 'IN' should be added as well.

Can someone please forward this to the right working group?

Thanks and best regards,
Marvin.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel


  reply	other threads:[~2017-07-25  8:22 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-24 16:41 [UEFI PI 1.6/EDK2] Missing decorators for EFI_PEI_GET_VARIABLE2 Marvin H?user
2017-07-25  8:24 ` Zeng, Star [this message]
2017-07-25  8:57   ` Marvin H?user
2017-07-25  9:09     ` Zeng, Star
2017-07-25  9:42       ` Marvin H?user
2017-07-25  9:46         ` Zeng, Star
2017-07-25 13:14           ` Zeng, Star
2017-07-25 13:24             ` Marvin H?user
2017-07-25 13:30               ` Zeng, Star

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0C09AFA07DD0434D9E2A0C6AEB0483103B8F5988@shsmsx102.ccr.corp.intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox