OvmfPkg: Add an Super IO bus driver

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1495

There is a plan to remove the IntelFrameworkModulePkg:
https://bugzilla.tianocore.org/show_bug.cgi?id=1605

This patch will a new OVMF Super I/O bus driver which will create the
below child devices:

* COM 1 UART
* COM 2 UART
* PS/2 Keyboard

and installs the Super I/O Protocol on them.

Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Acked-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Acked-by: Laszlo Ersek <lersek@redhat.com>
Tested-by: Anthony PERARD <anthony.perard@citrix.com>

1 files changed, 167 insertions, 0 deletions

diff --git a/OvmfPkg/SioBusDxe/ComponentName.c b/OvmfPkg/SioBusDxe/ComponentName.c
new file mode 100644
index 0000000000..668a2c6a7a
--- /dev/null
+++ b/OvmfPkg/SioBusDxe/ComponentName.c
@@ -0,0 +1,167 @@
+/** @file

+  UEFI Component Name(2) protocol implementation for SioBusDxe driver.

+

+  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>

+

+  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.

+

+**/

+

+#include "SioBusDxe.h"

+

+//

+// Driver name table

+//

+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSioBusDriverNameTable[] = {

+  { "eng;en", L"OVMF Sio Bus Driver" },

+  { NULL , NULL }

+};

+

+//

+// EFI Component Name Protocol

+//

+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gSioBusComponentName = {

+  SioBusComponentNameGetDriverName,

+  SioBusComponentNameGetControllerName,

+  "eng"

+};

+

+//

+// EFI Component Name 2 Protocol

+//

+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gSioBusComponentName2 = {

+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) SioBusComponentNameGetDriverName,

+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) SioBusComponentNameGetControllerName,

+  "en"

+};

+

+

+/**

+  Retrieves a Unicode string that is the user readable name of the driver.

+

+  This function retrieves the user readable name of a driver in the form of a

+  Unicode string. If the driver specified by This has a user readable name in

+  the language specified by Language, then a pointer to the driver name is

+  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified

+  by This does not support the language specified by Language, then

+  EFI_UNSUPPORTED is returned.

+

+  @param[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL

+                                or EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  Language          A pointer to a Null-terminated ASCII string

+                                array indicating the language. This is the

+                                language of the driver 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. Language is specified

+                                in RFC 4646 or ISO 639-2 language code format.

+  @param[out] 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

+SioBusComponentNameGetDriverName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL    *This,

+  IN  CHAR8                          *Language,

+  OUT CHAR16                         **DriverName

+  )

+{

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           mSioBusDriverNameTable,

+           DriverName,

+           (BOOLEAN)(This == &gSioBusComponentName)

+           );

+}

+

+/**

+  Retrieves a Unicode string that is the user readable name of the controller

+  that is being managed by a driver.

+

+  This function retrieves the user readable name of the controller specified by

+  ControllerHandle and ChildHandle in the form of a Unicode string. If the

+  driver specified by This has a user readable name in the language specified

+  by Language, then a pointer to the controller name is returned in

+  ControllerName, and EFI_SUCCESS is returned.  If the driver specified by This

+  is not currently managing the controller specified by ControllerHandle and

+  ChildHandle, then EFI_UNSUPPORTED is returned.  If the driver specified by

+  This does not support the language specified by Language, then

+  EFI_UNSUPPORTED is returned.

+

+  @param[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL

+                                or EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  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[in]  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[in]  Language          A pointer to a Null-terminated ASCII string

+                                array indicating the language.  This is the

+                                language of the driver 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. Language is specified in

+                                RFC 4646 or ISO 639-2 language code format.

+  @param[out] 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

+SioBusComponentNameGetControllerName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL    *This,

+  IN  EFI_HANDLE                     ControllerHandle,

+  IN  EFI_HANDLE                     ChildHandle        OPTIONAL,

+  IN  CHAR8                          *Language,

+  OUT CHAR16                         **ControllerName

+  )

+{

+  return EFI_UNSUPPORTED;

+}