MdeModulePkg/Library/PlatformVarCleanupLib/PlatVarCleanupHii.h

   1 /** @file
   2   Include file for platform variable cleanup HII.
   3
   4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _PLAT_VAR_CLEANUP_HII_
  10 #define _PLAT_VAR_CLEANUP_HII_
  11
  12 //
  13 // {24F14D8A-D7A8-4991-91E0-96C3B7DB8456}
  14 //
  15 #define VARIABLE_CLEANUP_HII_GUID \
  16   { \
  17     0x24f14d8a, 0xd7a8, 0x4991, { 0x91, 0xe0, 0x96, 0xc3, 0xb7, 0xdb, 0x84, 0x56 } \
  18   }
  19
  20 #define MAX_USER_VARIABLE_COUNT         0x1000
  21
  22 typedef struct {
  23   UINT8   SelectAll;
  24   //
  25   // FALSE is to not delete, TRUE is to delete.
  26   //
  27   UINT8   UserVariable[MAX_USER_VARIABLE_COUNT];
  28 } VARIABLE_CLEANUP_DATA;
  29
  30 #define VARIABLE_CLEANUP_VARSTORE_ID    0x8000
  31
  32 //
  33 // Field offset of structure VARIABLE_CLEANUP_DATA
  34 //
  35 #define VAR_OFFSET(Field)               ((UINTN) &(((VARIABLE_CLEANUP_DATA *) 0)->Field))
  36 #define USER_VARIABLE_VAR_OFFSET        (VAR_OFFSET (UserVariable))
  37
  38 #define FORM_ID_VARIABLE_CLEANUP        0x8000
  39
  40 #define LABEL_START                     0x0000
  41 #define LABEL_END                       0xFFFF
  42
  43 #define SELECT_ALL_QUESTION_ID          0x7FFD
  44 #define SAVE_AND_EXIT_QUESTION_ID       0x7FFE
  45 #define NO_SAVE_AND_EXIT_QUESTION_ID    0x7FFF
  46
  47 //
  48 // Tool automatic generated Question Id start from 1.
  49 // In order to avoid to conflict them, the user variable QuestionID offset is defined from 0x8000.
  50 //
  51 #define USER_VARIABLE_QUESTION_ID       0x8000
  52
  53 #endif