MdePkg/Include: EFI Redfish Discover protocol

Move GUID definition of EFI Redfish Discover protocol
to under MdePkg. With this we don't have dependency of
RedfishPkg in ShellPkg.

Signed-off-by: Abner Chang <abner.chang@hpe.com>

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Nickle Wang <nickle.wang@hpe.com>
Cc: Peter O'Hanley <peter.ohanley@hpe.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
This commit is contained in:
Abner Chang 2020-11-03 11:54:05 +08:00 committed by mergify[bot]
parent 4bf2a5b045
commit fe66288873
3 changed files with 36 additions and 42 deletions

View File

@ -1,20 +1,19 @@
/** @file /** @file
This file defines the EFI Redfish Discover Protocol interface. This file defines the EFI Redfish Discover Protocol interface.
(C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR> (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent SPDX-License-Identifier: BSD-2-Clause-Patent
@par Revision Reference:
- Some corrections and revises are added to UEFI Specification 2.9.
- This Protocol is introduced in UEFI Specification 2.8.
**/ **/
#ifndef EFI_REDFISH_DISCOVER_PROTOCOL_H_ #ifndef EFI_REDFISH_DISCOVER_PROTOCOL_H_
#define EFI_REDFISH_DISCOVER_PROTOCOL_H_ #define EFI_REDFISH_DISCOVER_PROTOCOL_H_
#include <IndustryStandard/Http11.h>
#include <Protocol/Http.h>
#include <Protocol/RestEx.h>
#include <Uefi.h>
// //
// GUID definitions // GUID definitions
// //
@ -40,12 +39,9 @@ typedef UINT32 EFI_REDFISH_DISCOVER_FLAG;
///< 3 to 15. The corresponding duration is 8 to 2^15 seconds. ///< 3 to 15. The corresponding duration is 8 to 2^15 seconds.
///< Duration is only valid when EFI_REDFISH_DISCOVER_KEEP_ALIVE ///< Duration is only valid when EFI_REDFISH_DISCOVER_KEEP_ALIVE
///< is set to 1. ///< is set to 1.
#define EFI_REDFISH_DISCOVER_DURATION_BIT_POS 8
typedef struct _EFI_REDFISH_DISCOVER_PROTOCOL EFI_REDFISH_DISCOVER_PROTOCOL; typedef struct _EFI_REDFISH_DISCOVER_PROTOCOL EFI_REDFISH_DISCOVER_PROTOCOL;
typedef struct _EFI_REDFISH_DISCOVERED_INFORMATION EFI_REDFISH_DISCOVERED_INFORMATION;
typedef struct _EFI_REDFISH_DISCOVERED_INFORMATION { typedef struct {
EFI_HANDLE RedfishRestExHandle; ///< REST EX EFI handle associated with this Redfish service. EFI_HANDLE RedfishRestExHandle; ///< REST EX EFI handle associated with this Redfish service.
BOOLEAN IsUdp6; ///< Indicates it's IP versino 6. BOOLEAN IsUdp6; ///< Indicates it's IP versino 6.
EFI_IP_ADDRESS RedfishHostIpAddress; ///< IP address of Redfish service. EFI_IP_ADDRESS RedfishHostIpAddress; ///< IP address of Redfish service.
@ -53,11 +49,11 @@ typedef struct _EFI_REDFISH_DISCOVERED_INFORMATION {
CHAR16 *Location; ///< Redfish service location. CHAR16 *Location; ///< Redfish service location.
CHAR16 *Uuid; ///< Redfish service UUID. CHAR16 *Uuid; ///< Redfish service UUID.
CHAR16 *Os; ///< Redfish service OS. CHAR16 *Os; ///< Redfish service OS.
CHAR16 *OSVersion; ///< Redfish service OS version. CHAR16 *OsVersion; ///< Redfish service OS version.
CHAR16 *Product; ///< Redfish service product name. CHAR16 *Product; ///< Redfish service product name.
CHAR16 *ProductVer; ///< Redfish service product version. CHAR16 *ProductVer; ///< Redfish service product version.
BOOLEAN UseHttps; ///< Using HTTPS. BOOLEAN UseHttps; ///< Using HTTPS.
}; } EFI_REDFISH_DISCOVERED_INFORMATION;
typedef struct { typedef struct {
EFI_STATUS Status; ///< Status of Redfish service discovery. EFI_STATUS Status; ///< Status of Redfish service discovery.
@ -75,7 +71,7 @@ typedef struct {
EFI_IP_ADDRESS SubnetId; ///< Subnet ID. EFI_IP_ADDRESS SubnetId; ///< Subnet ID.
UINT8 SubnetPrefixLength; ///< Subnet prefix-length for IPv4 and IPv6. UINT8 SubnetPrefixLength; ///< Subnet prefix-length for IPv4 and IPv6.
UINT16 VlanId; ///< VLAN ID. UINT16 VlanId; ///< VLAN ID.
} EFI_REDFISH_DISCOVER_NETWORK_INSTANCE; } EFI_REDFISH_DISCOVER_NETWORK_INTERFACE;
typedef struct { typedef struct {
UINT32 Signature; ///< Token signature. UINT32 Signature; ///< Token signature.
@ -115,7 +111,7 @@ EFI_STATUS
IN EFI_REDFISH_DISCOVER_PROTOCOL *This, IN EFI_REDFISH_DISCOVER_PROTOCOL *This,
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
OUT UINTN *NumberOfNetworkInterfaces, OUT UINTN *NumberOfNetworkInterfaces,
OUT EFI_REDFISH_DISCOVER_NETWORK_INSTANCE **NetworkInterfaces OUT EFI_REDFISH_DISCOVER_NETWORK_INTERFACE **NetworkInterfaces
); );
/** /**
@ -147,7 +143,7 @@ EFI_STATUS
(EFIAPI *EFI_REDFISH_DISCOVER_ACQUIRE_SERVICE)( (EFIAPI *EFI_REDFISH_DISCOVER_ACQUIRE_SERVICE)(
IN EFI_REDFISH_DISCOVER_PROTOCOL *This, IN EFI_REDFISH_DISCOVER_PROTOCOL *This,
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_REDFISH_DISCOVER_NETWORK_INSTANCE *TargetNetworkInterface, IN EFI_REDFISH_DISCOVER_NETWORK_INTERFACE *TargetNetworkInterface OPTIONAL,
IN EFI_REDFISH_DISCOVER_FLAG Flags, IN EFI_REDFISH_DISCOVER_FLAG Flags,
IN EFI_REDFISH_DISCOVERED_TOKEN *Token IN EFI_REDFISH_DISCOVERED_TOKEN *Token
); );
@ -166,14 +162,14 @@ typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_REDFISH_DISCOVER_ABORT_ACQUIRE)( (EFIAPI *EFI_REDFISH_DISCOVER_ABORT_ACQUIRE)(
IN EFI_REDFISH_DISCOVER_PROTOCOL *This, IN EFI_REDFISH_DISCOVER_PROTOCOL *This,
IN EFI_REDFISH_DISCOVER_NETWORK_INSTANCE *TargetNetworkInterface OPTIONAL IN EFI_REDFISH_DISCOVER_NETWORK_INTERFACE *TargetNetworkInterface OPTIONAL
); );
/** /**
This function releases Redfish services found by RedfishServiceAcquire(). This function releases Redfish services found by RedfishServiceAcquire().
@param[in] This EFI_REDFISH_DISCOVER_PROTOCOL instance. @param[in] This EFI_REDFISH_DISCOVER_PROTOCOL instance.
@param[in] InstanceList The Redfish service to release. @param[in] List The Redfish service to release.
@retval EFI_SUCCESS REST EX instances of discovered Redfish are released. @retval EFI_SUCCESS REST EX instances of discovered Redfish are released.
@retval Others Fail to remove the entry @retval Others Fail to remove the entry
@ -183,17 +179,15 @@ typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_REDFISH_DISCOVER_RELEASE_SERVICE)( (EFIAPI *EFI_REDFISH_DISCOVER_RELEASE_SERVICE)(
IN EFI_REDFISH_DISCOVER_PROTOCOL *This, IN EFI_REDFISH_DISCOVER_PROTOCOL *This,
IN EFI_REDFISH_DISCOVERED_LIST *InstanceList IN EFI_REDFISH_DISCOVERED_LIST *List
); );
typedef struct _EFI_REDFISH_DISCOVER_PROTOCOL { struct _EFI_REDFISH_DISCOVER_PROTOCOL {
EFI_REDFISH_DISCOVER_NETWORK_LIST GetNetworkInterfaceList; EFI_REDFISH_DISCOVER_NETWORK_LIST GetNetworkInterfaceList;
EFI_REDFISH_DISCOVER_ACQUIRE_SERVICE AcquireRedfishService; EFI_REDFISH_DISCOVER_ACQUIRE_SERVICE AcquireRedfishService;
EFI_REDFISH_DISCOVER_ABORT_ACQUIRE AbortAcquireRedfishService; EFI_REDFISH_DISCOVER_ABORT_ACQUIRE AbortAcquireRedfishService;
EFI_REDFISH_DISCOVER_RELEASE_SERVICE ReleaseRedfishService; EFI_REDFISH_DISCOVER_RELEASE_SERVICE ReleaseRedfishService;
} EFI_REDFISH_DISCOVER_PROTOCOL; };
extern EFI_GUID gEfiRestExProtocolGuid;
extern EFI_GUID gEfiRestExServiceBindingProtocolGuid;
extern EFI_GUID gEfiRedfishDiscoverProtocolGuid; extern EFI_GUID gEfiRedfishDiscoverProtocolGuid;
#endif #endif

View File

@ -6,7 +6,7 @@
# #
# Copyright (c) 2007 - 2020, Intel Corporation. All rights reserved.<BR> # Copyright (c) 2007 - 2020, Intel Corporation. All rights reserved.<BR>
# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR> # Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
# (C) Copyright 2016 - 2020 Hewlett Packard Enterprise Development LP<BR> # (C) Copyright 2016 - 2021 Hewlett Packard Enterprise Development LP<BR>
# #
# SPDX-License-Identifier: BSD-2-Clause-Patent # SPDX-License-Identifier: BSD-2-Clause-Patent
# #
@ -1863,6 +1863,9 @@
## Include/Protocol/RestJsonStructure.h ## Include/Protocol/RestJsonStructure.h
gEfiRestJsonStructureProtocolGuid = { 0xa9a048f6, 0x48a0, 0x4714, {0xb7, 0xda, 0xa9, 0xad,0x87, 0xd4, 0xda, 0xc9 }} gEfiRestJsonStructureProtocolGuid = { 0xa9a048f6, 0x48a0, 0x4714, {0xb7, 0xda, 0xa9, 0xad,0x87, 0xd4, 0xda, 0xc9 }}
## Include/Protocol/RedfishDiscover.h
gEfiRedfishDiscoverProtocolGuid = { 0x5db12509, 0x4550, 0x4347, { 0x96, 0xb3, 0x73, 0xc0, 0xff, 0x6e, 0x86, 0x9f }}
# #
# Protocols defined in Shell2.0 # Protocols defined in Shell2.0
# #

View File

@ -67,9 +67,6 @@
RedfishLib|PrivateInclude/Library/RedfishLib.h RedfishLib|PrivateInclude/Library/RedfishLib.h
[Protocols] [Protocols]
## Include/Protocol/RedfishDiscover.h
gEfiRedfishDiscoverProtocolGuid = { 0x5db12509, 0x4550, 0x4347, { 0x96, 0xb3, 0x73, 0xc0, 0xff, 0x6e, 0x86, 0x9f }}
## Include/Protocol/EdkIIRedfishCredential.h ## Include/Protocol/EdkIIRedfishCredential.h
gEdkIIRedfishCredentialProtocolGuid = { 0x8804377, 0xaf7a, 0x4496, { 0x8a, 0x7b, 0x17, 0x59, 0x0, 0xe9, 0xab, 0x46 } } gEdkIIRedfishCredentialProtocolGuid = { 0x8804377, 0xaf7a, 0x4496, { 0x8a, 0x7b, 0x17, 0x59, 0x0, 0xe9, 0xab, 0x46 } }