DuetPkg/LegacyMetronome/Metronome.h

   1 /*++
   2
   3 Copyright (c) 2005, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13   LegacyMetronome.h
  14
  15 Abstract:
  16
  17   Driver implementing the EFI 2.0 metronome protocol using the legacy PORT 61
  18   timer.
  19
  20 --*/
  21
  22 #ifndef _LEGACY_METRONOME_H
  23 #define _LEGACY_METRONOME_H
  24
  25 //
  26 // Statements that include other files
  27 //
  28 #include <PiDxe.h>
  29
  30 #include <Protocol/Metronome.h>
  31
  32 #include <Library/DebugLib.h>
  33 #include <Library/UefiBootServicesTableLib.h>
  34 #include <Library/IoLib.h>
  35
  36 //
  37 // Private definitions
  38 //
  39 #define TICK_PERIOD         300
  40 #define REFRESH_PORT        0x61
  41 #define REFRESH_ON          0x10
  42 #define REFRESH_OFF         0x00
  43 #define TIMER1_CONTROL_PORT 0x43
  44 #define TIMER1_COUNT_PORT   0x41
  45 #define LOAD_COUNTER1_LSB   0x54
  46 #define COUNTER1_COUNT      0x12
  47
  48 //
  49 // Function Prototypes
  50 //
  51 EFI_STATUS
  52 EFIAPI
  53 WaitForTick (
  54   IN EFI_METRONOME_ARCH_PROTOCOL  *This,
  55   IN UINT32                       TickNumber
  56   )
  57 /*++
  58
  59 Routine Description:
  60
  61   TODO: Add function description
  62
  63 Arguments:
  64
  65   This        - TODO: add argument description
  66   TickNumber  - TODO: add argument description
  67
  68 Returns:
  69
  70   TODO: add return values
  71
  72 --*/
  73 ;
  74
  75 #endif