[mirror_edk2.git] / MdeModulePkg / Universal / Metronome / Metronome.uni

// /** @file\r
// This module produces the Metronome Architectural Protocol on top of Timer Library.\r
//\r
// This is a generic implementation of the Metronome Architectural Protocol that\r
// layers on top of an instance of the Timer Library.  The Timer Library provides\r
// functions for nanosecond and microsecond delays.  This generic implementation\r
// produces a fixed TickPeriod of 100ns unit, and when the WaitForTick() service\r
// is called, the number of ticks passed in is converted to either nanosecond or\r
// microsecond units.  If the number of ticks is small, then nanoseconds are used.\r
// If the number of ticks is large, then microseconds are used.  This prevents\r
// overflows that could occur for long delays if only nanoseconds were used and also\r
// provides the greatest accuracy for small delays.\r
//\r
// Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
//\r
// 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
// **/\r
\r
\r
#string STR_MODULE_ABSTRACT             #language en-US "Produces the Metronome Architectural Protocol on top of Timer Library"\r
\r
#string STR_MODULE_DESCRIPTION          #language en-US "This is a generic implementation of the Metronome Architectural Protocol that layers on top of an instance of the Timer Library.  The Timer Library provides functions for nanosecond and microsecond delays.  This generic implementation produces a fixed TickPeriod of 100ns unit, and when the WaitForTick() service is called, the number of ticks passed in is converted to either nanosecond or microsecond units.  If the number of ticks is small, then nanoseconds are used. If the number of ticks is large, then microseconds are used.  This prevents overflows that could occur for long delays if only nanoseconds were used and also provides the greatest accuracy for small delays."\r
\r
Commit	Line	Data
3f528797 JJ	1	// /** @file\r
	2	// This module produces the Metronome Architectural Protocol on top of Timer Library.\r
	3	//\r
	4	// This is a generic implementation of the Metronome Architectural Protocol that\r
	5	// layers on top of an instance of the Timer Library. The Timer Library provides\r
	6	// functions for nanosecond and microsecond delays. This generic implementation\r
	7	// produces a fixed TickPeriod of 100ns unit, and when the WaitForTick() service\r
	8	// is called, the number of ticks passed in is converted to either nanosecond or\r
	9	// microsecond units. If the number of ticks is small, then nanoseconds are used.\r
	10	// If the number of ticks is large, then microseconds are used. This prevents\r
	11	// overflows that could occur for long delays if only nanoseconds were used and also\r
	12	// provides the greatest accuracy for small delays.\r
	13	//\r
	14	// Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
	15	//\r
	16	// This program and the accompanying materials\r
	17	// are licensed and made available under the terms and conditions of the BSD License\r
	18	// which accompanies this distribution. The full text of the license may be found at\r
	19	// http://opensource.org/licenses/bsd-license.php\r
	20	// \r
	21	// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	22	// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	23	//\r
	24	// **/\r
	25	\r
	26	\r
	27	#string STR_MODULE_ABSTRACT #language en-US "Produces the Metronome Architectural Protocol on top of Timer Library"\r
	28	\r
	29	#string STR_MODULE_DESCRIPTION #language en-US "This is a generic implementation of the Metronome Architectural Protocol that layers on top of an instance of the Timer Library. The Timer Library provides functions for nanosecond and microsecond delays. This generic implementation produces a fixed TickPeriod of 100ns unit, and when the WaitForTick() service is called, the number of ticks passed in is converted to either nanosecond or microsecond units. If the number of ticks is small, then nanoseconds are used. If the number of ticks is large, then microseconds are used. This prevents overflows that could occur for long delays if only nanoseconds were used and also provides the greatest accuracy for small delays."\r
	30	\r