MdeModulePkg/Universal/Disk/CdExpressPei/PeiCdExpress.h

   1 /** @file
   2   Header file for CD recovery PEIM
   3
   4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
   5
   6 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions
   8 of the BSD License which accompanies this distribution.  The
   9 full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef _PEI_CD_EXPRESS_H_
  18 #define _PEI_CD_EXPRESS_H_
  19
  20
  21 #include <PiPei.h>
  22
  23 #include <Ppi/BlockIo.h>
  24 #include <Guid/RecoveryDevice.h>
  25 #include <Ppi/DeviceRecoveryModule.h>
  26
  27 #include <Library/DebugLib.h>
  28 #include <Library/PcdLib.h>
  29 #include <Library/PeimEntryPoint.h>
  30 #include <Library/BaseMemoryLib.h>
  31 #include <Library/PeiServicesTablePointerLib.h>
  32 #include <Library/PeiServicesLib.h>
  33 #include <Library/MemoryAllocationLib.h>
  34
  35
  36 #pragma pack(1)
  37
  38 #define PEI_CD_EXPRESS_MAX_BLOCK_IO_PPI   8
  39 #define PEI_CD_EXPRESS_MAX_CAPSULE_NUMBER 16
  40
  41 #define PEI_CD_BLOCK_SIZE                 0x800
  42 #define PEI_MEMMORY_PAGE_SIZE             0x1000
  43
  44 //
  45 // Recovery file name (in root directory)
  46 //
  47 #define PEI_RECOVERY_FILE_NAME  "FVMAIN.FV"
  48
  49 //
  50 // Following are defined according to ISO-9660 specification
  51 //
  52 #define PEI_CD_STANDARD_ID                      "CD001"
  53 #define PEI_CD_EXPRESS_STANDARD_ID_SIZE         5
  54
  55 #define PEI_CD_EXPRESS_VOLUME_TYPE_OFFSET       0
  56 #define PEI_CD_EXPRESS_STANDARD_ID_OFFSET       1
  57 #define PEI_CD_EXPRESS_VOLUME_SPACE_OFFSET      80
  58 #define PEI_CD_EXPRESS_ROOT_DIR_RECORD_OFFSET   156
  59
  60 #define PEI_CD_EXPRESS_VOLUME_TYPE_PRIMARY      1
  61 #define PEI_CD_EXPRESS_VOLUME_TYPE_TERMINATOR   255
  62
  63 #define PEI_CD_EXPRESS_DIR_FILE_REC_FLAG_ISDIR  0x02
  64
  65 typedef struct {
  66   UINTN                           CapsuleStartLBA;
  67   UINTN                           CapsuleSize;
  68   UINTN                           IndexBlock;
  69   EFI_PEI_RECOVERY_BLOCK_IO_PPI   *BlockIo;
  70 } PEI_CD_EXPRESS_CAPSULE_DATA;
  71
  72 #define PEI_CD_EXPRESS_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('p', 'c', 'd', 'e')
  73
  74 typedef struct {
  75
  76   UINTN                                 Signature;
  77   EFI_PEI_SERVICES                      **PeiServices;
  78   EFI_PEI_DEVICE_RECOVERY_MODULE_PPI    DeviceRecoveryPpi;
  79   EFI_PEI_PPI_DESCRIPTOR                PpiDescriptor;
  80   EFI_PEI_NOTIFY_DESCRIPTOR             NotifyDescriptor;
  81
  82   UINT8                                 *BlockBuffer;
  83   UINTN                                 CapsuleCount;
  84   PEI_CD_EXPRESS_CAPSULE_DATA           CapsuleData[PEI_CD_EXPRESS_MAX_CAPSULE_NUMBER];
  85
  86 } PEI_CD_EXPRESS_PRIVATE_DATA;
  87
  88 #define PEI_CD_EXPRESS_PRIVATE_DATA_FROM_THIS(a) \
  89   CR (a, \
  90           PEI_CD_EXPRESS_PRIVATE_DATA, \
  91           DeviceRecoveryPpi, \
  92           PEI_CD_EXPRESS_PRIVATE_DATA_SIGNATURE \
  93       )
  94
  95 typedef struct {
  96   UINT8   Length;
  97   UINT8   ExtendedAttributeRecordLength;
  98   UINT32  LocationOfExtent[2];
  99   UINT32  DataLength[2];
 100   UINT8   DateTime[7];
 101   UINT8   Flag;
 102   UINT8   FileUnitSize;
 103   UINT8   InterleaveGapSize;
 104   UINT32  VolumeSequenceNumber;
 105   UINT8   FileIDLength;
 106   UINT8   FileID[1];
 107 } PEI_CD_EXPRESS_DIR_FILE_RECORD;
 108
 109 /**
 110   BlockIo installation notification function.
 111
 112   This function finds out all the current Block IO PPIs in the system and add them
 113   into private data.
 114
 115   @param  PeiServices            Indirect reference to the PEI Services Table.
 116   @param  NotifyDescriptor       Address of the notification descriptor data structure.
 117   @param  Ppi                    Address of the PPI that was installed.
 118
 119   @retval EFI_SUCCESS            The function completes successfully.
 120
 121 **/
 122 EFI_STATUS
 123 EFIAPI
 124 BlockIoNotifyEntry (
 125   IN EFI_PEI_SERVICES           **PeiServices,
 126   IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,
 127   IN VOID                       *Ppi
 128   );
 129
 130 /**
 131   Finds out all the current Block IO PPIs in the system and add them into private data.
 132
 133   @param PrivateData                    The private data structure that contains recovery module information.
 134
 135   @retval EFI_SUCCESS                   The blocks and volumes are updated successfully.
 136
 137 **/
 138 EFI_STATUS
 139 UpdateBlocksAndVolumes (
 140   IN OUT PEI_CD_EXPRESS_PRIVATE_DATA     *PrivateData
 141   );
 142
 143 /**
 144   Returns the number of DXE capsules residing on the device.
 145
 146   This function searches for DXE capsules from the associated device and returns
 147   the number and maximum size in bytes of the capsules discovered. Entry 1 is
 148   assumed to be the highest load priority and entry N is assumed to be the lowest
 149   priority.
 150
 151   @param[in]  PeiServices              General-purpose services that are available
 152                                        to every PEIM
 153   @param[in]  This                     Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI
 154                                        instance.
 155   @param[out] NumberRecoveryCapsules   Pointer to a caller-allocated UINTN. On
 156                                        output, *NumberRecoveryCapsules contains
 157                                        the number of recovery capsule images
 158                                        available for retrieval from this PEIM
 159                                        instance.
 160
 161   @retval EFI_SUCCESS        One or more capsules were discovered.
 162   @retval EFI_DEVICE_ERROR   A device error occurred.
 163   @retval EFI_NOT_FOUND      A recovery DXE capsule cannot be found.
 164
 165 **/
 166 EFI_STATUS
 167 EFIAPI
 168 GetNumberRecoveryCapsules (
 169   IN EFI_PEI_SERVICES                               **PeiServices,
 170   IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI             *This,
 171   OUT UINTN                                         *NumberRecoveryCapsules
 172   );
 173
 174 /**
 175   Returns the size and type of the requested recovery capsule.
 176
 177   This function gets the size and type of the capsule specified by CapsuleInstance.
 178
 179   @param[in]  PeiServices       General-purpose services that are available to every PEIM
 180   @param[in]  This              Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI
 181                                 instance.
 182   @param[in]  CapsuleInstance   Specifies for which capsule instance to retrieve
 183                                 the information.  This parameter must be between
 184                                 one and the value returned by GetNumberRecoveryCapsules()
 185                                 in NumberRecoveryCapsules.
 186   @param[out] Size              A pointer to a caller-allocated UINTN in which
 187                                 the size of the requested recovery module is
 188                                 returned.
 189   @param[out] CapsuleType       A pointer to a caller-allocated EFI_GUID in which
 190                                 the type of the requested recovery capsule is
 191                                 returned.  The semantic meaning of the value
 192                                 returned is defined by the implementation.
 193
 194   @retval EFI_SUCCESS        One or more capsules were discovered.
 195   @retval EFI_DEVICE_ERROR   A device error occurred.
 196   @retval EFI_NOT_FOUND      A recovery DXE capsule cannot be found.
 197
 198 **/
 199 EFI_STATUS
 200 EFIAPI
 201 GetRecoveryCapsuleInfo (
 202   IN  EFI_PEI_SERVICES                              **PeiServices,
 203   IN  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI            *This,
 204   IN  UINTN                                         CapsuleInstance,
 205   OUT UINTN                                         *Size,
 206   OUT EFI_GUID                                      *CapsuleType
 207   );
 208
 209 /**
 210   Loads a DXE capsule from some media into memory.
 211
 212   This function, by whatever mechanism, retrieves a DXE capsule from some device
 213   and loads it into memory. Note that the published interface is device neutral.
 214
 215   @param[in]     PeiServices       General-purpose services that are available
 216                                    to every PEIM
 217   @param[in]     This              Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI
 218                                    instance.
 219   @param[in]     CapsuleInstance   Specifies which capsule instance to retrieve.
 220   @param[out]    Buffer            Specifies a caller-allocated buffer in which
 221                                    the requested recovery capsule will be returned.
 222
 223   @retval EFI_SUCCESS        The capsule was loaded correctly.
 224   @retval EFI_DEVICE_ERROR   A device error occurred.
 225   @retval EFI_NOT_FOUND      A requested recovery DXE capsule cannot be found.
 226
 227 **/
 228 EFI_STATUS
 229 EFIAPI
 230 LoadRecoveryCapsule (
 231   IN EFI_PEI_SERVICES                             **PeiServices,
 232   IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI           *This,
 233   IN UINTN                                        CapsuleInstance,
 234   OUT VOID                                        *Buffer
 235   );
 236
 237 /**
 238   Finds out the recovery capsule in the current volume.
 239
 240   @param PrivateData                    The private data structure that contains recovery module information.
 241
 242   @retval EFI_SUCCESS                   The recovery capsule is successfully found in the volume.
 243   @retval EFI_NOT_FOUND                 The recovery capsule is not found in the volume.
 244
 245 **/
 246 EFI_STATUS
 247 EFIAPI
 248 FindRecoveryCapsules (
 249   IN OUT PEI_CD_EXPRESS_PRIVATE_DATA            *PrivateData
 250   );
 251
 252 /**
 253   Retrieves the recovery capsule in root directory of the current volume.
 254
 255   @param PrivateData                    The private data structure that contains recovery module information.
 256   @param BlockIoPpi                     The Block IO PPI used to access the volume.
 257   @param IndexBlockDevice               The index of current block device.
 258   @param Lba                            The starting logic block address to retrieve capsule.
 259
 260   @retval EFI_SUCCESS                   The recovery capsule is successfully found in the volume.
 261   @retval EFI_NOT_FOUND                 The recovery capsule is not found in the volume.
 262   @retval Others
 263
 264 **/
 265 EFI_STATUS
 266 EFIAPI
 267 RetrieveCapsuleFileFromRoot (
 268   IN OUT PEI_CD_EXPRESS_PRIVATE_DATA        *PrivateData,
 269   IN EFI_PEI_RECOVERY_BLOCK_IO_PPI          *BlockIoPpi,
 270   IN UINTN                                  IndexBlockDevice,
 271   IN UINT32                                 Lba
 272   );
 273
 274
 275 /**
 276   This function compares two ASCII strings in case sensitive/insensitive way.
 277
 278   @param  Source1           The first string.
 279   @param  Source2           The second string.
 280   @param  Size              The maximum comparison length.
 281   @param  CaseSensitive     Flag to indicate whether the comparison is case sensitive.
 282
 283   @retval TRUE              The two strings are the same.
 284   @retval FALSE             The two string are not the same.
 285
 286 **/
 287 BOOLEAN
 288 StringCmp (
 289   IN UINT8      *Source1,
 290   IN UINT8      *Source2,
 291   IN UINTN      Size,
 292   IN BOOLEAN    CaseSensitive
 293   );
 294
 295 #pragma pack()
 296
 297 #endif