Re: [edk2-devel] [edk2-staging/RISC-V-V2 PATCH v2 09/29] MdePkg/BaseIoLibIntrinsic: RISC-V I/O intrinsic functions.

["Philippe Mathieu-Daudé" <philmd@redhat.com>]

Hi Leif,

On 9/27/19 1:39 AM, Leif Lindholm wrote:
> On Mon, Sep 23, 2019 at 08:31:35AM +0800, Abner Chang wrote:
>> RISC-V MMIO library instance.  RISC-V only supports memory map I/O.
> 
> We need fewer, not more, C implementations of MMIO accessors.
> While this set doesn't need to wait for upstream to get sorted, please
> just use IoLibArm.c which should be completely equivalent to what you
> have implemented here.

This shows this file name is misleading. However I can't come with a 
clever one :/

>> Signed-off-by: Abner Chang <abner.chang@hpe.com>
>> ---
>>   .../BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf      |   8 +-
>>   MdePkg/Library/BaseIoLibIntrinsic/IoLibRiscV.c     | 601 +++++++++++++++++++++
>>   2 files changed, 607 insertions(+), 2 deletions(-)
>>   create mode 100644 MdePkg/Library/BaseIoLibIntrinsic/IoLibRiscV.c
>>
>> diff --git a/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf b/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf
>> index 457cce9..fbb568e 100644
>> --- a/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf
>> +++ b/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf
>> @@ -2,13 +2,14 @@
>>   #  Instance of I/O Library using compiler intrinsics.
>>   #
>>   #  I/O Library that uses compiler intrinsics to perform IN and OUT instructions
>> -#  for IA-32 and x64.  On IPF, I/O port requests are translated into MMIO requests.
>> +#  for IA-32, x64 and RISC-V.  On IPF, I/O port requests are translated into MMIO requests.
>>   #  MMIO requests are forwarded directly to memory.  For EBC, I/O port requests
>>   #  ASSERT().
>>   #
>>   #  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
>>   #  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
>>   #  Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
>> +#  Portinos Copyright (c) 2016, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
>>   #
>>   #  SPDX-License-Identifier: BSD-2-Clause-Patent
>>   #
>> @@ -25,7 +26,7 @@
>>   
>>   
>>   #
>> -#  VALID_ARCHITECTURES           = IA32 X64 EBC ARM AARCH64
>> +#  VALID_ARCHITECTURES           = IA32 X64 EBC ARM AARCH64 RISCV64
>>   #
>>   
>>   [Sources]
>> @@ -55,6 +56,9 @@
>>   [Sources.AARCH64]
>>     IoLibArm.c
>>   
>> +[Sources.RISCV64]
>> +  IoLibRiscV.c
>> +
>>   [Packages]
>>     MdePkg/MdePkg.dec
>>   
>> diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibRiscV.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibRiscV.c
>> new file mode 100644
>> index 0000000..789928b
>> --- /dev/null
>> +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibRiscV.c
>> @@ -0,0 +1,601 @@
>> +/** @file
>> +  Common I/O Library routines for RISC-V
>> +
>> +  Copyright (c) 2016 - 2019, Hewlett Packard Enterprise Development LP. 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 "BaseIoLibIntrinsicInternal.h"
>> +
>> +/**
>> +  Reads an 8-bit MMIO register.
>> +
>> +  Reads the 8-bit MMIO register specified by Address. The 8-bit read value is
>> +  returned. This function must guarantee that all MMIO read and write
>> +  operations are serialized.
>> +
>> +  If 8-bit MMIO register operations are not supported, then ASSERT().
>> +
>> +  @param  Address The MMIO register to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT8
>> +EFIAPI
>> +MmioRead8 (
>> +  IN      UINTN                     Address
>> +  )
>> +{
>> +  return *(volatile UINT8*)Address;
>> +}
>> +
>> +/**
>> +  Writes an 8-bit MMIO register.
>> +
>> +  Writes the 8-bit MMIO register specified by Address with the value specified
>> +  by Value and returns Value. This function must guarantee that all MMIO read
>> +  and write operations are serialized.
>> +
>> +  If 8-bit MMIO register operations are not supported, then ASSERT().
>> +
>> +  @param  Address The MMIO register to write.
>> +  @param  Value   The value to write to the MMIO register.
>> +
>> +  @return Value.
>> +
>> +**/
>> +UINT8
>> +EFIAPI
>> +MmioWrite8 (
>> +  IN      UINTN                     Address,
>> +  IN      UINT8                     Value
>> +  )
>> +{
>> +  *(volatile UINT8 *)Address = Value;
>> +  return Value;
>> +}
>> +
>> +/**
>> +  Reads a 16-bit MMIO register.
>> +
>> +  Reads the 16-bit MMIO register specified by Address. The 16-bit read value is
>> +  returned. This function must guarantee that all MMIO read and write
>> +  operations are serialized.
>> +
>> +  If 16-bit MMIO register operations are not supported, then ASSERT().
>> +  If Address is not aligned on a 16-bit boundary, then ASSERT().
>> +
>> +  @param  Address The MMIO register to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT16
>> +EFIAPI
>> +MmioRead16 (
>> +  IN      UINTN                     Address
>> +  )
>> +{
>> +  return *(volatile UINT16 *)Address;
>> +}
>> +
>> +/**
>> +  Writes a 16-bit MMIO register.
>> +
>> +  Writes the 16-bit MMIO register specified by Address with the value specified
>> +  by Value and returns Value. This function must guarantee that all MMIO read
>> +  and write operations are serialized.
>> +
>> +  If 16-bit MMIO register operations are not supported, then ASSERT().
>> +  If Address is not aligned on a 16-bit boundary, then ASSERT().
>> +
>> +  @param  Address The MMIO register to write.
>> +  @param  Value   The value to write to the MMIO register.
>> +
>> +  @return Value.
>> +
>> +**/
>> +UINT16
>> +EFIAPI
>> +MmioWrite16 (
>> +  IN      UINTN                     Address,
>> +  IN      UINT16                    Value
>> +  )
>> +{
>> +  *(volatile UINT16 *)Address = Value;
>> +  return Value;
>> +}
>> +
>> +/**
>> +  Reads a 32-bit MMIO register.
>> +
>> +  Reads the 32-bit MMIO register specified by Address. The 32-bit read value is
>> +  returned. This function must guarantee that all MMIO read and write
>> +  operations are serialized.
>> +
>> +  If 32-bit MMIO register operations are not supported, then ASSERT().
>> +  If Address is not aligned on a 32-bit boundary, then ASSERT().
>> +
>> +  @param  Address The MMIO register to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT32
>> +EFIAPI
>> +MmioRead32 (
>> +  IN      UINTN                     Address
>> +  )
>> +{
>> +  return *(volatile UINT32 *)Address;
>> +}
>> +
>> +/**
>> +  Writes a 32-bit MMIO register.
>> +
>> +  Writes the 32-bit MMIO register specified by Address with the value specified
>> +  by Value and returns Value. This function must guarantee that all MMIO read
>> +  and write operations are serialized.
>> +
>> +  If 32-bit MMIO register operations are not supported, then ASSERT().
>> +  If Address is not aligned on a 32-bit boundary, then ASSERT().
>> +
>> +  @param  Address The MMIO register to write.
>> +  @param  Value   The valu  return *(volatile UINT8*)Address;
>> +                  to write to the MMIO register.
>> +
>> +  @return Value.
>> +
>> +**/
>> +UINT32
>> +EFIAPI
>> +MmioWrite32 (
>> +  IN      UINTN                     Address,
>> +  IN      UINT32                    Value
>> +  )
>> +{
>> +  *(volatile UINT32 *)Address = Value;
>> +  return Value;
>> +}
>> +
>> +/**
>> +  Reads a 64-bit MMIO register.
>> +
>> +  Reads the 64-bit MMIO register specified by Address. The 64-bit read value is
>> +  returned. This function must guarantee that all MMIO read and write
>> +  operations are serialized.
>> +
>> +  If 64-bit MMIO register operations are not supported, then ASSERT().
>> +  If Address is not aligned on a 64-bit boundary, then ASSERT().
>> +
>> +  @param  Address The MMIO register to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT64
>> +EFIAPI
>> +MmioRead64 (
>> +  IN      UINTN                     Address
>> +  )
>> +{
>> +  return *(volatile UINT64 *)Address;
>> +}
>> +
>> +/**
>> +  Writes a 64-bit MMIO register.
>> +
>> +  Writes the 64-bit MMIO register specified by Address with the value specified
>> +  by Value and returns Value. This function must guarantee that all MMIO read
>> +  and write operations are serialized.
>> +
>> +  If 64-bit MMIO register operations are not supported, then ASSERT().
>> +  If Address is not aligned on a 64-bit boundary, then ASSERT().
>> +
>> +  @param  Address The MMIO register to write.
>> +  @param  Value   The value to write to the MMIO register.
>> +
>> +**/
>> +UINT64
>> +EFIAPI
>> +MmioWrite64 (
>> +  IN      UINTN                     Address,
>> +  IN      UINT64                    Value
>> +  )
>> +{
>> +  *(volatile UINT64 *)Address = Value;
>> +  return Value;
>> +}
>> +
>> +/**
>> +  Reads an 8-bit I/O port.
>> +
>> +  Reads the 8-bit I/O port specified by Port. The 8-bit read value is returned.
>> +  This function must guarantee that all I/O read and write operations are
>> +  serialized.
>> +
>> +  If 8-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port  The I/O port to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT8
>> +EFIAPI
>> +IoRead8 (
>> +  IN      UINTN                     Port
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Writes an 8-bit I/O port.
>> +
>> +  Writes the 8-bit I/O port specified by Port with the value specified by Value
>> +  and returns Value. This function must guarantee that all I/O read and write
>> +  operations are serialized.
>> +
>> +  If 8-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port  The I/O port to write.
>> +  @param  Value The value to write to the I/O port.
>> +
>> +  @return The value written the I/O port.
>> +
>> +**/
>> +
>> +UINT8
>> +EFIAPI
>> +IoWrite8 (
>> +  IN      UINTN                     Port,
>> +  IN      UINT8                     Value
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Reads a 16-bit I/O port.
>> +
>> +  Reads the 16-bit I/O port specified by Port. The 16-bit read value is returned.
>> +  This function must guarantee that all I/O read and write operations are
>> +  serialized.
>> +
>> +  If 16-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port  The I/O port to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT16
>> +EFIAPI
>> +IoRead16 (
>> +  IN      UINTN                     Port
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Writes a 16-bit I/O port.
>> +
>> +  Writes the 16-bit I/O port specified by Port with the value specified by Value
>> +  and returns Value. This function must guarantee that all I/O read and write
>> +  operations are serialized.
>> +
>> +  If 16-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port  The I/O port to write.
>> +  @param  Value The value to write to the I/O port.
>> +
>> +  @return The value written the I/O port.
>> +
>> +**/
>> +UINT16
>> +EFIAPI
>> +IoWrite16 (
>> +  IN      UINTN                     Port,
>> +  IN      UINT16                    Value
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Reads a 32-bit I/O port.
>> +
>> +  Reads the 32-bit I/O port specified by Port. The 32-bit read value is returned.
>> +  This function must guarantee that all I/O read and write operations are
>> +  serialized.
>> +
>> +  If 32-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port  The I/O port to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT32
>> +EFIAPI
>> +IoRead32 (
>> +  IN      UINTN                     Port
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Writes a 32-bit I/O port.
>> +
>> +  Writes the 32-bit I/O port specified by Port with the value specified by Value
>> +  and returns Value. This function must guarantee that all I/O read and write
>> +  operations are serialized.
>> +
>> +  If 32-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port  The I/O port to write.
>> +  @param  Value The value to write to the I/O port.
>> +
>> +  @return The value written the I/O port.
>> +
>> +**/
>> +UINT32
>> +EFIAPI
>> +IoWrite32 (
>> +  IN      UINTN                     Port,
>> +  IN      UINT32                    Value
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Reads a 64-bit I/O port.
>> +
>> +  Reads the 64-bit I/O port specified by Port. The 64-bit read value is returned.
>> +  This function must guarantee that all I/O read and write operations are
>> +  serialized.
>> +
>> +  If 64-bit I/O port operations are not supported, then ASSERT().
>> +  If Port is not aligned on a 64-bit boundary, then ASSERT().
>> +
>> +  @param  Port  The I/O port to read.
>> +
>> +  @return The value read.
>> +
>> +**/
>> +UINT64
>> +EFIAPI
>> +IoRead64 (
>> +  IN      UINTN                     Port
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Writes a 64-bit I/O port.
>> +
>> +  Writes the 64-bit I/O port specified by Port with the value specified by Value
>> +  and returns Value. This function must guarantee that all I/O read and write
>> +  operations are serialized.
>> +
>> +  If 64-bit I/O port operations are not supported, then ASSERT().
>> +  If Port is not aligned on a 64-bit boundary, then ASSERT().
>> +
>> +  @param  Port  The I/O port to write.
>> +  @param  Value The value to write to the I/O port.
>> +
>> +  @return The value written to the I/O port.
>> +
>> +**/
>> +UINT64
>> +EFIAPI
>> +IoWrite64 (
>> +  IN      UINTN                     Port,
>> +  IN      UINT64                    Value
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +  return 0;
>> +}
>> +
>> +/**
>> +  Reads an 8-bit I/O port fifo into a block of memory.
>> +
>> +  Reads the 8-bit I/O fifo port specified by Port.
>> +  The port is read Count times, and the read data is
>> +  stored in the provided Buffer.
>> +
>> +  This function must guarantee that all I/O read and write operations are
>> +  serialized.
>> +
>> +  If 8-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port    The I/O port to read.
>> +  @param  Count   The number of times to read I/O port.
>> +  @param  Buffer  The buffer to store the read data into.
>> +
>> +**/
>> +VOID
>> +EFIAPI
>> +IoReadFifo8 (
>> +  IN      UINTN                     Port,
>> +  IN      UINTN                     Count,
>> +  OUT     VOID                      *Buffer
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +}
>> +
>> +/**
>> +  Writes a block of memory into an 8-bit I/O port fifo.
>> +
>> +  Writes the 8-bit I/O fifo port specified by Port.
>> +  The port is written Count times, and the write data is
>> +  retrieved from the provided Buffer.
>> +
>> +  This function must guarantee that all I/O write and write operations are
>> +  serialized.
>> +
>> +  If 8-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port    The I/O port to write.
>> +  @param  Count   The number of times to write I/O port.
>> +  @param  Buffer  The buffer to retrieve the write data from.
>> +
>> +**/
>> +VOID
>> +EFIAPI
>> +IoWriteFifo8 (
>> +  IN      UINTN                     Port,
>> +  IN      UINTN                     Count,
>> +  IN      VOID                      *Buffer
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +}
>> +
>> +/**
>> +  Reads a 16-bit I/O port fifo into a block of memory.
>> +
>> +  Reads the 16-bit I/O fifo port specified by Port.
>> +  The port is read Count times, and the read data is
>> +  stored in the provided Buffer.
>> +
>> +  This function must guarantee that all I/O read and write operations are
>> +  serialized.
>> +
>> +  If 16-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port    The I/O port to read.
>> +  @param  Count   The number of times to read I/O port.
>> +  @param  Buffer  The buffer to store the read data into.
>> +
>> +**/
>> +VOID
>> +EFIAPI
>> +IoReadFifo16 (
>> +  IN      UINTN                     Port,
>> +  IN      UINTN                     Count,
>> +  OUT     VOID                      *Buffer
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +}
>> +
>> +/**
>> +  Writes a block of memory into a 16-bit I/O port fifo.
>> +
>> +  Writes the 16-bit I/O fifo port specified by Port.
>> +  The port is written Count times, and the write data is
>> +  retrieved from the provided Buffer.
>> +
>> +  This function must guarantee that all I/O write and write operations are
>> +  serialized.
>> +
>> +  If 16-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port    The I/O port to write.
>> +  @param  Count   The number of times to write I/O port.
>> +  @param  Buffer  The buffer to retrieve the write data from.
>> +
>> +**/
>> +VOID
>> +EFIAPI
>> +IoWriteFifo16 (
>> +  IN      UINTN                     Port,
>> +  IN      UINTN                     Count,
>> +  IN      VOID                      *Buffer
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +}
>> +
>> +/**
>> +  Reads a 32-bit I/O port fifo into a block of memory.
>> +
>> +  Reads the 32-bit I/O fifo port specified by Port.
>> +  The port is read Count times, and the read data is
>> +  stored in the provided Buffer.
>> +
>> +  This function must guarantee that all I/O read and write operations are
>> +  serialized.
>> +
>> +  If 32-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port    The I/O port to read.
>> +  @param  Count   The number of times to read I/O port.
>> +  @param  Buffer  The buffer to store the read data into.
>> +
>> +**/
>> +VOID
>> +EFIAPI
>> +IoReadFifo32 (
>> +  IN      UINTN                     Port,
>> +  IN      UINTN                     Count,
>> +  OUT     VOID                      *Buffer
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +}
>> +
>> +/**
>> +  Writes a block of memory into a 32-bit I/O port fifo.
>> +
>> +  Writes the 32-bit I/O fifo port specified by Port.
>> +  The port is written Count times, and the write data is
>> +  retrieved from the provided Buffer.
>> +
>> +  This function must guarantee that all I/O write and write operations are
>> +  serialized.
>> +
>> +  If 32-bit I/O port operations are not supported, then ASSERT().
>> +
>> +  @param  Port    The I/O port to write.
>> +  @param  Count   The number of times to write I/O port.
>> +  @param  Buffer  The buffer to retrieve the write data from.
>> +
>> +**/
>> +VOID
>> +EFIAPI
>> +IoWriteFifo32 (
>> +  IN      UINTN                     Port,
>> +  IN      UINTN                     Count,
>> +  IN      VOID                      *Buffer
>> +  )
>> +{
>> +  DEBUG((DEBUG_ERROR, "%a:RISC-V unsupportted function.\n", __FUNCTION__));
>> +  ASSERT (FALSE);
>> +}
>> -- 
>> 2.7.4
>>
>>
>>
>>
> 
> 
>