ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c

   1 /** @file
   2 *  OemMiscLib.c
   3 *
   4 *  Copyright (c) 2021, NUVIA Inc. All rights reserved.
   5 *  Copyright (c) 2018, Hisilicon Limited. All rights reserved.
   6 *  Copyright (c) 2018, Linaro Limited. All rights reserved.
   7 *
   8 *  SPDX-License-Identifier: BSD-2-Clause-Patent
   9 *
  10 **/
  11
  12 #include <Uefi.h>
  13 #include <Library/BaseMemoryLib.h>
  14 #include <Library/DebugLib.h>
  15 #include <Library/HiiLib.h>
  16 #include <Library/OemMiscLib.h>
  17
  18 /** Gets the CPU frequency of the specified processor.
  19
  20   @param ProcessorIndex Index of the processor to get the frequency for.
  21
  22   @return               CPU frequency in Hz
  23 **/
  24 UINTN
  25 EFIAPI
  26 OemGetCpuFreq (
  27   IN UINT8  ProcessorIndex
  28   )
  29 {
  30   ASSERT (FALSE);
  31   return 0;
  32 }
  33
  34 /** Gets information about the specified processor and stores it in
  35     the structures provided.
  36
  37   @param ProcessorIndex  Index of the processor to get the information for.
  38   @param ProcessorStatus Processor status.
  39   @param ProcessorCharacteristics Processor characteritics.
  40   @param MiscProcessorData        Miscellaneous processor information.
  41
  42   @return  TRUE on success, FALSE on failure.
  43 **/
  44 BOOLEAN
  45 EFIAPI
  46 OemGetProcessorInformation (
  47   IN UINTN                               ProcessorIndex,
  48   IN OUT PROCESSOR_STATUS_DATA           *ProcessorStatus,
  49   IN OUT PROCESSOR_CHARACTERISTIC_FLAGS  *ProcessorCharacteristics,
  50   IN OUT OEM_MISC_PROCESSOR_DATA         *MiscProcessorData
  51   )
  52 {
  53   ASSERT (FALSE);
  54   return TRUE;
  55 }
  56
  57 /** Gets information about the cache at the specified cache level.
  58
  59   @param ProcessorIndex The processor to get information for.
  60   @param CacheLevel The cache level to get information for.
  61   @param DataCache  Whether the cache is a data cache.
  62   @param UnifiedCache Whether the cache is a unified cache.
  63   @param SmbiosCacheTable The SMBIOS Type7 cache information structure.
  64
  65   @return TRUE on success, FALSE on failure.
  66 **/
  67 BOOLEAN
  68 EFIAPI
  69 OemGetCacheInformation (
  70   IN UINT8                   ProcessorIndex,
  71   IN UINT8                   CacheLevel,
  72   IN BOOLEAN                 DataCache,
  73   IN BOOLEAN                 UnifiedCache,
  74   IN OUT SMBIOS_TABLE_TYPE7  *SmbiosCacheTable
  75   )
  76 {
  77   ASSERT (FALSE);
  78   return TRUE;
  79 }
  80
  81 /** Gets the maximum number of processors supported by the platform.
  82
  83   @return The maximum number of processors.
  84 **/
  85 UINT8
  86 EFIAPI
  87 OemGetMaxProcessors (
  88   VOID
  89   )
  90 {
  91   ASSERT (FALSE);
  92   return 1;
  93 }
  94
  95 /** Gets the type of chassis for the system.
  96
  97   @retval The type of the chassis.
  98 **/
  99 MISC_CHASSIS_TYPE
 100 EFIAPI
 101 OemGetChassisType (
 102   VOID
 103   )
 104 {
 105   ASSERT (FALSE);
 106   return MiscChassisTypeUnknown;
 107 }
 108
 109 /** Returns whether the specified processor is present or not.
 110
 111   @param ProcessIndex The processor index to check.
 112
 113   @return TRUE is the processor is present, FALSE otherwise.
 114 **/
 115 BOOLEAN
 116 EFIAPI
 117 OemIsProcessorPresent (
 118   IN UINTN  ProcessorIndex
 119   )
 120 {
 121   ASSERT (FALSE);
 122   return FALSE;
 123 }
 124
 125 /** Updates the HII string for the specified field.
 126
 127   @param HiiHandle     The HII handle.
 128   @param TokenToUpdate The string to update.
 129   @param Field         The field to get information about.
 130 **/
 131 VOID
 132 EFIAPI
 133 OemUpdateSmbiosInfo (
 134   IN EFI_HII_HANDLE                    HiiHandle,
 135   IN EFI_STRING_ID                     TokenToUpdate,
 136   IN OEM_MISC_SMBIOS_HII_STRING_FIELD  Field
 137   )
 138 {
 139   ASSERT (FALSE);
 140 }
 141
 142 /** Fetches the Type 32 boot information status.
 143
 144   @return Boot status.
 145 **/
 146 MISC_BOOT_INFORMATION_STATUS_DATA_TYPE
 147 EFIAPI
 148 OemGetBootStatus (
 149   VOID
 150   )
 151 {
 152   ASSERT (FALSE);
 153   return BootInformationStatusNoError;
 154 }
 155
 156 /** Fetches the chassis status when it was last booted.
 157
 158  @return Chassis status.
 159 **/
 160 MISC_CHASSIS_STATE
 161 EFIAPI
 162 OemGetChassisBootupState (
 163   VOID
 164   )
 165 {
 166   ASSERT (FALSE);
 167   return ChassisStateSafe;
 168 }
 169
 170 /** Fetches the chassis power supply/supplies status when last booted.
 171
 172  @return Chassis power supply/supplies status.
 173 **/
 174 MISC_CHASSIS_STATE
 175 EFIAPI
 176 OemGetChassisPowerSupplyState (
 177   VOID
 178   )
 179 {
 180   ASSERT (FALSE);
 181   return ChassisStateSafe;
 182 }
 183
 184 /** Fetches the chassis thermal status when last booted.
 185
 186  @return Chassis thermal status.
 187 **/
 188 MISC_CHASSIS_STATE
 189 EFIAPI
 190 OemGetChassisThermalState (
 191   VOID
 192   )
 193 {
 194   ASSERT (FALSE);
 195   return ChassisStateSafe;
 196 }
 197
 198 /** Fetches the chassis security status when last booted.
 199
 200  @return Chassis security status.
 201 **/
 202 MISC_CHASSIS_SECURITY_STATE
 203 EFIAPI
 204 OemGetChassisSecurityStatus (
 205   VOID
 206   )
 207 {
 208   ASSERT (FALSE);
 209   return ChassisSecurityStatusNone;
 210 }
 211
 212 /** Fetches the chassis height in RMUs (Rack Mount Units).
 213
 214   @return The height of the chassis.
 215 **/
 216 UINT8
 217 EFIAPI
 218 OemGetChassisHeight (
 219   VOID
 220   )
 221 {
 222   ASSERT (FALSE);
 223   return 1U;
 224 }
 225
 226 /** Fetches the number of power cords.
 227
 228   @return The number of power cords.
 229 **/
 230 UINT8
 231 EFIAPI
 232 OemGetChassisNumPowerCords (
 233   VOID
 234   )
 235 {
 236   ASSERT (FALSE);
 237   return 1;
 238 }