[mirror_edk2.git] / MdePkg / Library / DxeIoLibCpuIo2 / DxeCpuIo2LibInternal.h

/** @file\r
  Internal include file of DXE CPU IO2 Library.\r
\r
  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  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
**/\r
\r
#ifndef _DXE_CPUIO2_LIB_INTERNAL_H_\r
#define _DXE_CPUIO2_LIB_INTERNAL_H_\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/CpuIo2.h>\r
\r
#include <Library/IoLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
\r
\r
/**\r
  Reads registers in the EFI CPU I/O space.\r
\r
  Reads the I/O port specified by Port with registers width specified by Width.\r
  The read value is returned.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
\r
  @return Data read from registers in the EFI CPU I/O space.\r
\r
**/\r
UINT64\r
EFIAPI\r
IoReadWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width\r
  );\r
\r
/**\r
  Writes registers in the EFI CPU I/O space.\r
\r
  Writes the I/O port specified by Port with registers width and value specified by Width\r
  and Data respectively. Data is returned.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Data          The value to write to the I/O port.\r
\r
  @return The parameter of Data.\r
\r
**/\r
UINT64\r
EFIAPI\r
IoWriteWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
  IN      UINT64                     Data\r
  );\r
\r
/**\r
  Reads registers in the EFI CPU I/O space.\r
\r
  Reads the I/O port specified by Port with registers width specified by Width.\r
  The port is read Count times, and the read data is stored in the provided Buffer.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Count         The number of times to read I/O port.\r
  @param  Buffer        The buffer to store the read data into.\r
\r
**/\r
VOID\r
EFIAPI\r
IoReadFifoWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
  IN      UINTN                      Count,\r
  IN      VOID                       *Buffer\r
  );\r
\r
/**\r
  Writes registers in the EFI CPU I/O space.\r
\r
  Writes the I/O port specified by Port with registers width specified by Width.\r
  The port is written Count times, and the write data is retrieved from the provided Buffer.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Count         The number of times to write I/O port.\r
  @param  Buffer        The buffer to store the read data into.\r
\r
**/\r
VOID\r
EFIAPI\r
IoWriteFifoWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
  IN      UINTN                      Count,\r
  IN      VOID                       *Buffer\r
  );\r
\r
/**\r
  Reads memory-mapped registers in the EFI system memory space.\r
\r
  Reads the MMIO registers specified by Address with registers width specified by Width.\r
  The read value is returned. If such operations are not supported, then ASSERT().\r
  This function must guarantee that all MMIO read and write operations are serialized.\r
\r
  @param  Address       The MMIO register to read.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
\r
  @return Data read from registers in the EFI system memory space.\r
\r
**/\r
UINT64\r
EFIAPI\r
MmioReadWorker (\r
  IN      UINTN                     Address,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH Width\r
  );\r
\r
/**\r
  Writes memory-mapped registers in the EFI system memory space.\r
\r
  Writes the MMIO registers specified by Address with registers width and value specified by Width\r
  and Data respectively. Data is returned. If such operations are not supported, then ASSERT().\r
  This function must guarantee that all MMIO read and write operations are serialized.\r
\r
  @param  Address       The MMIO register to read.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Data          The value to write to the I/O port.\r
\r
  @return Data read from registers in the EFI system memory space.\r
\r
**/\r
UINT64\r
EFIAPI\r
MmioWriteWorker (\r
  IN      UINTN                     Address,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
  IN      UINT64                    Data\r
  );\r
