Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / RuntimeDxe / EfiRuntimeLib / Io.c

/*++\r
\r
Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  Io.c\r
\r
Abstract:\r
\r
  Light weight lib functions that wrape IoRead (), IoWrite, MemRead (), \r
  and MemWrite ().\r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "EfiRuntimeLib.h"\r
\r
UINT8\r
IoRead8 (\r
  IN  UINT64    Address\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a one byte IO read\r
\r
Arguments:\r
  Address - IO address to read\r
\r
Returns: \r
  Data read\r
\r
--*/\r
{\r
  UINT8 Buffer;\r
\r
  EfiIoRead (EfiCpuIoWidthUint8, Address, 1, &Buffer);\r
  return Buffer;\r
}\r
\r
UINT16\r
IoRead16 (\r
  IN  UINT64    Address\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a two byte IO read\r
\r
Arguments:\r
  Address - IO address to read\r
\r
Returns: \r
  Data read\r
\r
--*/\r
{\r
  UINT16  Buffer;\r
\r
  EfiIoRead (EfiCpuIoWidthUint16, Address, 1, &Buffer);\r
  return Buffer;\r
}\r
\r
UINT32\r
IoRead32 (\r
  IN  UINT64    Address\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a four byte IO read\r
\r
Arguments:\r
  Address - IO address to read\r
\r
Returns: \r
  Data read\r
\r
--*/\r
{\r
  UINT32  Buffer;\r
\r
  EfiIoRead (EfiCpuIoWidthUint32, Address, 1, &Buffer);\r
  return Buffer;\r
}\r
\r
VOID\r
IoWrite8 (\r
  IN  UINT64    Address,\r
  IN  UINT8     Data\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a one byte IO write\r
\r
Arguments:\r
  Address - IO address to write\r
  Data    - Data to write to Address\r
\r
Returns: \r
  NONE\r
\r
--*/\r
{\r
  EfiIoWrite (EfiCpuIoWidthUint8, Address, 1, &Data);\r
}\r
\r
VOID\r
IoWrite16 (\r
  IN  UINT64    Address,\r
  IN  UINT16    Data\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a two byte IO write\r
\r
Arguments:\r
  Address - IO address to write\r
  Data    - Data to write to Address\r
\r
Returns: \r
  NONE\r
\r
--*/\r
{\r
  EfiIoWrite (EfiCpuIoWidthUint16, Address, 1, &Data);\r
}\r
\r
VOID\r
IoWrite32 (\r
  IN  UINT64    Address,\r
  IN  UINT32    Data\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a four byte IO write\r
\r
Arguments:\r
  Address - IO address to write\r
  Data    - Data to write to Address\r
\r
Returns: \r
  NONE\r
\r
--*/\r
{\r
  EfiIoWrite (EfiCpuIoWidthUint32, Address, 1, &Data);\r
}\r
\r
UINT8\r
MemRead8 (\r
  IN  UINT64    Address\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a one byte Memory mapped IO read\r
\r
Arguments:\r
  Address - Memory mapped IO address to read\r
\r
Returns: \r
  Data read\r
\r
--*/\r
{\r
  UINT8   Buffer;\r
\r
  EfiMemRead (EfiCpuIoWidthUint8, Address, 1, &Buffer);\r
  return Buffer;\r
}\r
\r
UINT16\r
MemRead16 (\r
  IN  UINT64    Address\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a two byte Memory mapped IO read\r
\r
Arguments:\r
  Address - Memory mapped IO address to read\r
\r
Returns: \r
  Data read\r
\r
--*/\r
{\r
  UINT16  Buffer;\r
\r
  EfiMemRead (EfiCpuIoWidthUint16, Address, 1, &Buffer);\r
  return Buffer;\r
}\r
\r
UINT32\r
MemRead32 (\r
  IN  UINT64    Address\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a four byte Memory mapped IO read\r
\r
Arguments:\r
  Address - Memory mapped IO address to read\r
\r
Returns: \r
  Data read\r
\r
--*/\r
{\r
  UINT32  Buffer;\r
\r
  EfiMemRead (EfiCpuIoWidthUint32, Address, 1, &Buffer);\r
  return Buffer;\r
}\r
\r
UINT64\r
MemRead64 (\r
  IN  UINT64    Address\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a eight byte Memory mapped IO read\r
\r
Arguments:\r
  Address - Memory mapped IO address to read\r
\r
Returns: \r
  Data read\r
\r
--*/\r
{\r
  UINT64  Buffer;\r
\r
  EfiMemRead (EfiCpuIoWidthUint64, Address, 1, &Buffer);\r
  return Buffer;\r
}\r
\r
VOID\r
MemWrite8 (\r
  IN  UINT64    Address,\r
  IN  UINT8     Data\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a one byte Memory mapped IO write\r
\r
Arguments:\r
  Address - Memory mapped IO address to write\r
  Data    - Data to write to Address\r
\r
Returns: \r
  NONE\r
\r
--*/\r
{\r
  EfiMemWrite (EfiCpuIoWidthUint8, Address, 1, &Data);\r
}\r
\r
VOID\r
MemWrite16 (\r
  IN  UINT64    Address,\r
  IN  UINT16    Data\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a two byte Memory mapped IO write\r
\r
Arguments:\r
  Address - Memory mapped IO address to write\r
  Data    - Data to write to Address\r
\r
Returns: \r
  NONE\r
\r
--*/\r
{\r
  EfiMemWrite (EfiCpuIoWidthUint16, Address, 1, &Data);\r
}\r
\r
VOID\r
MemWrite32 (\r
  IN  UINT64    Address,\r
  IN  UINT32    Data\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a four byte Memory mapped IO write\r
\r
Arguments:\r
  Address - Memory mapped IO address to write\r
  Data    - Data to write to Address\r
\r
Returns: \r
  NONE\r
\r
--*/\r
{\r
  EfiMemWrite (EfiCpuIoWidthUint32, Address, 1, &Data);\r
}\r
\r
VOID\r
MemWrite64 (\r
  IN  UINT64    Address,\r
  IN  UINT64    Data\r
  )\r
/*++\r
\r
Routine Description:\r
  Do a eight byte Memory mapped IO write\r
\r
Arguments:\r
  Address - Memory mapped IO address to write\r
  Data    - Data to write to Address\r
\r
Returns: \r
  NONE\r
\r
--*/\r
{\r
  EfiMemWrite (EfiCpuIoWidthUint64, Address, 1, &Data);\r
}\r