From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by mx.groups.io with SMTP id smtpd.web11.8298.1572887857571380181 for ; Mon, 04 Nov 2019 09:17:37 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.126, mailfrom: prince.agyeman@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 04 Nov 2019 09:17:37 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.68,267,1569308400"; d="scan'208";a="376396246" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by orsmga005.jf.intel.com with ESMTP; 04 Nov 2019 09:17:36 -0800 Received: from fmsmsx123.amr.corp.intel.com (10.18.125.38) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.439.0; Mon, 4 Nov 2019 09:17:36 -0800 Received: from FMSMSX110.amr.corp.intel.com ([169.254.14.36]) by fmsmsx123.amr.corp.intel.com ([169.254.7.18]) with mapi id 14.03.0439.000; Mon, 4 Nov 2019 09:17:36 -0800 From: "Agyeman, Prince" To: "Chiu, Chasel" , "devel@edk2.groups.io" CC: "Kubacki, Michael A" , "Desimone, Nathaniel L" Subject: Re: [edk2-platforms] [PATCH 4/5] KabylakeOpenBoardPkg: Add Ps2 keyboard Null Library Thread-Topic: [edk2-platforms] [PATCH 4/5] KabylakeOpenBoardPkg: Add Ps2 keyboard Null Library Thread-Index: AQHVkO3Fcksz7eaSUE265AqrKeBVjad6ukeQgACJtsA= Date: Mon, 4 Nov 2019 17:17:35 +0000 Message-ID: References: <20191101195116.23212-1-prince.agyeman@intel.com> <20191101195116.23212-5-prince.agyeman@intel.com> <3C3EFB470A303B4AB093197B6777CCEC505219E8@PGSMSX111.gar.corp.intel.com> In-Reply-To: <3C3EFB470A303B4AB093197B6777CCEC505219E8@PGSMSX111.gar.corp.intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMWUxMDAzNzQtMzY5Ny00ZGQ1LTkzZWQtODk4ZmMwMWMzMGNmIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiTnRTNzMyVWNUVXlpM3hZWkVBUUlcL0kyXC9tU09SaVpYVVwvTW5meU5EbTRhMzkxS1ptek1iWEFFV1QxNUpPN1hGbiJ9 x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.2.0.6 dlp-reaction: no-action x-originating-ip: [10.1.200.107] MIME-Version: 1.0 Return-Path: prince.agyeman@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi Chasel,=20 I will fix the descriptions and typos as suggested in my v2 patch series. Thanks for the feedback! Prince=20 -----Original Message----- From: Chiu, Chasel =20 Sent: Monday, November 4, 2019 1:04 AM To: Agyeman, Prince ; devel@edk2.groups.io Cc: Kubacki, Michael A ; Desimone, Nathaniel L= Subject: RE: [edk2-platforms] [PATCH 4/5] KabylakeOpenBoardPkg: Add Ps2 key= board Null Library Hi Prince, I added 3 questions below inline, please help to check them. Thanks! > -----Original Message----- > From: Agyeman, Prince > Sent: Saturday, November 2, 2019 3:51 AM > To: devel@edk2.groups.io > Cc: Kubacki, Michael A ; Chiu, Chasel=20 > ; Desimone, Nathaniel L=20 > > Subject: [edk2-platforms] [PATCH 4/5] KabylakeOpenBoardPkg: Add Ps2=20 > keyboard Null Library >=20 > Added GalagoPro3 board ps2 keyboard library that adds ps2 device path=20 > to ConIn and ConInDev Uefi variables >=20 > Cc: Michael Kubacki > Cc: Chasel Chiu > Cc: Nate DeSimone >=20 > Signed-off-by: Prince Agyeman > --- > .../GalagoPro3/Library/Ps2KbcLib/Ps2KbcLib.c | 202 > ++++++++++++++++++ .../GalagoPro3/Library/Ps2KbcLib/Ps2KbcLib.h | > 65 ++++++ > .../Library/Ps2KbcLib/Ps2KbcLib.inf | 39 ++++ > 3 files changed, 306 insertions(+) > create mode 100644 > Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2Kb > cLib.c > create mode 100644 > Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2Kb > cLib.h > create mode 100644 > Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2Kb > cLib.inf >=20 > diff --git > a/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2 > K > bcLib.c > b/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2 > KbcLib.c > new file mode 100644 > index 0000000000..ac1563d3cd > --- /dev/null > +++ > b/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/P > +++ s2KbcLib.c > @@ -0,0 +1,202 @@ > +/** @file > + Main file for NULL named library for Ps2 keyboard controller librarr. I think this is not really a NULL library right? It actually does a lot rea= l functionality. Also the typo "librarr" > + > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include "Ps2KbcLib.h" > + > +GLOBAL_REMOVE_IF_UNREFERENCED PLATFORM_KEYBOARD_DEVICE_PATH=20 > +gKeyboardDevicePath =3D { > + gPciRootBridge, > + { > + { > + HARDWARE_DEVICE_PATH, > + HW_PCI_DP, > + { > + (UINT8) (sizeof (PCI_DEVICE_PATH)), > + (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) > + } > + }, > + 0, // Function, patched in EnumPs2Keyboard > + 0 // Device, patched in EnumPs2Keyboard > + }, > + { > + { > + ACPI_DEVICE_PATH, > + ACPI_DP, > + { > + (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), > + (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) > + } > + }, > + EISA_PNP_ID(0x0303), > + 0 > + }, > + gEndEntire > +}; > + > +/** > + Check if PS2 keyboard is conntected, by sending ECHO command. > + @retval TRUE if connected FALSE otherwise > +**/ > +BOOLEAN > +DetectPs2Keyboard ( > + VOID > + ) > +{ > + UINT32 TimeOut; > + UINT32 RegEmptied; > + UINT8 Data; > + UINT32 SumTimeOut; > + BOOLEAN FoundPs2Kbc; > + > + TimeOut =3D 0; > + RegEmptied =3D 0; > + FoundPs2Kbc =3D FALSE; > + > + // > + // Wait for input buffer empty > + // > + for (TimeOut =3D 0; TimeOut < PS2_KEYBOARD_TIMEOUT; TimeOut +=3D 30) { > + if ((IoRead8 (KEYBOARD_8042_STATUS_REGISTER) & 0x02) =3D=3D 0) { > + FoundPs2Kbc =3D TRUE; > + break; > + } > + MicroSecondDelay (30); > + } > + > + if (FoundPs2Kbc =3D=3D FALSE) { > + return FALSE; > + } > + > + // > + // Send echo command > + // > + IoWrite8 (KEYBOARD_8042_DATA_REGISTER, > KBC_INPBUF_VIA60_KBECHO); > + > + // > + // Init variables > + // > + FoundPs2Kbc =3D FALSE; > + TimeOut =3D 0; > + SumTimeOut =3D 0; > + Data =3D 0; > + > + // > + // Read from 8042 (multiple times if needed) // until the expected=20 > + value appears // use SumTimeOut to control the iteration // while > + (1) { > + // > + // Perform a read > + // > + for (TimeOut =3D 0; TimeOut < PS2_KEYBOARD_TIMEOUT; TimeOut +=3D 30) > { > + if (IoRead8 (KEYBOARD_8042_STATUS_REGISTER) & 0x01) { > + Data =3D IoRead8 (KEYBOARD_8042_DATA_REGISTER); > + break; > + } > + MicroSecondDelay (30); > + } > + > + SumTimeOut +=3D TimeOut; > + > + if (Data =3D=3D KBC_INPBUF_VIA60_KBECHO) { > + FoundPs2Kbc =3D TRUE; > + break; > + } > + > + if (SumTimeOut >=3D PS2_KEYBOARD_WAITFORVALUE_TIMEOUT) { > + break; > + } > + } > + return FoundPs2Kbc; > +} > + > +/** > + Check if PS2 keyboard is conntected. If the result of first time is > + error, it will retry again. > + @retval TRUE if connected FALSE otherwise > +**/ > +BOOLEAN > +IsPs2KeyboardConnected ( > + VOID > + ) > +{ > + BOOLEAN Result; > + Result =3D DetectPs2Keyboard (); > + > + if (Result =3D=3D FALSE) { > + // > + // If there is no ps2 keyboard detected for the 1st time, retry agai= n. > + // > + Result =3D DetectPs2Keyboard (); > + } > + return Result; > +} > + > + > +/** > + Updates the ConIn variable with Ps2 Keyboard device path, > + if it doesn't already exists in ConIn and ConInDev **/ VOID=20 > +AddPs2Keyboard ( > + VOID > + ) > +{ > + SIO_PCI_ISA_BRIDGE_DEVICE_INFO *SioIsaInfo; > + > + DEBUG ((DEBUG_INFO, "[AddPs2Keyboard]\n")); > + > + SioIsaInfo =3D (SIO_PCI_ISA_BRIDGE_DEVICE_INFO*) FixedPcdGetPtr=20 > + (PcdSuperIoPciIsaBridgeDevice); > + > + // > + // patch IsaBridge device and and function //=20 > + gKeyboardDevicePath.IsaBridge.Device =3D SioIsaInfo->Device;=20 > + gKeyboardDevicePath.IsaBridge.Function =3D SioIsaInfo->Funtion; > + > + // > + // Append Ps2 Keyboard into "ConIn" > + // > + EfiBootManagerUpdateConsoleVariable (ConIn, > (EFI_DEVICE_PATH_PROTOCOL > + *) &gKeyboardDevicePath, NULL); > + > + // > + // Append Ps2 Keyboard into "ConInDev" > + // > + EfiBootManagerUpdateConsoleVariable (ConInDev,=20 > +(EFI_DEVICE_PATH_PROTOCOL *) &gKeyboardDevicePath, NULL); } > + > + > +/** > + Constructor for the Ps2 keyboard controller library. > + > + @param ImageHandle the image handle of the process > + @param SystemTable the EFI System Table pointer > + > + @retval EFI_SUCCESS the shell command handlers were > installed sucessfully > + @retval EFI_UNSUPPORTED the shell level required was not found. > +**/ > +EFI_STATUS > +EFIAPI > +Ps2KbcLibConstructor ( > + IN EFI_HANDLE ImageHandle, > + IN EFI_SYSTEM_TABLE *SystemTable > + ) > +{ > + UINT8 Ps2KbMsEnable; > + > + Ps2KbMsEnable =3D PcdGet8 (PcdPs2KbMsEnable); > + > + if (Ps2KbMsEnable =3D=3D 0x1 > + && IsPs2KeyboardConnected()) > + { > + // add ps2 device path to ConIn and ConInDev > + AddPs2Keyboard (); > + } > + > + return EFI_SUCCESS; > +} > diff --git > a/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2 > K > bcLib.h > b/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2 > KbcLib.h > new file mode 100644 > index 0000000000..60bba122d6 > --- /dev/null > +++ > b/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/P > +++ s2KbcLib.h > @@ -0,0 +1,65 @@ > +/** @file > + Header file for NULL named library for Ps2 keyboard controller library= . Same question here, is this really NULL library instance? > + > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#ifndef _PS2_KBC_LIB_H > +#define _PS2_KBC_LIB_H > + > +#include > +#include > +#include > +#include > +#include > +#include > +#include > + > +// > +// Below is the platform console device path // typedef struct { > + ACPI_HID_DEVICE_PATH PciRootBridge; > + PCI_DEVICE_PATH IsaBridge; > + ACPI_HID_DEVICE_PATH Keyboard; > + EFI_DEVICE_PATH_PROTOCOL End; > +} PLATFORM_KEYBOARD_DEVICE_PATH; > + > +typedef struct { > + UINT8 Segment; > + UINT8 Bus; > + UINT8 Device; > + UINT8 Funtion; > +} SIO_PCI_ISA_BRIDGE_DEVICE_INFO; > + > +#define gPciRootBridge \ > + { \ > + { \ > + ACPI_DEVICE_PATH, \ > + ACPI_DP, \ > + { \ > + (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \ > + (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \ > + }, \ > + }, \ > + EISA_PNP_ID (0x0A03), \ > + 0 \ > + } > + > +#define gEndEntire \ > + { \ > + END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, {=20 > +END_DEVICE_PATH_LENGTH, 0 } \ > + } > + > +#define KBC_INPBUF_VIA60_KBECHO 0xEE > +#define KEYBOARD_8042_DATA_REGISTER 0x60 > +#define KEYBOARD_8042_STATUS_REGISTER 0x64 > + > +#define PS2_KEYBOARD_TIMEOUT 65536 // 0.07s > +#define PS2_KEYBOARD_WAITFORVALUE_TIMEOUT 1000000 // 1s > +#define PS2_KEYBOARD_KBEN 0xF4 > +#define PS2_KEYBOARD_CMDECHO_ACK 0xFA > + > +#endif > diff --git > a/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2 > K > bcLib.inf > b/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/Ps2 > KbcLib.inf > new file mode 100644 > index 0000000000..7ab1b628e3 > --- /dev/null > +++ > b/Platform/Intel/KabylakeOpenBoardPkg/GalagoPro3/Library/Ps2KbcLib/P > +++ s2KbcLib.inf > @@ -0,0 +1,39 @@ > +## @file > +# Component information file for PEI GalagoPro3 Board Init Pre-Mem=20 > +Library # # Copyright (c) 2019, Intel Corporation. All rights This library is for PS2 initialization, not "Board Init Pre-Mem". > +reserved.
# # SPDX-License-Identifier: BSD-2-Clause-Patent # ##=20 > +[Defines] > + INF_VERSION =3D 0x00010006 > + BASE_NAME =3D Ps2KbcLib > + FILE_GUID =3D > E94EA52E-E84C-42E7-B863-EA1327EFA265 > + MODULE_TYPE =3D UEFI_DRIVER > + VERSION_STRING =3D 1.2 > + LIBRARY_CLASS =3D NULL|UEFI_DRIVER > + CONSTRUCTOR =3D Ps2KbcLibConstructor > + > +[Packages] > + MdePkg/MdePkg.dec > + MdeModulePkg/MdeModulePkg.dec > + KabylakeOpenBoardPkg/OpenBoardPkg.dec > + BoardModulePkg/BoardModulePkg.dec > + > +[Sources] > + Ps2KbcLib.c > + Ps2KbcLib.h > + > +[LibraryClasses] > + DevicePathLib > + DebugLib > + IoLib > + UefiDriverEntryPoint > + UefiBootManagerLib > + UefiLib > + TimerLib > + > +[Pcd] > + gBoardModulePkgTokenSpaceGuid.PcdPs2KbMsEnable > + gBoardModulePkgTokenSpaceGuid.PcdSuperIoPciIsaBridgeDevice > -- > 2.19.1.windows.1