Add OcTextInputLib for EFI 1.1/cMP5,1 compatibility

Docs/Configuration.tex

@@ -817,7 +817,7 @@ \subsection{Debugging}\label{configuration-debug}
 \begin{itemize}
 \tightlist
 \item Use module prefixes, 2-5 letters followed by a colon (\texttt{:}), for debug messages. For \texttt{OpenCorePkg}
-use \texttt{OC:}, for libraries and drivers use their own unique prefixes.
+use \texttt{OC:}, for libraries and drivers use their own unique prefixes. For example, \texttt{OcTextInputLib} uses \texttt{OCTI:}.
 \item Do not use dots (\texttt{.}) in the end of debug messages and separate \texttt{EFI\_STATUS}, printed by
 \texttt{\%r}, with a hyphen (e.g. \texttt{OCRAM: Allocation of \%u bytes failed - \%r\textbackslash n}).
 \item Use \texttt{DEBUG\_CODE\_BEGIN ()} and \texttt{DEBUG\_CODE\_END ()} constructions to guard debug checks

Include/Acidanthera/Library/OcTextInputLib.h

@@ -0,0 +1,83 @@
+/** @file
+   OcTextInputLib - SimpleTextInputEx Protocol Compatibility Library
+
+   This library provides SimpleTextInputEx protocol compatibility for systems
+   that only have SimpleTextInput protocol available (EFI 1.1 systems).
+
+   Copyright (c) 2025, OpenCore Team. All rights reserved.
+   SPDX-License-Identifier: BSD-2-Clause-Patent
+ **/
+
+#ifndef OC_TEXT_INPUT_LIB_H
+#define OC_TEXT_INPUT_LIB_H
+
+#include <Uefi.h>
+#include <Protocol/SimpleTextInEx.h>
+
+/**
+   Install SimpleTextInputEx compatibility protocol on the console input handle.
+
+   This function checks if SimpleTextInputEx is already available, and if not,
+   installs a compatibility version that wraps SimpleTextInput protocol.
+
+   For the "normal" variant, this uses standard gBS->InstallProtocolInterface.
+   For the "local" variant, this uses OcRegisterBootServicesProtocol for
+   use within OpenShell.
+
+   @retval EFI_SUCCESS          Protocol installed successfully or already present
+   @retval EFI_ALREADY_STARTED  Protocol already exists, no action taken
+   @retval Others               Installation failed
+ **/
+EFI_STATUS
+OcInstallSimpleTextInputEx (
+  VOID
+  );
+
+/**
+   Uninstall SimpleTextInputEx compatibility protocol.
+
+   This should be called during cleanup if the compatibility protocol
+   was installed by this library.
+
+   @retval EFI_SUCCESS          Protocol uninstalled successfully
+   @retval EFI_NOT_FOUND        Protocol was not installed by this library
+   @retval Others               Uninstallation failed
+ **/
+EFI_STATUS
+OcUninstallSimpleTextInputEx (
+  VOID
+  );
+
+/**
+   Test CTRL key detection on the current system.
+
+   This function can be used to verify that CTRL key combinations
+   are properly detected on EFI 1.1 systems. Useful for debugging
+   compatibility issues like those seen on cMP5,1.
+
+   @retval EFI_SUCCESS          Test completed, check debug output
+   @retval Others               Test failed
+ **/
+EFI_STATUS
+OcTestCtrlKeyDetection (
+  VOID
+  );
+
+/**
+  Process key data and handle control characters.
+
+  This function is provided by OcTextInputLib for use by standalone drivers.
+  It handles control character mapping and key processing logic.
+
+  @param[in,out] KeyData  Key data to process
+
+  @retval EFI_SUCCESS     Key data processed successfully
+  @retval EFI_NOT_FOUND   Key data does not need processing
+  @retval EFI_INVALID_PARAMETER KeyData is NULL
+**/
+EFI_STATUS
+OctiProcessKeyData (
+  IN OUT EFI_KEY_DATA  *KeyData
+  );
+
+#endif // OC_TEXT_INPUT_LIB_H

