From patchwork Wed Aug 23 13:12:06 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ard Biesheuvel X-Patchwork-Id: 110826 Delivered-To: patch@linaro.org Received: by 10.140.95.78 with SMTP id h72csp4110129qge; Wed, 23 Aug 2017 06:12:28 -0700 (PDT) X-Received: by 10.98.75.221 with SMTP id d90mr2809950pfj.274.1503493947860; Wed, 23 Aug 2017 06:12:27 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1503493947; cv=none; d=google.com; s=arc-20160816; b=RMrnconJhbiHDJcXgr1HowycOwElW2HOF1Gu9wyYGCiLhINUr8iB4KQN8ep+yXUwXb OpGusa3FM/n10Cu/lMoPQ73GI/m4dKZAPsk5IvylZbqnpTQx/dj7YI+pfEdpMXLVvDPn fOMRzLcTejeUbD84zANrImOAN345SKbyhQrEEXrIHxhJlHV36JLVte1xzPuQwg1q0YnV kouhoOo/ykg7Vja8TpwW1cmENRfcXjtduUyeMDl5k0rn7vuCjroMC4akubdlhrLux/lx xd+yIZgmhCqCjLdZEiWrYjoL9IyrSZRu35tu4ct62PxZzrgz4TI/PcLc6hpTNv1RIVJI Wddw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:mime-version:cc :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:message-id:date:to:from:dkim-signature :delivered-to:arc-authentication-results; bh=my1xFxZZpTPTOibVEWOHAVq3sy+lf6fl/DVi39d0z9w=; b=CuBycnvyrZERvht4eHf1WfPtvAuHiDOtRKN7xOfG3WBGENqDZW+tFZ0PZIa3YZ6cvd MafCu5lyCxVM8cqZ8TzrytzFdeS798p0wwN5wv+6tCsEsYRJh6rxsAd1gIX5PfKxc3o1 3QD0L9I2chwm6CuqCG3UxJ85i2sI/0TI0biLMx0hKB1Aswf666JUuZnJ7kEfpYhnOwXW SxTgRuuExxxvcFxhN6oNr75aidNsiSW41qOzb3vgm3vh5HEGswH2D8wdTdTIiz2vZ9bu Ks/fcWXo2NXAtohN4nQiEq/zKWXbXfbAwadTTMtI21NYpmVxCsUVjN3XT8sPFhEADJYm fblA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=NrVXIRM/; spf=pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 2001:19d0:306:5::1 as permitted sender) smtp.mailfrom=edk2-devel-bounces@lists.01.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from ml01.01.org (ml01.01.org. [2001:19d0:306:5::1]) by mx.google.com with ESMTPS id z196si1046684pgz.590.2017.08.23.06.12.27 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 23 Aug 2017 06:12:27 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 2001:19d0:306:5::1 as permitted sender) client-ip=2001:19d0:306:5::1; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=NrVXIRM/; spf=pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 2001:19d0:306:5::1 as permitted sender) smtp.mailfrom=edk2-devel-bounces@lists.01.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id BF29421E47D58; Wed, 23 Aug 2017 06:09:52 -0700 (PDT) X-Original-To: edk2-devel@lists.01.org Delivered-To: edk2-devel@lists.01.org Received: from mail-wm0-x22a.google.com (mail-wm0-x22a.google.com [IPv6:2a00:1450:400c:c09::22a]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 3462221E47D57 for ; Wed, 23 Aug 2017 06:09:51 -0700 (PDT) Received: by mail-wm0-x22a.google.com with SMTP id r187so650172wma.0 for ; Wed, 23 Aug 2017 06:12:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=ePSAgh/oLIALbn7sNLY6+kauWdgMjrDkUmdt6GdXW08=; b=NrVXIRM/FtHiQ7N+rOf2PE8dyf1vyTQwupWKECyn9KUG2kNiidPQHsvFRV3azq582u 0tqo63X3zB/p+nCRjJugsabO3ELxJieBuXd+5XobXUvhd9Az0x0yTTq7hPpv+EdnQWE6 8fDcGU4EJ7EPpPqdGUh/4WDmu8i3I9R+9m2tg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=ePSAgh/oLIALbn7sNLY6+kauWdgMjrDkUmdt6GdXW08=; b=s5TA3dV86UX+oS0fOqFGPoAjXW70uFZ89jKg1tmmfyQwrg3e4VEdCcI6+67jD1Rkgb f5Jbjr54bhirBzba4FCFOA1TjZ3CIbZoMkyo4UQzzhH9FPzOK6jMyJ7Pw4dRD02aB3nP PjH4A2IW4pwiVbzvvrIE3TLvW8d/aL+7xKj5n31/td3T1sQl0RlqTnoGUxIOLkg0fxMd 7BzF35O2VSRPqKm3zr30dHja4v9eU/TA/N9R/rdrjx5xIQyBEAhDZ6idntd/8iOGJuYJ PrKuxRUOuBV+XSr7nXLgklCvWAq078yQOY6icOK4UwIPRG4DF82SIOazAz4GEqbb+L2k r7pg== X-Gm-Message-State: AHYfb5iw6a7/Cf2Z4RbRBw1GIceXW/CK8klKggvQ7xYXtstacH8K1zkO wZ/dcX7sGlEBfq9cC9rqww== X-Received: by 10.28.10.131 with SMTP id 125mr1791869wmk.132.1503493942479; Wed, 23 Aug 2017 06:12:22 -0700 (PDT) Received: from localhost.localdomain ([154.146.161.128]) by smtp.gmail.com with ESMTPSA id 32sm2733474wrg.61.2017.08.23.06.12.20 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 23 Aug 2017 06:12:21 -0700 (PDT) From: Ard Biesheuvel To: edk2-devel@lists.01.org, leif.lindholm@linaro.org, michael.d.kinney@intel.com Date: Wed, 23 Aug 2017 14:12:06 +0100 Message-Id: <20170823131206.25008-1-ard.biesheuvel@linaro.org> X-Mailer: git-send-email 2.11.0 Subject: [edk2] [PATCH edk2-platforms] Silicon/Openmoko: add driver for ChaosKey RNG USB device X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Ard Biesheuvel MIME-Version: 1.0 Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" This is a continuation of the work carried out by Leif Lindholm to implement a driver for the ChaosKey USB device. This driver uses the UEFI driver model, which is a slightly awkward fit, due to the fact that a UEFI implementation may legally only instantiate those protocols that are needed to access the device path that the active Boot#### options refers to. However, it is expected that UEFI implementations typically instantiate all USB I/O protocols and connect them as well, as those are required for a USB keyboard to be able to control the boot sequence. This should result in this driver being connected and given the opportunity to produce the EFI_RNG_PROTOCOL. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ard Biesheuvel --- Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.c | 346 ++++++++++++++++++++ Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.h | 61 ++++ Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDxe.inf | 48 +++ Silicon/Openmoko/ChaosKeyDxe/ComponentName.c | 205 ++++++++++++ Silicon/Openmoko/ChaosKeyDxe/DriverBinding.c | 256 +++++++++++++++ 5 files changed, 916 insertions(+) -- 2.11.0 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel diff --git a/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.c b/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.c new file mode 100644 index 000000000000..1870080d2c70 --- /dev/null +++ b/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.c @@ -0,0 +1,346 @@ +/** @file + Device driver for the ChaosKey hardware random number generator. + + Copyright (c) 2016 - 2017, Linaro Ltd. 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. + +**/ + +#include "ChaosKeyDriver.h" + +#include +#include +#include + +STATIC +BOOLEAN +IsBulkInEndpoint ( + IN EFI_USB_ENDPOINT_DESCRIPTOR *Endpoint + ) +{ + if ((Endpoint->Attributes & USB_ENDPOINT_TYPE_MASK) == USB_ENDPOINT_BULK) { + if (Endpoint->EndpointAddress & USB_ENDPOINT_DIR_IN) { + return TRUE; + } + } + return FALSE; +} + + +STATIC +EFI_STATUS +FindEndpoint ( + IN CHAOSKEY_DEV *ChaosKey + ) +{ + EFI_USB_IO_PROTOCOL *UsbIo; + EFI_STATUS Status; + UINTN Index; + EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor; + + UsbIo = ChaosKey->UsbIo; + + // + // Get interface & endpoint descriptor + // + Status = UsbIo->UsbGetInterfaceDescriptor (UsbIo, &InterfaceDescriptor); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // The ChaosKey provides two endpoints: + // - The first one is the 'cooked' one, to be used as random data input + // - The second one is the raw bitstream from the generator, higher + // throughput, but lower randomness. + // So locate the first bulk IN endpoint and save it for later use. + // + for (Index = 0; Index < InterfaceDescriptor.NumEndpoints; Index++) { + EFI_USB_ENDPOINT_DESCRIPTOR Endpoint; + + Status = UsbIo->UsbGetEndpointDescriptor (UsbIo, Index, &Endpoint); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "UsbGetEndPointDescriptor(%d) failed!\n", Index)); + return Status; + } + + if (IsBulkInEndpoint(&Endpoint)) { + ChaosKey->EndpointAddress = Endpoint.EndpointAddress; + ChaosKey->EndpointSize = Endpoint.MaxPacketSize; + return EFI_SUCCESS; + } + } + + DEBUG ((DEBUG_ERROR, "Failed to locate suitable BULK IN USB endpoint!\n")); + return EFI_DEVICE_ERROR; +} + + +/** + Returns information about the random number generation implementation. + + @param[in] This A pointer to the EFI_RNG_PROTOCOL instance. + @param[in,out] AlgorithmListSize On input, the size in bytes of AlgorithmList + On output with a return code of EFI_SUCCESS, + the size in bytes of the data returned in + AlgorithmList. On output with a return + code of EFI_BUFFER_TOO_SMALL, the size of + AlgorithmList required to obtain the list. + @param[out] AlgorithmList A caller-allocated memory buffer filled by + the driver with one EFI_RNG_ALGORITHM + element for each supported RNG algorithm. + The list must not change across multiple + calls to the same driver. The first + algorithm in the list is the default + algorithm for the driver. + + @retval EFI_SUCCESS The RNG algorithm list was returned + successfully. + @retval EFI_UNSUPPORTED The services is not supported by this driver + @retval EFI_DEVICE_ERROR The list of algorithms could not be + retrieved due to a hardware or firmware + error. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too small to + hold the result. + +**/ +STATIC +EFI_STATUS +EFIAPI +GetInfo ( + IN EFI_RNG_PROTOCOL *This, + IN OUT UINTN *AlgorithmListSize, + OUT EFI_RNG_ALGORITHM *AlgorithmList +) +{ + UINTN Size; + + // + // We only implement the raw algorithm + // + Size = sizeof gEfiRngAlgorithmRaw; + + if (*AlgorithmListSize < Size) { + *AlgorithmListSize = Size; + return EFI_BUFFER_TOO_SMALL; + } + + gBS->CopyMem (AlgorithmList, &gEfiRngAlgorithmRaw, Size); + *AlgorithmListSize = Size; + + return EFI_SUCCESS; +} + + +/** + Produces and returns an RNG value using either the default or specified RNG + algorithm. + + @param[in] This A pointer to the EFI_RNG_PROTOCOL instance. + @param[in] Algorithm A pointer to the EFI_RNG_ALGORITHM that + identifies the RNG algorithm to use. May be + NULL in which case the function will use its + default RNG algorithm. + @param[in] ValueLength The length in bytes of the memory buffer + pointed to by RNGValue. The driver shall + return exactly this numbers of bytes. + @param[out] Value A caller-allocated memory buffer filled by the + driver with the resulting RNG value. + + @retval EFI_SUCCESS The RNG value was returned successfully. + @retval EFI_UNSUPPORTED The algorithm specified by RNGAlgorithm is not + supported by this driver. + @retval EFI_DEVICE_ERROR An RNG value could not be retrieved due to a + hardware or firmware error. + @retval EFI_NOT_READY There is not enough random data available to + satisfy the length requested by + RNGValueLength. + @retval EFI_INVALID_PARAMETER RNGValue is NULL or RNGValueLength is zero. + +**/ +STATIC +EFI_STATUS +EFIAPI +GetRNG ( + IN EFI_RNG_PROTOCOL *This, + IN EFI_RNG_ALGORITHM *Algorithm OPTIONAL, + IN UINTN ValueLength, + OUT UINT8 *Value +) +{ + EFI_STATUS Status; + CHAOSKEY_DEV *ChaosKey; + EFI_TPL Tpl; + UINT8 Buffer[CHAOSKEY_MAX_EP_SIZE]; + UINT8 *OutPointer; + UINTN OutSize; + UINT32 Result; + + if (Algorithm != NULL && !CompareGuid (Algorithm, &gEfiRngAlgorithmRaw)) { + return EFI_UNSUPPORTED; + } + + ChaosKey = CHAOSKEY_DEV_FROM_THIS (This); + + while (ValueLength > 0) { + // + // If more data is requested than the endpoint can deliver in a single + // transfer, put it straight into the caller's buffer. + // + if (ValueLength >= ChaosKey->EndpointSize) { + OutPointer = Value; + } else { + OutPointer = Buffer; + } + OutSize = ChaosKey->EndpointSize; + + Tpl = gBS->RaiseTPL (TPL_NOTIFY); + + Status = ChaosKey->UsbIo->UsbBulkTransfer (ChaosKey->UsbIo, + ChaosKey->EndpointAddress, + OutPointer, + &OutSize, + CHAOSKEY_TIMEOUT, + &Result); + + gBS->RestoreTPL (Tpl); + + if (Status == EFI_TIMEOUT) { + DEBUG ((DEBUG_ERROR, "Bulk transfer timed out, USB status == %d\n", + Result)); + return EFI_NOT_READY; + } else if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, + "Bulk transfer failed, Status == %r, USB status == %d\n", + Status, Result)); + return EFI_DEVICE_ERROR; + } + + OutSize = MIN (OutSize, ValueLength); + + if (Value != Buffer) { + gBS->CopyMem (Value, Buffer, OutSize); + } + Value += OutSize; + ValueLength -= OutSize; + } + return EFI_SUCCESS; +} + + +EFI_STATUS +ChaosKeyInit ( + IN EFI_HANDLE DriverBindingHandle, + IN EFI_HANDLE ControllerHandle + ) +{ + EFI_STATUS Status; + CHAOSKEY_DEV *ChaosKey; + + Status = gBS->AllocatePool (EfiBootServicesData, + sizeof (CHAOSKEY_DEV), + (VOID **) &ChaosKey); + if (EFI_ERROR (Status)) { + return EFI_OUT_OF_RESOURCES; + } + + ChaosKey->Signature = CHAOSKEY_DEV_SIGNATURE; + ChaosKey->Rng.GetInfo = GetInfo; + ChaosKey->Rng.GetRNG = GetRNG; + + // + // Open USB I/O Protocol + // + Status = gBS->OpenProtocol (ControllerHandle, + &gEfiUsbIoProtocolGuid, + (VOID **)&ChaosKey->UsbIo, + DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER); + if (EFI_ERROR (Status)) { + goto ErrorFreeDev; + } + + Status = FindEndpoint (ChaosKey); + if (EFI_ERROR (Status)) { + goto ErrorCloseProtocol; + } + + // + // The following can only occur if the Chaoskey is suddenly reissued + // as a high speed or super speed device under the same VID/PID. + // + ASSERT (ChaosKey->EndpointSize <= CHAOSKEY_MAX_EP_SIZE); + + Status = gBS->InstallProtocolInterface (&ControllerHandle, + &gEfiRngProtocolGuid, + EFI_NATIVE_INTERFACE, + &ChaosKey->Rng); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, + "Failed to install RNG protocol interface (Status == %r)\n", + Status)); + goto ErrorCloseProtocol; + } + + return EFI_SUCCESS; + +ErrorCloseProtocol: + gBS->CloseProtocol (ControllerHandle, &gEfiUsbIoProtocolGuid, + DriverBindingHandle, ControllerHandle); + +ErrorFreeDev: + gBS->FreePool (ChaosKey); + + return Status; +} + +EFI_STATUS +ChaosKeyRelease ( + IN EFI_HANDLE DriverBindingHandle, + IN EFI_HANDLE ControllerHandle + ) +{ + EFI_RNG_PROTOCOL *Rng; + CHAOSKEY_DEV *ChaosKey; + EFI_STATUS Status; + + Status = gBS->HandleProtocol (ControllerHandle, + &gEfiRngProtocolGuid, + (VOID **)&Rng); + ASSERT_EFI_ERROR (Status); + if (EFI_ERROR (Status)) { + return Status; + } + + ChaosKey = CHAOSKEY_DEV_FROM_THIS (Rng); + + Status = gBS->UninstallProtocolInterface (ControllerHandle, + &gEfiRngProtocolGuid, + Rng); + ASSERT_EFI_ERROR (Status); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->CloseProtocol (ControllerHandle, + &gEfiUsbIoProtocolGuid, + DriverBindingHandle, + ControllerHandle); + ASSERT_EFI_ERROR (Status); + if (EFI_ERROR (Status)) { + return Status; + } + + gBS->FreePool (ChaosKey); + + return EFI_SUCCESS; +} diff --git a/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.h b/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.h new file mode 100644 index 000000000000..153deb4edb1c --- /dev/null +++ b/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDriver.h @@ -0,0 +1,61 @@ +/** @file + Header file for the ChaosKey hardware random number generator. + + Copyright (c) 2016 - 2017, Linaro Ltd. 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 _CHAOSKEY_USB_HWRNG_DRIVER_H_ +#define _CHAOSKEY_USB_HWRNG_DRIVER_H_ + +#include +#include +#include +#include + +#include +#include + +#define CHAOSKEY_VENDOR_ID 0x1d50 /* OpenMoko */ +#define CHAOSKEY_PRODUCT_ID 0x60c6 /* ChaosKey */ + +#define CHAOSKEY_TIMEOUT 10 // ms +#define CHAOSKEY_MAX_EP_SIZE 64 // max EP size for full-speed devices + +#define CHAOSKEY_DEV_SIGNATURE SIGNATURE_32('c','h','k','e') + +typedef struct { + UINT32 Signature; + UINT16 EndpointAddress; + UINT16 EndpointSize; + EFI_USB_IO_PROTOCOL *UsbIo; + EFI_RNG_PROTOCOL Rng; +} CHAOSKEY_DEV; + +#define CHAOSKEY_DEV_FROM_THIS(a) \ + CR(a, CHAOSKEY_DEV, Rng, CHAOSKEY_DEV_SIGNATURE) + +extern EFI_COMPONENT_NAME_PROTOCOL gChaosKeyDriverComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gChaosKeyDriverComponentName2; + +EFI_STATUS +ChaosKeyInit ( + IN EFI_HANDLE DriverBindingHandle, + IN EFI_HANDLE ControllerHandle + ); + +EFI_STATUS +ChaosKeyRelease ( + IN EFI_HANDLE DriverBindingHandle, + IN EFI_HANDLE ControllerHandle + ); + +#endif // _CHAOSKEY_USB_HWRNG_DRIVER_H_ diff --git a/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDxe.inf b/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDxe.inf new file mode 100644 index 000000000000..2ff84956ca72 --- /dev/null +++ b/Silicon/Openmoko/ChaosKeyDxe/ChaosKeyDxe.inf @@ -0,0 +1,48 @@ +## @file +# Device driver for the ChaosKey hardware random number generator. +# +# Copyright (c) 2016 - 2017, Linaro Ltd. 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. +# +## + +[Defines] + INF_VERSION = 0x00010019 + BASE_NAME = ChaosKeyDxe + FILE_GUID = 9A54122B-F5E4-40D8-AE61-A71E406ED449 + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = EntryPoint + UNLOAD_IMAGE = UnloadImage + +# +# VALID_ARCHITECTURES = AARCH64 ARM EBC IA32 IPF X64 +# + +[Sources] + ChaosKeyDriver.c + ChaosKeyDriver.h + ComponentName.c + DriverBinding.c + +[Packages] + MdePkg/MdePkg.dec + +[LibraryClasses] + UefiBootServicesTableLib + UefiDriverEntryPoint + UefiLib + +[Protocols] + gEfiRngProtocolGuid # PROTOCOL BY_START + gEfiUsbIoProtocolGuid # PROTOCOL TO_START + +[Guids] + gEfiRngAlgorithmRaw diff --git a/Silicon/Openmoko/ChaosKeyDxe/ComponentName.c b/Silicon/Openmoko/ChaosKeyDxe/ComponentName.c new file mode 100644 index 000000000000..81f2130bcd9e --- /dev/null +++ b/Silicon/Openmoko/ChaosKeyDxe/ComponentName.c @@ -0,0 +1,205 @@ +/** @file + UEFI Component Name(2) protocol implementation for ChaosKey driver. + + Copyright (c) 2017, Linaro Ltd. 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. + +**/ + +#include "ChaosKeyDriver.h" + +STATIC EFI_UNICODE_STRING_TABLE mChaosKeyDriverNameTable[] = { + { + "eng;en", + (CHAR16 *)L"ChaosKey RNG USB driver" + }, + { + NULL, + NULL + } +}; + +STATIC EFI_UNICODE_STRING_TABLE mChaosKeyControllerNameTable[] = { + { + "eng;en", + (CHAR16 *)L"ChaosKey Random Number Generator (USB)" + }, + { + NULL, + NULL + } +}; + +/** + 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 This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param Language[in] 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 DriverName[out] 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. + +**/ +STATIC +EFI_STATUS +EFIAPI +ChaosKeyDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mChaosKeyDriverNameTable, + DriverName, + (BOOLEAN)(This == &gChaosKeyDriverComponentName) + ); +} + +/** + 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 This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param ControllerHandle[in] 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[in] 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[in] 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 ControllerName[out] 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. + +**/ +STATIC +EFI_STATUS +EFIAPI +ChaosKeyGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + if (ChildHandle != NULL) { + return EFI_UNSUPPORTED; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mChaosKeyControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gChaosKeyDriverComponentName) + ); +} + +// +// EFI Component Name Protocol +// +EFI_COMPONENT_NAME_PROTOCOL gChaosKeyDriverComponentName = { + ChaosKeyDriverName, + ChaosKeyControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +EFI_COMPONENT_NAME2_PROTOCOL gChaosKeyDriverComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) ChaosKeyGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) ChaosKeyGetControllerName, + "en" +}; diff --git a/Silicon/Openmoko/ChaosKeyDxe/DriverBinding.c b/Silicon/Openmoko/ChaosKeyDxe/DriverBinding.c new file mode 100644 index 000000000000..a1a5a796d38d --- /dev/null +++ b/Silicon/Openmoko/ChaosKeyDxe/DriverBinding.c @@ -0,0 +1,256 @@ +/** @file + Device driver for the ChaosKey hardware random number generator. + + Copyright (c) 2016 - 2017, Linaro Ltd. 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. + +**/ + +#include + +#include "ChaosKeyDriver.h" + +/** + Tests to see if this driver supports a given controller. + + @param This[in] A pointer to the EFI_DRIVER_BINDING_PROTOCOL + instance. + @param ControllerHandle[in] The handle of the controller to test. + @param RemainingDevicePath[in] The remaining device path. + (Ignored - this is not a bus driver.) + + @retval EFI_SUCCESS The driver supports this controller. + @retval EFI_ALREADY_STARTED The device specified by ControllerHandle is + already being managed by the driver specified + by This. + @retval EFI_UNSUPPORTED The device specified by ControllerHandle is + not supported by the driver specified by This. + +**/ +EFI_STATUS +EFIAPI +UsbHwrngDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +{ + EFI_USB_DEVICE_DESCRIPTOR Device; + EFI_USB_IO_PROTOCOL *UsbIo; + EFI_STATUS Status; + + // + // Connect to the USB stack + // + Status = gBS->OpenProtocol (ControllerHandle, + &gEfiUsbIoProtocolGuid, + (VOID **) &UsbIo, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Get the interface descriptor to check the USB class and find a transport + // protocol handler. + // + Status = UsbIo->UsbGetDeviceDescriptor (UsbIo, &Device); + if (!EFI_ERROR (Status)) { + // + // Validate the adapter + // + if ((Device.IdVendor != CHAOSKEY_VENDOR_ID) || + (Device.IdProduct != CHAOSKEY_PRODUCT_ID)) { + Status = EFI_UNSUPPORTED; + } else { + DEBUG ((DEBUG_INIT | DEBUG_INFO, + "ChaosKey (0x%04x:0x%04x) is my homeboy!\n", + Device.IdVendor, Device.IdProduct)); + Status = EFI_SUCCESS; + } + } + + // + // Clean up. + // + gBS->CloseProtocol (ControllerHandle, + &gEfiUsbIoProtocolGuid, + This->DriverBindingHandle, + ControllerHandle); + + return Status; +} + + +/** + Starts a device controller or a bus controller. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL + instance. + @param[in] ControllerHandle The handle of the device to start. This + handle must support a protocol interface that + supplies an I/O abstraction to the driver. + @param[in] RemainingDevicePath The remaining portion of the device path. + (Ignored - this is not a bus driver.) + + @retval EFI_SUCCESS The device was started. + @retval EFI_DEVICE_ERROR The device could not be started due to a + device error. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a + lack of resources. + +**/ +EFI_STATUS +EFIAPI +UsbHwrngDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + return ChaosKeyInit (This->DriverBindingHandle, ControllerHandle); +} + + +/** + Stops a device controller or a bus controller. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL + instance. + @param[in] ControllerHandle A handle to the device being stopped. The handle + must support a bus specific I/O protocol for the + driver to use to stop the device. + @param[in] NumberOfChildren The number of child device handles in + ChildHandleBuffer. + @param[in] ChildHandleBuffer An array of child handles to be freed. May be + NULL if NumberOfChildren is 0. + + @retval EFI_SUCCESS The device was stopped. + @retval EFI_DEVICE_ERROR The device could not be stopped due to a device + error. + +**/ +EFI_STATUS +EFIAPI +UsbHwrngDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer OPTIONAL + ) +{ + return ChaosKeyRelease (This->DriverBindingHandle, ControllerHandle); +} + + +STATIC +EFI_DRIVER_BINDING_PROTOCOL gUsbDriverBinding = { + UsbHwrngDriverBindingSupported, + UsbHwrngDriverBindingStart, + UsbHwrngDriverBindingStop, + 0xa, + NULL, + NULL +}; + + +/** + The entry point of ChaosKey UEFI Driver. + + @param ImageHandle The image handle of the UEFI Driver. + @param SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The Driver or UEFI Driver exited normally. + @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than + SystemTable->Hdr.Revision. + +**/ +EFI_STATUS +EFIAPI +EntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_STATUS Status; + + // + // Add the driver to the list of drivers + // + Status = EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, SystemTable, &gUsbDriverBinding, ImageHandle, + &gChaosKeyDriverComponentName, &gChaosKeyDriverComponentName2); + ASSERT_EFI_ERROR (Status); + + DEBUG ((DEBUG_INIT | DEBUG_INFO, "*** Installed ChaosKey driver! ***\n")); + + return EFI_SUCCESS; +} + + +/** + Unload function for the ChaosKey Driver. + + @param ImageHandle[in] The allocated handle for the EFI image + + @retval EFI_SUCCESS The driver was unloaded successfully + @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle. + +**/ +EFI_STATUS +EFIAPI +UnloadImage ( + IN EFI_HANDLE ImageHandle + ) +{ + EFI_STATUS Status; + EFI_HANDLE *HandleBuffer; + UINTN HandleCount; + UINTN Index; + + // + // Retrieve all USB I/O handles in the handle database + // + Status = gBS->LocateHandleBuffer (ByProtocol, + &gEfiUsbIoProtocolGuid, + NULL, + &HandleCount, + &HandleBuffer); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Disconnect the driver from the handles in the handle database + // + for (Index = 0; Index < HandleCount; Index++) { + Status = gBS->DisconnectController (HandleBuffer[Index], + gImageHandle, + NULL); + } + + // + // Free the handle array + // + gBS->FreePool (HandleBuffer); + + // + // Uninstall protocols installed by the driver in its entrypoint + // + Status = gBS->UninstallMultipleProtocolInterfaces (ImageHandle, + &gEfiDriverBindingProtocolGuid, + &gUsbDriverBinding, + NULL + ); + + return EFI_SUCCESS; +}