MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c

   1 /** @file
   2
   3 Copyright (c) 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   UefiIfrOpCodeCreation.c
  15
  16 Abstract:
  17
  18   Library Routines to create IFR independent of string data - assume tokens already exist
  19   Primarily to be used for exporting op-codes at a label in pre-defined forms.
  20
  21 Revision History:
  22
  23
  24 **/
  25
  26 #include "LibraryInternal.h"
  27
  28 STATIC EFI_GUID mIfrVendorGuid = EFI_IFR_TIANO_GUID;
  29
  30 EFI_STATUS
  31 EFIAPI
  32 CreateBannerOpCode (
  33   IN      EFI_STRING_ID       Title,
  34   IN      UINT16              LineNumber,
  35   IN      UINT8               Alignment,
  36   IN OUT EFI_HII_UPDATE_DATA  *Data
  37   )
  38 {
  39   EFI_IFR_GUID_BANNER         Banner;
  40   UINT8                       *LocalBuffer;
  41
  42   ASSERT (Data != NULL && Data->Data != NULL);
  43
  44   if (Data->Offset + sizeof (EFI_IFR_GUID_BANNER) > Data->BufferSize) {
  45     return EFI_BUFFER_TOO_SMALL;
  46   }
  47
  48   Banner.Header.OpCode  = EFI_IFR_GUID_OP;
  49   Banner.Header.Length  = sizeof (EFI_IFR_GUID_BANNER);
  50   Banner.Header.Scope   = 0;
  51   CopyMem (&Banner.Guid, &mIfrVendorGuid, sizeof (EFI_IFR_GUID));
  52   Banner.ExtendOpCode   = EFI_IFR_EXTEND_OP_BANNER;
  53   Banner.Title          = Title;
  54   Banner.LineNumber     = LineNumber;
  55   Banner.Alignment      = Alignment;
  56
  57   LocalBuffer = (UINT8 *) Data->Data + Data->Offset;
  58   CopyMem (LocalBuffer, &Banner, sizeof (EFI_IFR_GUID_BANNER));
  59   Data->Offset += sizeof (EFI_IFR_GUID_BANNER);
  60
  61   return EFI_SUCCESS;
  62 }
  63