PeiCdExpress.h

Go to the documentation of this file.

 
#ifndef _PEI_CD_EXPRESS_H_
#define _PEI_CD_EXPRESS_H_
 
#include <PiPei.h>
 
#include <Ppi/BlockIo.h>
#include <Ppi/BlockIo2.h>
#include <Guid/RecoveryDevice.h>
#include <Ppi/DeviceRecoveryModule.h>
 
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/BaseMemoryLib.h>
#include <Library/PeiServicesTablePointerLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/MemoryAllocationLib.h>
 
#pragma pack(1)
 
#define PEI_CD_EXPRESS_MAX_BLOCK_IO_PPI    8
#define PEI_CD_EXPRESS_MAX_CAPSULE_NUMBER  16
 
#define PEI_CD_BLOCK_SIZE      0x800
#define PEI_MEMMORY_PAGE_SIZE  0x1000
 
//
// Following are defined according to ISO-9660 specification
//
#define PEI_CD_STANDARD_ID               "CD001"
#define PEI_CD_EXPRESS_STANDARD_ID_SIZE  5
 
#define PEI_CD_EXPRESS_VOLUME_TYPE_OFFSET      0
#define PEI_CD_EXPRESS_STANDARD_ID_OFFSET      1
#define PEI_CD_EXPRESS_VOLUME_SPACE_OFFSET     80
#define PEI_CD_EXPRESS_ROOT_DIR_RECORD_OFFSET  156
 
#define PEI_CD_EXPRESS_VOLUME_TYPE_PRIMARY     1
#define PEI_CD_EXPRESS_VOLUME_TYPE_TERMINATOR  255
 
#define PEI_CD_EXPRESS_DIR_FILE_REC_FLAG_ISDIR  0x02
 
typedef struct {
  UINTN                             CapsuleStartLBA;
  UINTN                             CapsuleSize;
  UINTN                             CapsuleBlockAlignedSize;
  UINTN                             IndexBlock;
  EFI_PEI_RECOVERY_BLOCK_IO_PPI     *BlockIo;
  EFI_PEI_RECOVERY_BLOCK_IO2_PPI    *BlockIo2;
} PEI_CD_EXPRESS_CAPSULE_DATA;
 
#define PEI_CD_EXPRESS_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('p', 'c', 'd', 'e')
 
typedef struct {
  UINTN                                 Signature;
  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI    DeviceRecoveryPpi;
  EFI_PEI_PPI_DESCRIPTOR                PpiDescriptor;
  EFI_PEI_NOTIFY_DESCRIPTOR             NotifyDescriptor;
  EFI_PEI_NOTIFY_DESCRIPTOR             NotifyDescriptor2;
 
  UINT8                                 *BlockBuffer;
  UINTN                                 CapsuleCount;
  PEI_CD_EXPRESS_CAPSULE_DATA           CapsuleData[PEI_CD_EXPRESS_MAX_CAPSULE_NUMBER];
} PEI_CD_EXPRESS_PRIVATE_DATA;
 
#define PEI_CD_EXPRESS_PRIVATE_DATA_FROM_THIS(a) \
  CR (a, \
          PEI_CD_EXPRESS_PRIVATE_DATA, \
          DeviceRecoveryPpi, \
          PEI_CD_EXPRESS_PRIVATE_DATA_SIGNATURE \
      )
 
typedef struct {
  UINT8     Length;
  UINT8     ExtendedAttributeRecordLength;
  UINT32    LocationOfExtent[2];
  UINT32    DataLength[2];
  UINT8     DateTime[7];
  UINT8     Flag;
  UINT8     FileUnitSize;
  UINT8     InterleaveGapSize;
  UINT32    VolumeSequenceNumber;
  UINT8     FileIDLength;
  UINT8     FileID[1];
} PEI_CD_EXPRESS_DIR_FILE_RECORD;
 
EFI_STATUS
EFIAPI
BlockIoNotifyEntry (
  IN EFI_PEI_SERVICES           **PeiServices,
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,
  IN VOID                       *Ppi
  );
 
EFI_STATUS
UpdateBlocksAndVolumes (
  IN OUT PEI_CD_EXPRESS_PRIVATE_DATA  *PrivateData,
  IN     BOOLEAN                      BlockIo2
  );
 
EFI_STATUS
EFIAPI
GetNumberRecoveryCapsules (
  IN EFI_PEI_SERVICES                    **PeiServices,
  IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI  *This,
  OUT UINTN                              *NumberRecoveryCapsules
  );
 
EFI_STATUS
EFIAPI
GetRecoveryCapsuleInfo (
  IN  EFI_PEI_SERVICES                    **PeiServices,
  IN  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI  *This,
  IN  UINTN                               CapsuleInstance,
  OUT UINTN                               *Size,
  OUT EFI_GUID                            *CapsuleType
  );
 
EFI_STATUS
EFIAPI
LoadRecoveryCapsule (
  IN EFI_PEI_SERVICES                    **PeiServices,
  IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI  *This,
  IN UINTN                               CapsuleInstance,
  OUT VOID                               *Buffer
  );
 
EFI_STATUS
EFIAPI
FindRecoveryCapsules (
  IN OUT PEI_CD_EXPRESS_PRIVATE_DATA  *PrivateData
  );
 
EFI_STATUS
EFIAPI
RetrieveCapsuleFileFromRoot (
  IN OUT PEI_CD_EXPRESS_PRIVATE_DATA  *PrivateData,
  IN EFI_PEI_RECOVERY_BLOCK_IO_PPI    *BlockIoPpi,
  IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI   *BlockIo2Ppi,
  IN UINTN                            IndexBlockDevice,
  IN UINT32                           Lba
  );
 
BOOLEAN
StringCmp (
  IN UINT8    *Source1,
  IN UINT8    *Source2,
  IN UINTN    Size,
  IN BOOLEAN  CaseSensitive
  );
 
#pragma pack()
 
#endif