RedfishPkg/RedfishPkg.dec

   1 ## @file
   2 # Redfish Package
   3 #
   4 # Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   5 # (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
   6 #
   7 # SPDX-License-Identifier: BSD-2-Clause-Patent
   8 ##
   9
  10 [Defines]
  11   DEC_SPECIFICATION = 0x0001001b
  12   PACKAGE_NAME      = RedfishPkg
  13   PACKAGE_GUID      = c432b76e-5232-11e7-9010-005056c00008
  14   PACKAGE_VERSION   = 1.0
  15
  16 [Includes]
  17   Include
  18
  19 [Includes.Common.Private]
  20   PrivateInclude                # Private header files for C RTL.
  21   PrivateInclude/Crt            # Private header files for C RTL.
  22   Library/JsonLib               # Private header files for jansson
  23                                 # configuration files.
  24                                 #  - jansson_config.h
  25                                 #  - jansson_private_config.h
  26                                 # jansson.h refers to above two configuration
  27                                 # files for building platform jansson library.
  28   Library/JsonLib/jansson/src   # For referring to jannson.h
  29
  30 [LibraryClasses]
  31   ##  @libraryclass Platform Redfish Host Interface Library
  32   #   Platform implementation-specific Redfish Host Interface.
  33   RedfishPlatformHostInterfaceLib|Include/Library/RedfishHostInterfaceLib.h
  34
  35   ##  @libraryclass  This library provides UCS2 to UTF8 manipulation
  36   #   functions.
  37   #
  38   Ucs2Utf8Lib|Include/Library/BaseUcs2Utf8Lib.h
  39
  40   ##  @libraryclass Platform Redfish Credential Library
  41   #   Platform implementation-specific Redfish Credential Interface.
  42   RedfishPlatformCredentialLib|Include/Library/RedfishCredentialLib.h
  43
  44   ##  @libraryclass  The helper routines to access REST EX service.
  45   #   This library is only intended to be used by UEFI network stack modules.
  46   RestExLib|Include/Library/RestExLib.h
  47
  48   ##  @libraryclass  Provides the library functions based on third party
  49   #  jansson library to manipulate JSON data structure.
  50   #
  51   JsonLib|Include/Library/JsonLib.h
  52
  53 [LibraryClasses.Common.Private]
  54   ##  @libraryclass  Provides the private C runtime library functions.
  55   #   CRT library is currently used by edk2 JsonLib (open source
  56   #   jansson project) and edk2 RedfishLib (libredfish open source
  57   #   project).
  58   RedfishCrtLib|PrivateInclude/Library/RedfishCrtLib.h
  59
  60 [Protocols]
  61   ## Include/Protocol/RedfishDiscover.h
  62   gEfiRedfishDiscoverProtocolGuid      = { 0x5db12509, 0x4550, 0x4347, { 0x96, 0xb3, 0x73, 0xc0, 0xff, 0x6e, 0x86, 0x9f }}
  63
  64   ## Include/Protocol/EdkIIRedfishCredential.h
  65   gEdkIIRedfishCredentialProtocolGuid = { 0x8804377, 0xaf7a, 0x4496, { 0x8a, 0x7b, 0x17, 0x59, 0x0, 0xe9, 0xab, 0x46 } }
  66
  67   ## Include/Protocol/Edk2RedfishConfigHandler.h
  68   gEdkIIRedfishConfigHandlerProtocolGuid = { 0xbc0fe6bb, 0x2cc9, 0x463e, { 0x90, 0x82, 0xfa, 0x11, 0x76, 0xfc, 0x67, 0xde } }
  69
  70 [Guids]
  71   gEfiRedfishPkgTokenSpaceGuid      = { 0x4fdbccb7, 0xe829, 0x4b4c, { 0x88, 0x87, 0xb2, 0x3f, 0xd7, 0x25, 0x4b, 0x85 }}
  72
  73 [PcdsFixedAtBuild, PcdsPatchableInModule]
  74   #
  75   # This PCD is the UEFI device path which is used as the Redfish host interface.
  76   #
  77   gEfiRedfishPkgTokenSpaceGuid.PcdRedfishRestExServiceDevicePath|{0x0}|REST_EX_SERVICE_DEVICE_PATH_DATA|0x00001000 {
  78   <HeaderFiles>
  79     Pcd/RestExServiceDevicePath.h
  80   <Packages>
  81     MdePkg/MdePkg.dec
  82     MdeModulePkg/MdeModulePkg.dec
  83     RedfishPkg/RedfishPkg.dec
  84   }
  85   #
  86   # This PCD indicates the EFI REST EX access mode to Redfish service.
  87   # Default is set to out of band access.
  88   #
  89   gEfiRedfishPkgTokenSpaceGuid.PcdRedfishRestExServiceAccessModeInBand|FALSE|BOOLEAN|0x00001001
  90   #
  91   # This PCD indicates the access mode EFI Discover protocol uses to look for the proper EFI REST EX
  92   # protocol instance.
  93   #
  94   gEfiRedfishPkgTokenSpaceGuid.PcdRedfishDiscoverAccessModeInBand|FALSE|BOOLEAN|0x00001002