5 files changed, 609 insertions, 0 deletions
diff --git a/LegacySpeaker/ComponentName.c b/LegacySpeaker/ComponentName.c
new file mode 100644
index 0000000..0b21270
--- /dev/null
+++ b/LegacySpeaker/ComponentName.c
@@ -0,0 +1,134 @@
+/** @file
+  TODO: Brief Description of UEFI Driver LegacySpeaker
+  
+  TODO: Detailed Description of UEFI Driver LegacySpeaker
+
+  TODO: Copyright for UEFI Driver LegacySpeaker
+  
+  TODO: License for UEFI Driver LegacySpeaker
+
+**/
+
+#include "LegacySpeaker.h"
+
+///
+/// Component Name Protocol instance
+///
+GLOBAL_REMOVE_IF_UNREFERENCED 
+EFI_COMPONENT_NAME_PROTOCOL  gLegacySpeakerComponentName = {
+  (EFI_COMPONENT_NAME_GET_DRIVER_NAME)    LegacySpeakerComponentNameGetDriverName,
+  (EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)LegacySpeakerComponentNameGetControllerName,
+  "eng"
+};
+
+///
+/// Component Name 2 Protocol instance
+///
+GLOBAL_REMOVE_IF_UNREFERENCED 
+EFI_COMPONENT_NAME2_PROTOCOL  gLegacySpeakerComponentName2 = {
+  LegacySpeakerComponentNameGetDriverName,
+  LegacySpeakerComponentNameGetControllerName,
+  "en"
+};
+
+///
+/// Table of driver names
+///
+GLOBAL_REMOVE_IF_UNREFERENCED 
+EFI_UNICODE_STRING_TABLE mLegacySpeakerDriverNameTable[] = {
+  { "eng;en", (CHAR16 *)L"LegacySpeaker" },
+  { NULL, NULL }
+};
+
+/**
+  Retrieves a Unicode string that is the user-readable name of the EFI Driver.
+
+  @param  This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
+  @param  Language   A pointer to a three-character ISO 639-2 language identifier.
+                     This is the language of the driver name that that the caller
+                     is requesting, and it must match one of the languages specified
+                     in SupportedLanguages.  The number of languages supported by a
+                     driver is up to the driver writer.
+  @param  DriverName A pointer to the Unicode string to return.  This Unicode string
+                     is the name of the driver specified by This in the language
+                     specified by Language.
+
+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by This
+                                and the language specified by Language was returned
+                                in DriverName.
+  @retval EFI_INVALID_PARAMETER Language is NULL.
+  @retval EFI_INVALID_PARAMETER DriverName is NULL.
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
+                                language specified by Language.
+
+**/
+EFI_STATUS
+EFIAPI
+LegacySpeakerComponentNameGetDriverName (
+  IN EFI_COMPONENT_NAME2_PROTOCOL  *This,
+  IN  CHAR8                        *Language,
+  OUT CHAR16                       **DriverName
+  )
+{
+  return LookupUnicodeString2 (
+           Language,
+           This->SupportedLanguages,
+           mLegacySpeakerDriverNameTable,
+           DriverName,
+           (BOOLEAN)(This != &gLegacySpeakerComponentName2)
+           );
+}
+
+/**
+  Retrieves a Unicode string that is the user readable name of the controller
+  that is being managed by an EFI Driver.
+
+  @param  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
+  @param  ControllerHandle The handle of a controller that the driver specified by
+                           This is managing.  This handle specifies the controller
+                           whose name is to be returned.
+  @param  ChildHandle      The handle of the child controller to retrieve the name
+                           of.  This is an optional parameter that may be NULL.  It
+                           will be NULL for device drivers.  It will also be NULL
+                           for a bus drivers that wish to retrieve the name of the
+                           bus controller.  It will not be NULL for a bus driver
+                           that wishes to retrieve the name of a child controller.
+  @param  Language         A pointer to a three character ISO 639-2 language
+                           identifier.  This is the language of the controller name
+                           that the caller is requesting, and it must match one
+                           of the languages specified in SupportedLanguages.  The
+                           number of languages supported by a driver is up to the
+                           driver writer.
+  @param  ControllerName   A pointer to the Unicode string to return.  This Unicode
+                           string is the name of the controller specified by
+                           ControllerHandle and ChildHandle in the language specified
+                           by Language, from the point of view of the driver specified
+                           by This.
+
+  @retval EFI_SUCCESS           The Unicode string for the user-readable name in the
+                                language specified by Language for the driver
+                                specified by This was returned in DriverName.
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
+  @retval EFI_INVALID_PARAMETER Language is NULL.
+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.
+  @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing
+                                the controller specified by ControllerHandle and
+                                ChildHandle.
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
+                                language specified by Language.
+
+**/
+EFI_STATUS
+EFIAPI
+LegacySpeakerComponentNameGetControllerName (
+  IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
+  IN  EFI_HANDLE                    ControllerHandle,
+  IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
+  IN  CHAR8                         *Language,
+  OUT CHAR16                        **ControllerName
+  )
+{
+	EFI_STATUS  Status = EFI_SUCCESS;
+  return Status;
+}
diff --git a/LegacySpeaker/ComponentName.h b/LegacySpeaker/ComponentName.h
new file mode 100644
index 0000000..5f3920b
--- /dev/null
+++ b/LegacySpeaker/ComponentName.h
@@ -0,0 +1,90 @@
+/** @file
+  TODO: Brief Description of UEFI Driver LegacySpeaker
+  
+  TODO: Detailed Description of UEFI Driver LegacySpeaker
+
+  TODO: Copyright for UEFI Driver LegacySpeaker
+  
+  TODO: License for UEFI Driver LegacySpeaker
+
+**/
+
+/**
+  Retrieves a Unicode string that is the user-readable name of the EFI Driver.
+
+  @param  This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
+  @param  Language   A pointer to a three-character ISO 639-2 language identifier.
+                     This is the language of the driver name that that the caller
+                     is requesting, and it must match one of the languages specified
+                     in SupportedLanguages.  The number of languages supported by a
+                     driver is up to the driver writer.
+  @param  DriverName A pointer to the Unicode string to return.  This Unicode string
+                     is the name of the driver specified by This in the language
+                     specified by Language.
+
+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by This
+                                and the language specified by Language was returned
+                                in DriverName.
+  @retval EFI_INVALID_PARAMETER Language is NULL.
+  @retval EFI_INVALID_PARAMETER DriverName is NULL.
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
+                                language specified by Language.
+
+**/
+EFI_STATUS
+EFIAPI
+LegacySpeakerComponentNameGetDriverName (
+  IN EFI_COMPONENT_NAME2_PROTOCOL  *This,
+  IN  CHAR8                        *Language,
+  OUT CHAR16                       **DriverName
+  );
+
+/**
+  Retrieves a Unicode string that is the user readable name of the controller
+  that is being managed by an EFI Driver.
+
+  @param  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
+  @param  ControllerHandle The handle of a controller that the driver specified by
+                           This is managing.  This handle specifies the controller
+                           whose name is to be returned.
+  @param  ChildHandle      The handle of the child controller to retrieve the name
+                           of.  This is an optional parameter that may be NULL.  It
+                           will be NULL for device drivers.  It will also be NULL
+                           for a bus drivers that wish to retrieve the name of the
+                           bus controller.  It will not be NULL for a bus driver
+                           that wishes to retrieve the name of a child controller.
+  @param  Language         A pointer to a three character ISO 639-2 language
+                           identifier.  This is the language of the controller name
+                           that the caller is requesting, and it must match one
+                           of the languages specified in SupportedLanguages.  The
+                           number of languages supported by a driver is up to the
+                           driver writer.
+  @param  ControllerName   A pointer to the Unicode string to return.  This Unicode
+                           string is the name of the controller specified by
+                           ControllerHandle and ChildHandle in the language specified
+                           by Language, from the point of view of the driver specified
+                           by This.
+
+  @retval EFI_SUCCESS           The Unicode string for the user-readable name in the
+                                language specified by Language for the driver
+                                specified by This was returned in DriverName.
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
+  @retval EFI_INVALID_PARAMETER Language is NULL.
+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.
+  @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing
+                                the controller specified by ControllerHandle and
+                                ChildHandle.
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
+                                language specified by Language.
+
+**/
+EFI_STATUS
+EFIAPI
+LegacySpeakerComponentNameGetControllerName (
+  IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
+  IN  EFI_HANDLE                    ControllerHandle,
+  IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
+  IN  CHAR8                         *Language,
+  OUT CHAR16                        **ControllerName
+  );
diff --git a/LegacySpeaker/LegacySpeaker.c b/LegacySpeaker/LegacySpeaker.c
new file mode 100644
index 0000000..2f7b1b9
--- /dev/null
+++ b/LegacySpeaker/LegacySpeaker.c
@@ -0,0 +1,238 @@
+/** @file
+  TODO: Brief Description of UEFI Driver LegacySpeaker
+  
+  TODO: Detailed Description of UEFI Driver LegacySpeaker
+
+  TODO: Copyright for UEFI Driver LegacySpeaker
+  
+  TODO: License for UEFI Driver LegacySpeaker
+
+**/
+
+#include "LegacySpeaker.h"
+#include <Library/IoLib.h>
+
+//////////////////////////////////////////////////////////////////////////
+// Speaker
+//////////////////////////////////////////////////////////////////////////
+/**
+
+  This function will enable the speaker to generate beep
+
+  @retval EFI_STATUS
+
+**/
+EFI_STATUS
+TurnOnSpeaker (
+  )
+{
+  UINT8                   Data;
+  Data = IoRead8 (EFI_SPEAKER_CONTROL_PORT);
+  Data |= 0x03;
+  IoWrite8(EFI_SPEAKER_CONTROL_PORT, Data);
+  return EFI_SUCCESS;
+}
+
+/**
+
+  This function will stop beep from speaker.
+
+  @retval Status
+
+**/
+EFI_STATUS
+TurnOffSpeaker (
+  )
+{
+  UINT8                   Data;
+
+  Data = IoRead8 (EFI_SPEAKER_CONTROL_PORT);
+  Data &= 0xFC;
+  IoWrite8(EFI_SPEAKER_CONTROL_PORT, Data);
+  return EFI_SUCCESS;
+}
+
+/**
+  Generate beep sound based upon number of beeps and duration of the beep
+
+  @param NumberOfBeeps     Number of beeps which user want to produce
+  @param BeepDuration      Duration for speaker gate need to be enabled
+  @param TimeInterval      Interval between each beep
+
+  @retval      Does not return if the reset takes place.
+               EFI_INVALID_PARAMETER   If ResetType is invalid.
+
+**/
+EFI_STATUS
+OutputBeep (
+  IN     UINTN                              NumberOfBeep,
+  IN     UINTN                              BeepDuration,
+  IN     UINTN                              TimeInterval
+  )
+{
+  UINTN           Num;
+
+  for (Num=0; Num < NumberOfBeep; Num++) {
+    TurnOnSpeaker ();
+    //
+    // wait some time,at least 120us
+    //
+    gBS->Stall (BeepDuration);
+    TurnOffSpeaker();
+    gBS->Stall (TimeInterval);
+  }
+
+  return EFI_SUCCESS;
+}
+
+/**
+  This function will program the speaker tone frequency. The value should be with 64k
+  boundary since it takes only 16 bit value which gets programmed in two step IO opearattion
+
+  @param  Frequency     A value which should be 16 bit only.
+
+  @retval EFI_SUCESS
+
+**/
+EFI_STATUS
+EFIAPI    
+ProgramToneFrequency (
+  IN EFI_SPEAKER_IF_PROTOCOL            * This,
+  IN  UINT16                            Frequency
+  )
+{
+  UINT8                   Data;
+
+  Data = 0xB6;
+  IoWrite8(EFI_TIMER_CONTROL_PORT, Data);
+
+  Data = (UINT8)(Frequency & 0x00FF);
+  IoWrite8(EFI_TIMER_2_PORT, Data);
+  Data = (UINT8)((Frequency & 0xFF00) >> 8);
+  IoWrite8(EFI_TIMER_2_PORT, Data);
+  return EFI_SUCCESS;
+}
+
+/**
+  This function will generate the beep for specified duration.
+
+  @param NumberOfBeeps     Number of beeps which user want to produce
+  @param BeepDuration      Duration for speaker gate need to be enabled
+  @param TimeInterval      Interval between each beep
+
+  @retval EFI_STATUS
+
+**/
+EFI_STATUS
+EFIAPI
+GenerateBeepTone (
+  IN EFI_SPEAKER_IF_PROTOCOL            * This,
+  IN  UINTN                             NumberOfBeeps,
+  IN  UINTN                             BeepDuration,
+  IN  UINTN                             TimeInterval
+  )
+{
+
+  if ((NumberOfBeeps == 1) && (BeepDuration == 0) && (TimeInterval == 0)) {
+    TurnOnSpeaker ();
+    return EFI_SUCCESS;
+  }
+
+  if ((NumberOfBeeps == 0) && (BeepDuration == 0) && (TimeInterval == 0)) {
+    TurnOffSpeaker ();
+    return EFI_SUCCESS;
+  }
+
+  if (BeepDuration == 0) {
+    BeepDuration = EFI_DEFAULT_SHORT_BEEP_DURATION;
+  }
+
+  if (TimeInterval == 0) {
+    TimeInterval = EFI_DEFAULT_BEEP_TIME_INTERVAL;
+  }
+
+  OutputBeep (NumberOfBeeps, BeepDuration, TimeInterval);
+  return EFI_SUCCESS;
+}
+
+GUID gEfiSpeakerInterfaceProtocolGuid = EFI_SPEAKER_INTERFACE_PROTOCOL_GUID;
+EFI_SPEAKER_IF_PROTOCOL gEfiSpeakerInterfaceProtocol = {
+	ProgramToneFrequency,
+	GenerateBeepTone
+};
+
+//////////////////////////////////////////////////////////////////////////
+// Driver
+//////////////////////////////////////////////////////////////////////////
+
+/**
+  Unloads an image.
+
+  @param  ImageHandle           Handle that identifies the image to be unloaded.
+
+  @retval EFI_SUCCESS           The image has been unloaded.
+  @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
+
+**/
+EFI_STATUS 
+EFIAPI
+LegacySpeakerUnload (
+  IN EFI_HANDLE  ImageHandle
+  )
+{
+  EFI_STATUS  Status;
+
+  Status = EFI_SUCCESS;
+  //
+  // Uninstall Driver Supported EFI Version Protocol onto ImageHandle
+  //
+  Status = gBS->UninstallMultipleProtocolInterfaces(
+	  ImageHandle,
+	  &gEfiSpeakerInterfaceProtocolGuid, &gEfiSpeakerInterfaceProtocol,
+	  NULL
+	  );
+
+  if (EFI_ERROR(Status)) {
+	  return Status;
+  }
+  // Clean up
+  return EFI_SUCCESS;
+}
+
+/**
+  This is the declaration of an EFI image entry point. This entry point is
+  the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
+  both device drivers and bus drivers.
+
+  @param  ImageHandle           The firmware allocated handle for the UEFI image.
+  @param  SystemTable           A pointer to the EFI System Table.
+
+  @retval EFI_SUCCESS           The operation completed successfully.
+  @retval Others                An unexpected error occurred.
+**/
+EFI_STATUS
+EFIAPI
+LegacySpeakerDriverEntryPoint (
+  IN EFI_HANDLE        ImageHandle,
+  IN EFI_SYSTEM_TABLE  *SystemTable
+  )
+{
+  EFI_STATUS  Status;
+
+  Status = EFI_SUCCESS;
+
+  //
+  // Install Speaker protocol onto ImageHandle
+  //
+  Status = gBS->InstallMultipleProtocolInterfaces(
+	  &ImageHandle,
+	  &gEfiSpeakerInterfaceProtocolGuid, &gEfiSpeakerInterfaceProtocol,
+	  NULL
+	  );
+  ASSERT_EFI_ERROR(Status);
+//  gEfiSpeakerInterfaceProtocol.SetSpeakerToneFrequency(&gEfiSpeakerInterfaceProtocol, 0x500);
+//  gEfiSpeakerInterfaceProtocol.GenerateBeep(&gEfiSpeakerInterfaceProtocol, 2, 200000, 200000);
+
+  return Status;
+}
+
diff --git a/LegacySpeaker/LegacySpeaker.h b/LegacySpeaker/LegacySpeaker.h
new file mode 100644
index 0000000..6d90b13
--- /dev/null
+++ b/LegacySpeaker/LegacySpeaker.h
@@ -0,0 +1,101 @@
+/** @file
+  TODO: Brief Description of UEFI Driver LegacySpeaker
+  
+  TODO: Detailed Description of UEFI Driver LegacySpeaker
+
+  TODO: Copyright for UEFI Driver LegacySpeaker
+  
+  TODO: License for UEFI Driver LegacySpeaker
+
+**/
+
+#ifndef __EFI_LEGACY_SPEAKER_H__
+#define __EFI_LEGACY_SPEAKER_H__
+
+#include <Uefi.h>
+
+//
+// Libraries
+//
+#include <Library/UefiBootServicesTableLib.h>
+#include <Library/MemoryAllocationLib.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/BaseLib.h>
+#include <Library/UefiLib.h>
+#include <Library/DevicePathLib.h>
+#include <Library/DebugLib.h>
+
+//
+// UEFI Driver Model Protocols
+//
+#include <Protocol/ComponentName2.h>
+#include <Protocol/ComponentName.h>
+
+//
+// Consumed Protocols
+//
+
+//
+// Produced Protocols
+//
+#include <Protocol/Speaker.h>
+
+
+//
+// Protocol instances
+//
+extern EFI_COMPONENT_NAME2_PROTOCOL  gLegacySpeakerComponentName2;
+extern EFI_COMPONENT_NAME_PROTOCOL  gLegacySpeakerComponentName;
+extern EFI_SPEAKER_IF_PROTOCOL gEfiSpeakerInterfaceProtocol;
+
+//
+// Include files with function prototypes
+//
+#include "ComponentName.h"
+
+//
+// Speaker Related Port Information
+//
+#define EFI_TIMER_COUNTER_PORT            0x40
+#define EFI_TIMER_CONTROL_PORT            0x43
+#define EFI_TIMER_2_PORT                  0x42
+#define EFI_SPEAKER_CONTROL_PORT          0x61
+
+#define EFI_SPEAKER_OFF_MASK              0xFC
+
+#define EFI_DEFAULT_BEEP_FREQUENCY        0x500
+
+//
+// Default Intervals/Beep Duration
+//
+#define EFI_DEFAULT_LONG_BEEP_DURATION    0x70000
+#define EFI_DEFAULT_SHORT_BEEP_DURATION   0x50000
+#define EFI_DEFAULT_BEEP_TIME_INTERVAL    0x20000
+
+
+EFI_STATUS
+EFIAPI
+ProgramToneFrequency(
+	IN  EFI_SPEAKER_IF_PROTOCOL           * This,
+	IN  UINT16                            Frequency
+	);
+
+
+EFI_STATUS
+EFIAPI
+GenerateBeepTone(
+	IN  EFI_SPEAKER_IF_PROTOCOL           * This,
+	IN  UINTN                             NumberOfBeeps,
+	IN  UINTN                             BeepDuration,
+	IN  UINTN                             TimeInterval
+	);
+
+EFI_STATUS
+TurnOnSpeaker(
+	);
+
+EFI_STATUS
+TurnOffSpeaker(
+	);
+
+#endif
diff --git a/LegacySpeaker/LegacySpeaker.inf b/LegacySpeaker/LegacySpeaker.inf
new file mode 100644
index 0000000..50dfc7f
--- /dev/null
+++ b/LegacySpeaker/LegacySpeaker.inf
@@ -0,0 +1,46 @@
+## @file
+#  TODO: Brief Description of UEFI Driver LegacySpeaker
+#  
+#  TODO: Detailed Description of UEFI Driver LegacySpeaker
+#
+#  TODO: Copyright for UEFI Driver LegacySpeaker
+#  
+#  TODO: License for UEFI Driver LegacySpeaker
+#  
+##
+
+[Defines]
+  INF_VERSION               = 0x00010005
+  BASE_NAME                 = LegacySpeaker
+  FILE_GUID                 = f556f20f-1838-11e6-94c2-6067203c4d58
+  MODULE_TYPE               = UEFI_DRIVER
+  VERSION_STRING            = 1.0
+  ENTRY_POINT               = LegacySpeakerDriverEntryPoint
+
+[Packages]
+  MdePkg/MdePkg.dec
+  DcsPkg/DcsPkg.dec
+
+[Sources]
+  LegacySpeaker.h
+  LegacySpeaker.c
+  ComponentName.c
+  ComponentName.h
+
+[LibraryClasses]
+  UefiDriverEntryPoint
+  UefiBootServicesTableLib
+  MemoryAllocationLib
+  BaseMemoryLib
+  BaseLib
+  UefiLib
+  DevicePathLib
+  DebugLib
+  IoLib
+
+[Protocols]
+  gEfiComponentName2ProtocolGuid
+  gEfiComponentNameProtocolGuid
+
+[Guids]
+