RedfishPkg/RedfishPkg.dec

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