[edk2-devel] [Patch V3 1/9] MdeModulePkg: Add Universal Payload general defination header file

[Wu, Hao A]

> -----Original Message-----
> From: Liu, Zhiguang <zhiguang.liu at intel.com>
> Sent: Friday, June 4, 2021 5:42 PM
> To: devel at edk2.groups.io
> Cc: Kinney, Michael D <michael.d.kinney at intel.com>; Liming Gao
> <gaoliming at byosoft.com.cn>; Wang, Jian J <jian.j.wang at intel.com>; Wu, Hao
> A <hao.a.wu at intel.com>
> Subject: [Patch V3 1/9] MdeModulePkg: Add Universal Payload general
> defination header file


s/defination/definition
(multiple occurrences in commit message and source codes)


> 
> V1:
> Add Universal Payload general defination header file according to
> Universal Payload’s documentation


Looks like "’" is a non-ascii character, please help to remove it.
Also, please help to add the documentation link in this commit message. Thanks.


> V2:
> Add a macro funtion to check the Revision


funtion -> function


> 
> Cc: Michael D Kinney <michael.d.kinney at intel.com>
> Cc: Liming Gao <gaoliming at byosoft.com.cn>
> Cc: Jian J Wang <jian.j.wang at intel.com>
> Cc: Hao A Wu <hao.a.wu at intel.com>
> 
> Signed-off-by: Zhiguang Liu <zhiguang.liu at intel.com>
> ---
>  MdeModulePkg/Include/UniversalPayload/UniversalPayload.h | 33
> +++++++++++++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
> 
> diff --git a/MdeModulePkg/Include/UniversalPayload/UniversalPayload.h
> b/MdeModulePkg/Include/UniversalPayload/UniversalPayload.h
> new file mode 100644
> index 0000000000..627b9e880e
> --- /dev/null
> +++ b/MdeModulePkg/Include/UniversalPayload/UniversalPayload.h
> @@ -0,0 +1,33 @@
> +/** @file
> 
> +  Universal Payload general definations.
> 
> +
> 
> +Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
> 
> +SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +


Could you help to add the specification reference information in the header file description comment?
You may refer to below file for an example:
MdePkg\Include\IndustryStandard\IpmiFruInformationStorage.h


With these handled:
Reviewed-by: Hao A Wu <hao.a.wu at intel.com>

Best Regards,
Hao Wu


> 
> +**/
> 
> +
> 
> +#ifndef __UNIVERSAL_PAYLOAD_H__
> 
> +#define __UNIVERSAL_PAYLOAD_H__
> 
> +
> 
> +#pragma pack(1)
> 
> +
> 
> +typedef struct {
> 
> +  UINT8                Revision;
> 
> +  UINT8                Reserved;
> 
> +  UINT16               Length;
> 
> +} PLD_GENERIC_HEADER;
> 
> +
> 
> +#pragma pack()
> 
> +
> 
> +/**
> 
> +  Returns the size of a structure of known type, up through and including a
> specified field.
> 
> +
> 
> +  @param   TYPE     The name of the data structure that contains the field
> specified by Field.
> 
> +  @param   Field    The name of the field in the data structure.
> 
> +
> 
> +  @return  size, in bytes.
> 
> +
> 
> +**/
> 
> +#define PLD_SIZEOF_THROUGH_FIELD(TYPE, Field) (OFFSET_OF(TYPE, Field) +
> sizeof (((TYPE *) 0)->Field))
> 
> +
> 
> +#endif // __UNIVERSAL_PAYLOAD_H__
> 
> --
> 2.30.0.windows.2



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#76180): https://edk2.groups.io/g/devel/message/76180
Mute This Topic: https://groups.io/mt/83304942/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-