sync comments, fix function header, rename variable name to follow coding style.

[mirror_edk2.git] / DuetPkg / LegacyMetronome / Metronome.h

/*++\r
\r
Copyright (c) 2005, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  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
Module Name:\r
  LegacyMetronome.h\r
\r
Abstract:\r
\r
  Driver implementing the EFI 2.0 metronome protocol using the legacy PORT 61 \r
  timer.\r
\r
--*/\r
\r
#ifndef _LEGACY_METRONOME_H\r
#define _LEGACY_METRONOME_H\r
\r
//\r
// Statements that include other files\r
//\r
#include <PiDxe.h>\r
\r
#include <Protocol/Metronome.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/IoLib.h>\r
\r
//\r
// Private definitions\r
//\r
#define TICK_PERIOD         300\r
#define REFRESH_PORT        0x61\r
#define REFRESH_ON          0x10\r
#define REFRESH_OFF         0x00\r
#define TIMER1_CONTROL_PORT 0x43\r
#define TIMER1_COUNT_PORT   0x41\r
#define LOAD_COUNTER1_LSB   0x54\r
#define COUNTER1_COUNT      0x12\r
\r
//\r
// Function Prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
WaitForTick (\r
  IN EFI_METRONOME_ARCH_PROTOCOL  *This,\r
  IN UINT32                       TickNumber\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This        - TODO: add argument description\r
  TickNumber  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r