refine comments for EFI_CONSOLE_CONTROL_PROTOCOL
[edk2.git] / UnixPkg / MetronomeDxe / Metronome.h
blob10e6dc9b8acba31d397cd48d81fcff6e464dc8b7
1 /*++
3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. 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
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.
12 Module Name:
14 Metronome.h
16 Abstract:
18 UNIX Emulation Metronome Architectural Protocol Driver as defined in DXE CIS
20 --*/
22 #ifndef _UNIX_THUNK_METRONOME_H_
23 #define _UNIX_THUNK_METRONOME_H_
28 // Period of on tick in 100 nanosecond units
30 #define TICK_PERIOD 2000
33 // Function Prototypes
36 EFI_STATUS
37 EFIAPI
38 UnixMetronomeDriverInitialize (
39 IN EFI_HANDLE ImageHandle,
40 IN EFI_SYSTEM_TABLE *SystemTable
42 /*++
44 Routine Description:
46 TODO: Add function description
48 Arguments:
50 ImageHandle - TODO: add argument description
51 SystemTable - TODO: add argument description
53 Returns:
55 TODO: add return values
57 --*/
60 EFI_STATUS
61 EFIAPI
62 UnixMetronomeDriverWaitForTick (
63 IN EFI_METRONOME_ARCH_PROTOCOL *This,
64 IN UINT32 TickNumber
66 /*++
68 Routine Description:
70 TODO: Add function description
72 Arguments:
74 This - TODO: add argument description
75 TickNumber - TODO: add argument description
77 Returns:
79 TODO: add return values
81 --*/
84 #endif