Include/Library/OcTextInputLib.h

@@ -0,0 +1,79 @@
+/** @file
+  OcTextInputLib - SimpleTextInputEx Protocol Compatibility Library
+
+  This library provides SimpleTextInputEx protocol compatibility for systems
+  that only have SimpleTextInput protocol available (EFI 1.1 systems).
+
+  Copyright (c) 2025, OpenCore Team. All rights reserved.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+**/
+
+#ifndef OC_TEXT_INPUT_LIB_H
+#define OC_TEXT_INPUT_LIB_H
+
+#include <Uefi.h>
+#include <Protocol/SimpleTextInEx.h>
+
+//
+// Control character mapping structure for hotkey descriptions.
+//
+typedef struct {
+  UINT8    ControlChar;    ///< Control character code (0x01-0x1F)
+  CHAR8    *Description;   ///< Human-readable description (e.g., "CTRL+A")
+  CHAR8    *ShellFunction; ///< Shell function name (e.g., "StartOfLine")
+} CONTROL_CHAR_MAPPING;
+
+/**
+  Get control character mapping for a given character.
+
+  @param[in]  ControlChar  The control character to get mapping for.
+
+  @retval  Pointer to CONTROL_CHAR_MAPPING structure, or NULL if not found.
+**/
+CONTROL_CHAR_MAPPING *
+EFIAPI
+GetControlCharMapping (
+  IN CHAR16  ControlChar
+  );
+
+/**
+  Compatibility implementation of SimpleTextInputEx ReadKeyStrokeEx.
+
+  @param[in]   This               Protocol instance pointer.
+  @param[out]  KeyData            A pointer to a buffer that is filled in with
+                                  the keystroke state data for the key that was
+                                  pressed.
+
+  @retval EFI_SUCCESS             The keystroke information was returned.
+  @retval EFI_NOT_READY           There was no keystroke data available.
+  @retval EFI_DEVICE_ERROR        The keystroke information was not returned due
+                                  to an error.
+  @retval EFI_INVALID_PARAMETER   KeyData is NULL.
+**/
+EFI_STATUS
+EFIAPI
+CompatReadKeyStrokeEx (
+  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
+  OUT EFI_KEY_DATA                      *KeyData
+  );
+
+/**
+  Install SimpleTextInputEx Protocol compatibility.
+
+  This function installs a SimpleTextInputEx protocol instance that provides
+  compatibility for systems that only have SimpleTextInput protocol available.
+
+  @param[in]  UseLocalRegistration  If TRUE, register protocol with OpenCore's
+                                    internal table. If FALSE, register with
+                                    system's boot services table.
+
+  @retval EFI_SUCCESS               Protocol installed successfully.
+  @retval EFI_OUT_OF_RESOURCES      Failed to allocate memory.
+  @retval Other                     Installation failed.
+**/
+EFI_STATUS
+OcInstallSimpleTextInputExInternal (
+  IN BOOLEAN  UseLocalRegistration
+  );
+
+#endif // OC_TEXT_INPUT_LIB_H

Library/OcTextInputLib/OcTextInputCommon.h

@@ -0,0 +1,37 @@
+/** @file
+  Copyright (C) 2021, vit9696. All rights reserved.
+
+  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.
+**/
+
+#ifndef OC_TEXT_INPUT_COMMON_H
+#define OC_TEXT_INPUT_COMMON_H
+
+#include <Uefi.h>
+#include <Protocol/SimpleTextInEx.h>
+
+/**
+  Process key data and handle control characters.
+
+  This function is provided by OcTextInputLib for use by standalone drivers.
+  It handles control character mapping and key processing logic.
+
+  @param[in,out] KeyData  Key data to process
+
+  @retval EFI_SUCCESS     Key data processed successfully
+  @retval EFI_NOT_FOUND   Key data does not need processing
+**/
+EFI_STATUS
+OctiProcessKeyData (
+  IN OUT EFI_KEY_DATA  *KeyData
+  );
+
+#endif // OC_TEXT_INPUT_COMMON_H