Re: [UEFI PI 1.6/EDK2] Missing decorators for EFI_PEI_GET_VARIABLE2.

[Marvin H?user <Marvin.Haeuser@outlook.com>]

Sorry, I remembered 'IN OUT' incorrectly then, you are correct. Only 'OPTIONAL' is lacking.
Would be very kind of you if you could help submitting the ECR, I do not have an active account at this point.

Thanks,
Marvin.

> -----Original Message-----
> From: Zeng, Star [mailto:star.zeng@intel.com]
> Sent: Tuesday, July 25, 2017 11:09 AM
> To: Marvin H?user <Marvin.Haeuser@outlook.com>; 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.
> 
> As I know submitting ECR needs log in as a member at
> http://www.uefi.org/memberslogin, I am not sure the whole process.
> If needed, I can help to submit the ECR.
> 
> According to EDK2 coding style doc at
> https://edk2-docs.gitbooks.io/edk-ii-c-coding-standards-
> specification/content/5_source_files/57_c_programming.html#table-9-
> parameter-modifiers
> IN OUT	Passed by reference, and the passed-in referenced data is consumed
> and then modified by the routine.
> 
> But the code will not consume the pass in referenced data. Personally, I don't
> think just checking NULL pointer should be marked as 'IN'
> 
> 
> Thanks,
> Star
> -----Original Message-----
> From: Marvin H?user [mailto:Marvin.Haeuser@outlook.com]
> Sent: Tuesday, July 25, 2017 4:58 PM
> To: 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.
> 
> Hey Star,
> 
> Thanks for your comment! Sorry, I never submited such a report, could you
> please point me in the right direction? The only way of contact I found on the
> site of the UEFI Forum were Administration and Press, both don't sound like
> the right place to post to. Or Is 'Administration' specification administration
> rather than forum administration?
> 
> Regarding 'IN': Correct me if I'm wrong, but in contrast to just 'OUT'
> parameters, which are 'blindly' written to, 'Attributes' must be checked
> against NULL first before attempting a dereference. Is this not the correct
> usage of IN? Is IN only used, when the pointer's destination is read?
> 
> Thanks again!
> 
> Regards,
> Marvin.
> 
> > -----Original Message-----
> > From: Zeng, Star [mailto:star.zeng@intel.com]
> > Sent: Tuesday, July 25, 2017 10:25 AM
> > To: Marvin H?user <Marvin.Haeuser@outlook.com>; 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.
> >
> > 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