Porting Duet module from EDKI to EDKII

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5076 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 352 insertions, 0 deletions

diff --git a/DuetPkg/LegacyMetronome/Metronome.c b/DuetPkg/LegacyMetronome/Metronome.c
new file mode 100644
index 0000000000..acc0dad45c
--- /dev/null
+++ b/DuetPkg/LegacyMetronome/Metronome.c
@@ -0,0 +1,201 @@
+/*++

+

+Copyright (c) 2005, Intel Corporation                                                         

+All rights reserved. This program and the accompanying materials                          

+are licensed and made available under the terms and conditions of the BSD License         

+which accompanies this distribution.  The full text of the license may be found at        

+http://opensource.org/licenses/bsd-license.php                                            

+                                                                                          

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+Module Name:

+  LegacyMetronome.c

+

+Abstract:

+

+  This contains the installation function for the driver.

+

+--*/

+

+#include "Metronome.h"

+

+//

+// Handle for the Metronome Architectural Protocol instance produced by this driver

+//

+EFI_HANDLE                  mMetronomeHandle = NULL;

+

+//

+// The Metronome Architectural Protocol instance produced by this driver

+//

+EFI_METRONOME_ARCH_PROTOCOL mMetronome = {

+  WaitForTick,

+  TICK_PERIOD

+};

+

+//

+// The CPU I/O Protocol used to access system hardware

+//

+EFI_CPU_IO_PROTOCOL         *mCpuIo = NULL;

+

+//

+// Worker Functions

+//

+VOID

+IoWrite8 (

+  UINT16  Port,

+  UINT8   Data

+  )

+/*++

+

+Routine Description:

+

+  Write an 8 bit value to an I/O port and save it to the S3 script

+

+Arguments:

+

+Returns: 

+

+  None.

+

+--*/

+// TODO:    Port - add argument and description to function comment

+// TODO:    Data - add argument and description to function comment

+{

+  mCpuIo->Io.Write (

+              mCpuIo,

+              EfiCpuIoWidthUint8,

+              Port,

+              1,

+              &Data

+              );

+

+}

+

+UINT8

+ReadRefresh (

+  VOID

+  )

+/*++

+

+Routine Description:

+

+  Read the refresh bit from the REFRESH_PORT

+

+Arguments:

+

+Returns: 

+

+  None.

+

+--*/

+{

+  UINT8 Data;

+

+  mCpuIo->Io.Read (

+              mCpuIo,

+              EfiCpuIoWidthUint8,

+              REFRESH_PORT,

+              1,

+              &Data

+              );

+  return (UINT8) (Data & REFRESH_ON);

+}

+

+EFI_STATUS

+EFIAPI

+WaitForTick (

+  IN EFI_METRONOME_ARCH_PROTOCOL  *This,

+  IN UINT32                       TickNumber

+  )

+/*++

+

+Routine Description:

+

+  Waits for the TickNumber of ticks from a known platform time source.

+

+Arguments:

+

+  This                Pointer to the protocol instance.

+

+Returns: 

+

+  EFI_SUCCESS         If number of ticks occurred.

+  EFI_NOT_FOUND       Could not locate CPU IO protocol

+

+--*/

+// TODO:    TickNumber - add argument and description to function comment

+{

+  //

+  // Wait for TickNumber toggles of the Refresh bit

+  //

+  for (; TickNumber != 0x00; TickNumber--) {

+    while (ReadRefresh () == REFRESH_ON)

+      ;

+    while (ReadRefresh () == REFRESH_OFF)

+      ;

+  }

+

+  return EFI_SUCCESS;

+}

+

+EFI_STATUS

+EFIAPI

+InstallMetronome (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+/*++

+

+Routine Description:

+  

+  Install the LegacyMetronome driver.  Loads a Metronome Arch Protocol based

+  on the Port 61 timer.

+

+Arguments:

+

+  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)

+

+Returns:

+

+  EFI_SUCCESS - Metronome Architectural Protocol Installed

+

+--*/

+// TODO:    ImageHandle - add argument and description to function comment

+// TODO:    SystemTable - add argument and description to function comment

+{

+  EFI_STATUS  Status;

+

+  //

+  // Make sure the Metronome Architectural Protocol is not already installed in the system

+  //

+  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiMetronomeArchProtocolGuid);

+

+  //

+  // Get the CPU I/O Protocol that this driver requires

+  // If the CPU I/O Protocol is not found, then ASSERT because the dependency expression

+  // should guarantee that it is present in the handle database.

+  //

+  Status = gBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &mCpuIo);

+  ASSERT_EFI_ERROR (Status);

+

+  //

+  // Program port 61 timer 1 as refresh timer. We could use ACPI timer in the

+  // future.

+  //

+  IoWrite8 (TIMER1_CONTROL_PORT, LOAD_COUNTER1_LSB);

+  IoWrite8 (TIMER1_COUNT_PORT, COUNTER1_COUNT);

+

+  //

+  // Install on a new handle

+  //

+  Status = gBS->InstallMultipleProtocolInterfaces (

+                  &mMetronomeHandle,

+                  &gEfiMetronomeArchProtocolGuid,

+                  &mMetronome,

+                  NULL

+                  );

