OvmfPkg/PlatformPei/Cmos.h

   1 /** @file
   2   PC/AT CMOS access routines
   3
   4   Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __CMOS_H__
  16 #define __CMOS_H__
  17
  18 /**
  19   Reads 8-bits of CMOS data.
  20
  21   Reads the 8-bits of CMOS data at the location specified by Index.
  22   The 8-bit read value is returned.
  23
  24   @param  Index  The CMOS location to read.
  25
  26   @return The value read.
  27
  28 **/
  29 UINT8
  30 EFIAPI
  31 CmosRead8 (
  32   IN      UINTN                     Index
  33   );
  34
  35 /**
  36   Writes 8-bits of CMOS data.
  37
  38   Writes 8-bits of CMOS data to the location specified by Index
  39   with the value specified by Value and returns Value.
  40
  41   @param  Index  The CMOS location to write.
  42   @param  Value  The value to write to CMOS.
  43
  44   @return The value written to CMOS.
  45
  46 **/
  47 UINT8
  48 EFIAPI
  49 CmosWrite8 (
  50   IN      UINTN                     Index,
  51   IN      UINT8                     Value
  52   );
  53
  54
  55 #endif
  56