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

EmbeddedPkg/TimeBaseLib: Update comment blocks for API functions

Browse Source 
This updates Doxygen comment blocks for API library functions.

Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Signed-off-by: Nhi Pham <nhi@os.amperecomputing.com>
Reviewed-by: Leif Lindholm <leif@nuviainc.com>
This commit is contained in:
Nhi Pham 2021-01-06 23:09:00 +07:00 committed by mergify[bot]
parent 8015f3f6d4
commit 48de23e548
2 changed files with 104 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
EmbeddedPkg/Include/Library/TimeBaseLib.h
View File

@ -2,6 +2,7 @@
* *
* Copyright (c) 2016, Hisilicon Limited. All rights reserved. * Copyright (c) 2016, Hisilicon Limited. All rights reserved.
* Copyright (c) 2016-2019, Linaro Limited. All rights reserved. * Copyright (c) 2016-2019, Linaro Limited. All rights reserved.
* Copyright (c) 2021, Ampere Computing LLC. All rights reserved.
* *
* SPDX-License-Identifier: BSD-2-Clause-Patent * SPDX-License-Identifier: BSD-2-Clause-Patent
* *
@ -52,18 +53,45 @@
#define SEC_PER_HOUR ((UINTN) 3600) #define SEC_PER_HOUR ((UINTN) 3600)
#define SEC_PER_DAY ((UINTN) 86400) #define SEC_PER_DAY ((UINTN) 86400)
/**
Check if it is a leap year.
@param Time The UEFI time to be checked.
@retval TRUE It is a leap year.
@retval FALSE It is NOT a leap year.
**/
BOOLEAN BOOLEAN
EFIAPI EFIAPI
IsLeapYear ( IsLeapYear (
IN EFI_TIME *Time IN EFI_TIME *Time
); );
/**
Check if the day in the UEFI time is valid.
@param Time The UEFI time to be checked.
@retval TRUE Valid.
@retval FALSE Invalid.
**/
BOOLEAN BOOLEAN
EFIAPI EFIAPI
IsDayValid ( IsDayValid (
IN EFI_TIME *Time IN EFI_TIME *Time
); );
/**
Check if the UEFI time is valid.
@param Time The UEFI time to be checked.
@retval TRUE Valid.
@retval FALSE Invalid.
**/
BOOLEAN BOOLEAN
EFIAPI EFIAPI
IsTimeValid ( IsTimeValid (
@ -71,8 +99,12 @@ IsTimeValid (
); );
/** /**
Converts Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC) to EFI_TIME Converts Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC) to EFI_TIME.
**/
@param EpochSeconds Epoch seconds.
@param Time The time converted to UEFI format.
**/
VOID VOID
EFIAPI EFIAPI
EpochToEfiTime ( EpochToEfiTime (
@ -81,8 +113,13 @@ EpochToEfiTime (
); );
/** /**
Converts EFI_TIME to Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC) Converts EFI_TIME to Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC).
**/
@param Time The UEFI time to be converted.
@return Number of seconds.
**/
UINTN UINTN
EFIAPI EFIAPI
EfiTimeToEpoch ( EfiTimeToEpoch (
@ -90,8 +127,13 @@ EfiTimeToEpoch (
); );
/** /**
returns Day of the week [0-6] 0=Sunday Get the day of the week from the UEFI time.
**/
@param Time The UEFI time to be calculated.
@return The day of the week: Sunday=0, Monday=1, ... Saturday=6
**/
UINTN UINTN
EfiTimeToWday ( EfiTimeToWday (
IN EFI_TIME *Time IN EFI_TIME *Time

64
EmbeddedPkg/Library/TimeBaseLib/TimeBaseLib.c
View File

@ -2,6 +2,7 @@
* *
* Copyright (c) 2016, Hisilicon Limited. All rights reserved. * Copyright (c) 2016, Hisilicon Limited. All rights reserved.
* Copyright (c) 2016-2019, Linaro Limited. All rights reserved. * Copyright (c) 2016-2019, Linaro Limited. All rights reserved.
* Copyright (c) 2021, Ampere Computing LLC. All rights reserved.
* *
* SPDX-License-Identifier: BSD-2-Clause-Patent * SPDX-License-Identifier: BSD-2-Clause-Patent
* *
@ -13,8 +14,12 @@
#include <Library/TimeBaseLib.h> #include <Library/TimeBaseLib.h>
/** /**
Converts Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC) to EFI_TIME Converts Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC) to EFI_TIME.
**/
@param EpochSeconds Epoch seconds.
@param Time The time converted to UEFI format.
**/
VOID VOID
EFIAPI EFIAPI
EpochToEfiTime ( EpochToEfiTime (
@ -71,8 +76,13 @@ EpochToEfiTime (
} }
/** /**
Calculate Epoch days Calculate Epoch days.
**/
@param Time The UEFI time to be calculated.
@return Number of days.
**/
UINTN UINTN
EFIAPI EFIAPI
EfiGetEpochDays ( EfiGetEpochDays (
@ -96,9 +106,15 @@ EfiGetEpochDays (
return EpochDays; return EpochDays;
} }
/** /**
Converts EFI_TIME to Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC) Converts EFI_TIME to Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC).
**/
@param Time The UEFI time to be converted.
@return Number of seconds.
**/
UINTN UINTN
EFIAPI EFIAPI
EfiTimeToEpoch ( EfiTimeToEpoch (
@ -116,8 +132,13 @@ EfiTimeToEpoch (
} }
/** /**
returns Day of the week [0-6] 0=Sunday Get the day of the week from the UEFI time.
**/
@param Time The UEFI time to be calculated.
@return The day of the week: Sunday=0, Monday=1, ... Saturday=6
**/
UINTN UINTN
EfiTimeToWday ( EfiTimeToWday (
IN EFI_TIME *Time IN EFI_TIME *Time
@ -132,6 +153,15 @@ EfiTimeToWday (
return (EpochDays + 4) % 7; return (EpochDays + 4) % 7;
} }
/**
Check if it is a leap year.
@param Time The UEFI time to be checked.
@retval TRUE It is a leap year.
@retval FALSE It is NOT a leap year.
**/
BOOLEAN BOOLEAN
EFIAPI EFIAPI
IsLeapYear ( IsLeapYear (
@ -153,6 +183,15 @@ IsLeapYear (
} }
} }
/**
Check if the day in the UEFI time is valid.
@param Time The UEFI time to be checked.
@retval TRUE Valid.
@retval FALSE Invalid.
**/
BOOLEAN BOOLEAN
EFIAPI EFIAPI
IsDayValid ( IsDayValid (
@ -171,6 +210,15 @@ IsDayValid (
return TRUE; return TRUE;
} }
/**
Check if the UEFI time is valid.
@param Time The UEFI time to be checked.
@retval TRUE Valid.
@retval FALSE Invalid.
**/
BOOLEAN BOOLEAN
EFIAPI EFIAPI
IsTimeValid( IsTimeValid(