+  ASSERT_EFI_ERROR (Status);

+

+  return Status;

+}

diff --git a/DuetPkg/LegacyMetronome/Metronome.dxs b/DuetPkg/LegacyMetronome/Metronome.dxs
new file mode 100644
index 0000000000..6e224957fc
--- /dev/null
+++ b/DuetPkg/LegacyMetronome/Metronome.dxs
@@ -0,0 +1,28 @@
+/*++

+

+Copyright (c) 2005, Intel Corporation                                                         

+All rights reserved. This program and the accompanying materials                          

+are licensed and made available under the terms and conditions of the BSD License         

+which accompanies this distribution.  The full text of the license may be found at        

+http://opensource.org/licenses/bsd-license.php                                            

+                                                                                          

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+Module Name:

+  LegacyMetronome.dxs

+

+Abstract:

+  Dependency expression source file.

+  

+--*/  

+

+

+#include "EfiDepex.h"

+

+#include EFI_PROTOCOL_DEFINITION (CpuIo)

+

+DEPENDENCY_START

+  EFI_CPU_IO_PROTOCOL_GUID 

+DEPENDENCY_END

+

diff --git a/DuetPkg/LegacyMetronome/Metronome.h b/DuetPkg/LegacyMetronome/Metronome.h
new file mode 100644
index 0000000000..87a12cbc34
--- /dev/null
+++ b/DuetPkg/LegacyMetronome/Metronome.h
@@ -0,0 +1,75 @@
+/*++

+

+Copyright (c) 2005, Intel Corporation                                                         

+All rights reserved. This program and the accompanying materials                          

+are licensed and made available under the terms and conditions of the BSD License         

+which accompanies this distribution.  The full text of the license may be found at        

+http://opensource.org/licenses/bsd-license.php                                            

+                                                                                          

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+Module Name:

+  LegacyMetronome.h

+

+Abstract:

+

+  Driver implementing the EFI 2.0 metronome protocol using the legacy PORT 61 

+  timer.

+

+--*/

+

+#ifndef _LEGACY_METRONOME_H

+#define _LEGACY_METRONOME_H

+

+//

+// Statements that include other files

+//

+#include <PiDxe.h>

+

+#include <Protocol/CpuIo.h>

+#include <Protocol/Metronome.h>

+

+#include <Library/DebugLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+

+//

+// Private definitions

+//

+#define TICK_PERIOD         300

+#define REFRESH_PORT        0x61

+#define REFRESH_ON          0x10

+#define REFRESH_OFF         0x00

+#define TIMER1_CONTROL_PORT 0x43

+#define TIMER1_COUNT_PORT   0x41

+#define LOAD_COUNTER1_LSB   0x54

+#define COUNTER1_COUNT      0x12

+

+//

+// Function Prototypes

+//

+EFI_STATUS

+EFIAPI

+WaitForTick (

+  IN EFI_METRONOME_ARCH_PROTOCOL  *This,

+  IN UINT32                       TickNumber

+  )

+/*++

+

+Routine Description:

+

+  TODO: Add function description

+

+Arguments:

+

+  This        - TODO: add argument description

+  TickNumber  - TODO: add argument description

+

+Returns:

+

+  TODO: add return values

+

+--*/

+;

+

+#endif

diff --git a/DuetPkg/LegacyMetronome/Metronome.inf b/DuetPkg/LegacyMetronome/Metronome.inf
new file mode 100644
index 0000000000..d97b67f334
--- /dev/null
+++ b/DuetPkg/LegacyMetronome/Metronome.inf
@@ -0,0 +1,48 @@
+#/*++

+# 

+# Copyright (c) 2005, Intel Corporation                                                         

+# All rights reserved. This program and the accompanying materials                          

+# are licensed and made available under the terms and conditions of the BSD License         

+# which accompanies this distribution.  The full text of the license may be found at        

+# http://opensource.org/licenses/bsd-license.php                                            

+#                                                                                           

+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+#

+#  Module Name:

+#

+#  Abstract:

+#

+#--*/

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = Metronome

+  FILE_GUID                      = 07A9330A-F347-11d4-9A49-0090273FC14D

+  MODULE_TYPE                    = DXE_DRIVER

+  VERSION_STRING                 = 1.0

+  EDK_RELEASE_VERSION            = 0x00020000

+  EFI_SPECIFICATION_VERSION      = 0x00020000

+

+  ENTRY_POINT                    = InstallMetronome

+

+[Packages]

+  MdePkg/MdePkg.dec

+  IntelFrameworkPkg/IntelFrameworkPkg.dec

+  DuetPkg/DuetPkg.dec

+

+[LibraryClasses]

+  UefiDriverEntryPoint

+  DebugLib

+  UefiBootServicesTableLib

+

+[Sources.common]

+  Metronome.c

+  Metronome.h

+

+[Protocols]

+  gEfiMetronomeArchProtocolGuid

+  gEfiCpuIoProtocolGuid

+

+[Depex]

+  gEfiCpuIoProtocolGuid