summaryrefslogtreecommitdiff
path: root/EmbeddedPkg
diff options
context:
space:
mode:
authorRonald Cron <ronald.cron@arm.com>2014-09-01 13:20:41 +0000
committeroliviermartin <oliviermartin@6f19259b-4bc3-4df7-8a09-765794883524>2014-09-01 13:20:41 +0000
commitf4b491b56f827052d0823c3217fa2049fd479a7d (patch)
tree2c51166c84b8cf0d039df11cdfa2fcce161e6f1f /EmbeddedPkg
parent947a10b1552cd512c16d562384253a6f52aa5178 (diff)
downloadedk2-platforms-f4b491b56f827052d0823c3217fa2049fd479a7d.tar.xz
HalRuntimeServicesExampleLib/Rtc.c : Added missing comments
Added the header comment block to the function "RtcTimeFieldsValid()" and reworked the alignment of the code. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Ronald Cron <ronald.cron@arm.com> Reviewed-by: Olivier Martin <olivier.martin@arm.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16011 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'EmbeddedPkg')
-rw-r--r--EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Rtc.c45
1 files changed, 23 insertions, 22 deletions
diff --git a/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Rtc.c b/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Rtc.c
index 6fd6516bf2..c35d72c03c 100644
--- a/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Rtc.c
+++ b/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Rtc.c
@@ -3,6 +3,7 @@
Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
+ Copyright (c) 2014, ARM Ltd. All rights reserved.
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@@ -246,33 +247,33 @@ ConvertEfiTimeToRtcTime (
}
}
+/**
+ Check the validity of all the fields of a data structure of type EFI_TIME
+
+ @param[in] Time Pointer to a data structure of type EFI_TIME that defines a date and time
+
+ @retval EFI_SUCCESS All date and time fields are valid
+ @retval EFI_INVALID_PARAMETER At least one date or time field is not valid
+**/
EFI_STATUS
RtcTimeFieldsValid (
IN EFI_TIME *Time
)
-/*++
-
-Routine Description:
-
- Arguments:
-
- Returns:
---*/
-// TODO: Time - add argument and description to function comment
-// TODO: EFI_INVALID_PARAMETER - add return value to function comment
-// TODO: EFI_SUCCESS - add return value to function comment
{
- if (Time->Year < 1998 ||
- Time->Year > 2099 ||
- Time->Month < 1 ||
- Time->Month > 12 ||
- (!DayValid (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)))
+ if ((Time->Year < 1998 ) ||
+ (Time->Year > 2099 ) ||
+ (Time->Month < 1 ) ||
+ (Time->Month > 12 ) ||
+ (!DayValid (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 )))
) {
return EFI_INVALID_PARAMETER;
}