Add device abstraction code for the UEFI Console and UEFI Shell-based file systems.

[mirror_edk2.git] / StdLib / Include / time.h

/** @file\r
    The header <time.h> defines two macros, and declares several types and\r
    functions for manipulating time.  Many functions deal with a calendar time\r
    that represents the current date (according to the Gregorian calendar) and\r
    time.  Some functions deal with local time, which is the calendar time\r
    expressed for some specific time zone, and with Daylight Saving Time, which\r
    is a temporary change in the algorithm for determining local time.  The local\r
    time zone and Daylight Saving Time are implementation-defined.\r
\r
    The macros defined are NULL; and CLOCKS_PER_SEC which expands to an\r
    expression with type clock_t (described below) that is the number per second\r
    of the value returned by the clock function.\r
\r
    The types declared are size_t along with clock_t and time_t which are\r
    arithmetic types capable of representing times; and struct tm which holds\r
    the components of a calendar time, called the broken-down time.\r
\r
    The range and precision of times representable in clock_t and time_t are\r
    implementation-defined. The tm structure shall contain at least the following\r
    members, in any order.  The semantics of the members and their normal ranges\r
    are expressed in the comments.\r
      - int tm_sec;   // seconds after the minute - [0, 60]\r
      - int tm_min;   // minutes after the hour - [0, 59]\r
      - int tm_hour;  // hours since midnight - [0, 23]\r
      - int tm_mday;  // day of the month - [1, 31]\r
      - int tm_mon;   // months since January - [0, 11]\r
      - int tm_year;  // years since 1900\r
      - int tm_wday;  // days since Sunday - [0, 6]\r
      - int tm_yday;  // days since January 1 - [0, 365]\r
      - int tm_isdst; // Daylight Saving Time flag\r
\r
    The value of tm_isdst is positive if Daylight Saving Time is in effect, zero\r
    if Daylight Saving Time is not in effect, and negative if the information\r
    is not available.\r
\r
    Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
    This program and the accompanying materials are licensed and made available under\r
    the terms and conditions of the BSD License that accompanies this distribution.\r
    The full text of the license may be found at\r
    http://opensource.org/licenses/bsd-license.php.\r
\r
    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
#ifndef _TIME_H\r
#define _TIME_H\r
#include <sys/EfiCdefs.h>\r
\r
#define CLOCKS_PER_SEC  __getCPS()\r
\r
#ifdef _EFI_SIZE_T_\r
  typedef _EFI_SIZE_T_  size_t;\r
  #undef _EFI_SIZE_T_\r
  #undef _BSD_SIZE_T_\r
#endif\r
\r
/** An arithmetic type capable of representing values returned by clock(); **/\r
#ifdef _EFI_CLOCK_T\r
  typedef _EFI_CLOCK_T  clock_t;\r
  #undef _EFI_CLOCK_T\r
#endif\r
\r
/** An arithmetic type capable of representing values returned as calendar time\r
    values, such as that returned by mktime();\r
**/\r
#ifdef _EFI_TIME_T\r
  typedef _EFI_TIME_T  time_t;\r
  #undef _EFI_TIME_T\r
#endif\r
\r
/** A structure holding the components of a calendar time, called the\r
    broken-down time.  The first nine (9) members are as mandated by the\r
    C95 standard.  Additional fields have been added for EFI support.\r
**/\r
struct tm {\r
  int     tm_year;      // years since 1900\r