tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-28 08:04:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

ArmPlatformPkg/PL031RealTimeClockLib: remove validation and DST handling

Browse Source 
This library, which is intended to encapsulate the hardware specifics
of the ARM PL031 RTC, also implements its own input validation routines
and record the timezone and DST settings in its own set of EFI variables.

This functionality has recently been added to the core driver, so let's
remove it here.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
This commit is contained in:
Ard Biesheuvel 2017-11-05 16:31:23 +00:00
parent 517cf87794
commit 26f9ef3ab3
1 changed files with 15 additions and 171 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

186
ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.c
View File

@ -40,8 +40,6 @@
#include <ArmPlatform.h> #include <ArmPlatform.h>
STATIC CONST CHAR16 mTimeZoneVariableName[] = L"PL031RtcTimeZone";
STATIC CONST CHAR16 mDaylightVariableName[] = L"PL031RtcDaylight";
STATIC BOOLEAN mPL031Initialized = FALSE; STATIC BOOLEAN mPL031Initialized = FALSE;
STATIC EFI_EVENT mRtcVirtualAddrChangeEvent; STATIC EFI_EVENT mRtcVirtualAddrChangeEvent;
STATIC UINTN mPL031RtcBase; STATIC UINTN mPL031RtcBase;
@ -134,15 +132,12 @@ LibGetTime (
{ {
EFI_STATUS Status = EFI_SUCCESS; EFI_STATUS Status = EFI_SUCCESS;
UINT32 EpochSeconds; UINT32 EpochSeconds;
INT16 TimeZone;
UINT8 Daylight;
UINTN Size;
// Initialize the hardware if not already done // Initialize the hardware if not already done
if (!mPL031Initialized) { if (!mPL031Initialized) {
Status = InitializePL031 (); Status = InitializePL031 ();
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
goto EXIT; return Status;
} }
} }
@ -156,7 +151,7 @@ LibGetTime (
Status = EFI_SUCCESS; Status = EFI_SUCCESS;
} else if (EFI_ERROR (Status)) { } else if (EFI_ERROR (Status)) {
// Battery backed up hardware RTC exists but could not be read due to error. Abort. // Battery backed up hardware RTC exists but could not be read due to error. Abort.
goto EXIT; return Status;
} else { } else {
// Battery backed up hardware RTC exists and we read the time correctly from it. // Battery backed up hardware RTC exists and we read the time correctly from it.
// Now sync the PL031 to the new time. // Now sync the PL031 to the new time.
@ -165,107 +160,18 @@ LibGetTime (
// Ensure Time is a valid pointer // Ensure Time is a valid pointer
if (Time == NULL) { if (Time == NULL) {
Status = EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
goto EXIT;
} }
// Get the current time zone information from non-volatile storage // Adjust for the correct time zone
Size = sizeof (TimeZone); if (Time->TimeZone != EFI_UNSPECIFIED_TIMEZONE) {
Status = EfiGetVariable ( EpochSeconds += Time->TimeZone * SEC_PER_MIN;
(CHAR16 *)mTimeZoneVariableName,
&gEfiCallerIdGuid,
NULL,
&Size,
(VOID *)&TimeZone
);
if (EFI_ERROR (Status)) {
ASSERT(Status != EFI_INVALID_PARAMETER);
ASSERT(Status != EFI_BUFFER_TOO_SMALL);
if (Status != EFI_NOT_FOUND)
goto EXIT;
// The time zone variable does not exist in non-volatile storage, so create it.
Time->TimeZone = EFI_UNSPECIFIED_TIMEZONE;
// Store it
Status = EfiSetVariable (
(CHAR16 *)mTimeZoneVariableName,
&gEfiCallerIdGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
Size,
(VOID *)&(Time->TimeZone)
);
if (EFI_ERROR (Status)) {
DEBUG ((
EFI_D_ERROR,
"LibGetTime: Failed to save %s variable to non-volatile storage, Status = %r\n",
mTimeZoneVariableName,
Status
));
goto EXIT;
}
} else {
// Got the time zone
Time->TimeZone = TimeZone;
// Check TimeZone bounds: -1440 to 1440 or 2047
if (((Time->TimeZone < -1440) || (Time->TimeZone > 1440))
&& (Time->TimeZone != EFI_UNSPECIFIED_TIMEZONE)) {
Time->TimeZone = EFI_UNSPECIFIED_TIMEZONE;
}
// Adjust for the correct time zone
if (Time->TimeZone != EFI_UNSPECIFIED_TIMEZONE) {
EpochSeconds += Time->TimeZone * SEC_PER_MIN;
}
} }
// Get the current daylight information from non-volatile storage // Adjust for the correct period
Size = sizeof (Daylight); if ((Time->Daylight & EFI_TIME_IN_DAYLIGHT) == EFI_TIME_IN_DAYLIGHT) {
Status = EfiGetVariable ( // Convert to adjusted time, i.e. spring forwards one hour
(CHAR16 *)mDaylightVariableName, EpochSeconds += SEC_PER_HOUR;
&gEfiCallerIdGuid,
NULL,
&Size,
(VOID *)&Daylight
);
if (EFI_ERROR (Status)) {
ASSERT(Status != EFI_INVALID_PARAMETER);
ASSERT(Status != EFI_BUFFER_TOO_SMALL);
if (Status != EFI_NOT_FOUND)
goto EXIT;
// The daylight variable does not exist in non-volatile storage, so create it.
Time->Daylight = 0;
// Store it
Status = EfiSetVariable (
(CHAR16 *)mDaylightVariableName,
&gEfiCallerIdGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
Size,
(VOID *)&(Time->Daylight)
);
if (EFI_ERROR (Status)) {
DEBUG ((
EFI_D_ERROR,
"LibGetTime: Failed to save %s variable to non-volatile storage, Status = %r\n",
mDaylightVariableName,
Status
));
goto EXIT;
}
} else {
// Got the daylight information
Time->Daylight = Daylight;
// Adjust for the correct period
if ((Time->Daylight & EFI_TIME_IN_DAYLIGHT) == EFI_TIME_IN_DAYLIGHT) {
// Convert to adjusted time, i.e. spring forwards one hour
EpochSeconds += SEC_PER_HOUR;
}
} }
// Convert from internal 32-bit time to UEFI time // Convert from internal 32-bit time to UEFI time
@ -281,8 +187,7 @@ LibGetTime (
Capabilities->SetsToZero = FALSE; Capabilities->SetsToZero = FALSE;
} }
EXIT: return EFI_SUCCESS;
return Status;
} }
@ -305,37 +210,19 @@ LibSetTime (
EFI_STATUS Status; EFI_STATUS Status;
UINTN EpochSeconds; UINTN EpochSeconds;
// Check the input parameters are within the range specified by UEFI
if ((Time->Year < 1900) ||
(Time->Year > 9999) ||
(Time->Month < 1 ) ||
(Time->Month > 12 ) ||
(!IsDayValid (Time) ) ||
(Time->Hour > 23 ) ||
(Time->Minute > 59 ) ||
(Time->Second > 59 ) ||
(Time->Nanosecond > 999999999) ||
(!((Time->TimeZone == EFI_UNSPECIFIED_TIMEZONE) || ((Time->TimeZone >= -1440) && (Time->TimeZone <= 1440)))) ||
(Time->Daylight & (~(EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT)))
) {
Status = EFI_INVALID_PARAMETER;
goto EXIT;
}
// Because the PL031 is a 32-bit counter counting seconds, // Because the PL031 is a 32-bit counter counting seconds,
// the maximum time span is just over 136 years. // the maximum time span is just over 136 years.
// Time is stored in Unix Epoch format, so it starts in 1970, // Time is stored in Unix Epoch format, so it starts in 1970,
// Therefore it can not exceed the year 2106. // Therefore it can not exceed the year 2106.
if ((Time->Year < 1970) || (Time->Year >= 2106)) { if ((Time->Year < 1970) || (Time->Year >= 2106)) {
Status = EFI_UNSUPPORTED; return EFI_UNSUPPORTED;
goto EXIT;
} }
// Initialize the hardware if not already done // Initialize the hardware if not already done
if (!mPL031Initialized) { if (!mPL031Initialized) {
Status = InitializePL031 (); Status = InitializePL031 ();
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
goto EXIT; return Status;
} }
} }
@ -346,8 +233,6 @@ LibSetTime (
EpochSeconds -= Time->TimeZone * SEC_PER_MIN; EpochSeconds -= Time->TimeZone * SEC_PER_MIN;
} }
// TODO: Automatic Daylight activation
// Adjust for the correct period // Adjust for the correct period
if ((Time->Daylight & EFI_TIME_IN_DAYLIGHT) == EFI_TIME_IN_DAYLIGHT) { if ((Time->Daylight & EFI_TIME_IN_DAYLIGHT) == EFI_TIME_IN_DAYLIGHT) {
// Convert to un-adjusted time, i.e. fall back one hour // Convert to un-adjusted time, i.e. fall back one hour
@ -364,54 +249,13 @@ LibSetTime (
Status = ArmPlatformSysConfigSet (SYS_CFG_RTC, EpochSeconds); Status = ArmPlatformSysConfigSet (SYS_CFG_RTC, EpochSeconds);
if ((EFI_ERROR (Status)) && (Status != EFI_UNSUPPORTED)){ if ((EFI_ERROR (Status)) && (Status != EFI_UNSUPPORTED)){
// Any status message except SUCCESS and UNSUPPORTED indicates a hardware failure. // Any status message except SUCCESS and UNSUPPORTED indicates a hardware failure.
goto EXIT; return Status;
} }
// Set the PL031 // Set the PL031
MmioWrite32 (mPL031RtcBase + PL031_RTC_LR_LOAD_REGISTER, EpochSeconds); MmioWrite32 (mPL031RtcBase + PL031_RTC_LR_LOAD_REGISTER, EpochSeconds);
// The accesses to Variable Services can be very slow, because we may be writing to Flash. return EFI_SUCCESS;
// Do this after having set the RTC.
// Save the current time zone information into non-volatile storage
Status = EfiSetVariable (
(CHAR16 *)mTimeZoneVariableName,
&gEfiCallerIdGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
sizeof (Time->TimeZone),
(VOID *)&(Time->TimeZone)
);
if (EFI_ERROR (Status)) {
DEBUG ((
EFI_D_ERROR,
"LibSetTime: Failed to save %s variable to non-volatile storage, Status = %r\n",
mTimeZoneVariableName,
Status
));
goto EXIT;
}
// Save the current daylight information into non-volatile storage
Status = EfiSetVariable (
(CHAR16 *)mDaylightVariableName,
&gEfiCallerIdGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
sizeof(Time->Daylight),
(VOID *)&(Time->Daylight)
);
if (EFI_ERROR (Status)) {
DEBUG ((
EFI_D_ERROR,
"LibSetTime: Failed to save %s variable to non-volatile storage, Status = %r\n",
mDaylightVariableName,
Status
));
goto EXIT;
}
EXIT:
return Status;
} }