\r
#endif\r
Commit	Line	Data
ba9f8351	1	/** @file\r
ba9f8351	2	Internal include file of DXE CPU IO2 Library.\r
9095d37b LG	3	\r
9095d37b LG	4	Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
61e1deec LD	5	Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
61e1deec LD	6	\r
ba9f8351	7	This program and the accompanying materials are licensed and made available\r
	8	under the terms and conditions of the BSD License which accompanies this\r
	9	distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php.\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef _DXE_CPUIO2_LIB_INTERNAL_H_\r
	18	#define _DXE_CPUIO2_LIB_INTERNAL_H_\r
	19	\r
	20	#include <PiDxe.h>\r
	21	\r
	22	#include <Protocol/CpuIo2.h>\r
	23	\r
	24	#include <Library/IoLib.h>\r
	25	#include <Library/UefiBootServicesTableLib.h>\r
	26	#include <Library/DebugLib.h>\r
	27	#include <Library/BaseLib.h>\r
	28	\r
	29	\r
	30	/**\r
	31	Reads registers in the EFI CPU I/O space.\r
	32	\r
	33	Reads the I/O port specified by Port with registers width specified by Width.\r
61e1deec LD	34	The read value is returned.\r
61e1deec LD	35	\r
ba9f8351	36	This function must guarantee that all I/O read and write operations are serialized.\r
61e1deec	37	If such operations are not supported, then ASSERT().\r
ba9f8351	38	\r
	39	@param Port The base address of the I/O operation.\r
	40	The caller is responsible for aligning the Address if required.\r
	41	@param Width The width of the I/O operation.\r
	42	\r
	43	@return Data read from registers in the EFI CPU I/O space.\r
	44	\r
	45	**/\r
	46	UINT64\r
	47	EFIAPI\r
	48	IoReadWorker (\r
61e1deec LD	49	IN UINTN Port,\r
61e1deec LD	50	IN EFI_CPU_IO_PROTOCOL_WIDTH Width\r
ba9f8351	51	);\r
	52	\r
	53	/**\r
	54	Writes registers in the EFI CPU I/O space.\r
	55	\r
	56	Writes the I/O port specified by Port with registers width and value specified by Width\r
61e1deec LD	57	and Data respectively. Data is returned.\r
61e1deec LD	58	\r
ba9f8351	59	This function must guarantee that all I/O read and write operations are serialized.\r
61e1deec	60	If such operations are not supported, then ASSERT().\r
ba9f8351	61	\r
	62	@param Port The base address of the I/O operation.\r
	63	The caller is responsible for aligning the Address if required.\r
	64	@param Width The width of the I/O operation.\r
	65	@param Data The value to write to the I/O port.\r
	66	\r
00b7cc0f	67	@return The parameter of Data.\r
ba9f8351	68	\r
	69	**/\r
	70	UINT64\r
	71	EFIAPI\r
	72	IoWriteWorker (\r
61e1deec LD	73	IN UINTN Port,\r
	74	IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
	75	IN UINT64 Data\r
	76	);\r
	77	\r
	78	/**\r
	79	Reads registers in the EFI CPU I/O space.\r
	80	\r
	81	Reads the I/O port specified by Port with registers width specified by Width.\r
	82	The port is read Count times, and the read data is stored in the provided Buffer.\r
	83	\r
	84	This function must guarantee that all I/O read and write operations are serialized.\r
	85	If such operations are not supported, then ASSERT().\r
	86	\r
	87	@param Port The base address of the I/O operation.\r
	88	The caller is responsible for aligning the Address if required.\r
	89	@param Width The width of the I/O operation.\r
	90	@param Count The number of times to read I/O port.\r
	91	@param Buffer The buffer to store the read data into.\r
	92	\r
	93	**/\r
	94	VOID\r
	95	EFIAPI\r
	96	IoReadFifoWorker (\r
	97	IN UINTN Port,\r
	98	IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
	99	IN UINTN Count,\r
	100	IN VOID *Buffer\r
	101	);\r
	102	\r
	103	/**\r
	104	Writes registers in the EFI CPU I/O space.\r
	105	\r
	106	Writes the I/O port specified by Port with registers width specified by Width.\r
	107	The port is written Count times, and the write data is retrieved from the provided Buffer.\r
	108	\r
	109	This function must guarantee that all I/O read and write operations are serialized.\r
	110	If such operations are not supported, then ASSERT().\r
	111	\r
	112	@param Port The base address of the I/O operation.\r
	113	The caller is responsible for aligning the Address if required.\r
	114	@param Width The width of the I/O operation.\r
	115	@param Count The number of times to write I/O port.\r
	116	@param Buffer The buffer to store the read data into.\r
	117	\r
	118	**/\r
	119	VOID\r
	120	EFIAPI\r
	121	IoWriteFifoWorker (\r
	122	IN UINTN Port,\r
	123	IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
	124	IN UINTN Count,\r
	125	IN VOID *Buffer\r
ba9f8351	126	);\r
	127	\r
	128	/**\r
	129	Reads memory-mapped registers in the EFI system memory space.\r
	130	\r
	131	Reads the MMIO registers specified by Address with registers width specified by Width.\r
	132	The read value is returned. If such operations are not supported, then ASSERT().\r
	133	This function must guarantee that all MMIO read and write operations are serialized.\r
	134	\r
	135	@param Address The MMIO register to read.\r
	136	The caller is responsible for aligning the Address if required.\r
	137	@param Width The width of the I/O operation.\r
	138	\r
	139	@return Data read from registers in the EFI system memory space.\r
	140	\r
	141	**/\r
	142	UINT64\r
	143	EFIAPI\r
	144	MmioReadWorker (\r
	145	IN UINTN Address,\r
	146	IN EFI_CPU_IO_PROTOCOL_WIDTH Width\r
	147	);\r
	148	\r
	149	/**\r
	150	Writes memory-mapped registers in the EFI system memory space.\r
	151	\r
	152	Writes the MMIO registers specified by Address with registers width and value specified by Width\r
	153	and Data respectively. Data is returned. If such operations are not supported, then ASSERT().\r
	154	This function must guarantee that all MMIO read and write operations are serialized.\r
	155	\r
	156	@param Address The MMIO register to read.\r
	157	The caller is responsible for aligning the Address if required.\r
	158	@param Width The width of the I/O operation.\r
	159	@param Data The value to write to the I/O port.\r
9095d37b	160	\r
ba9f8351	161	@return Data read from registers in the EFI system memory space.\r
	162	\r
	163	**/\r
	164	UINT64\r
	165	EFIAPI\r
	166	MmioWriteWorker (\r
	167	IN UINTN Address,\r
	168	IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
	169	IN UINT64 Data\r
	170	);\r
	171	\r
	172	#endif\r