CpuIoPei.c File Reference

#include "CpuIoPei.h"

Go to the source code of this file.

Functions
EFI_STATUS	CpuIoCheckParameter (IN BOOLEAN MmioOperation, IN EFI_PEI_CPU_IO_PPI_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN VOID *Buffer)
EFI_STATUS EFIAPI	CpuMemoryServiceRead (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN EFI_PEI_CPU_IO_PPI_WIDTH Width, IN UINT64 Address, IN UINTN Count, OUT VOID *Buffer)
EFI_STATUS EFIAPI	CpuMemoryServiceWrite (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN EFI_PEI_CPU_IO_PPI_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN VOID *Buffer)
EFI_STATUS EFIAPI	CpuIoServiceRead (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN EFI_PEI_CPU_IO_PPI_WIDTH Width, IN UINT64 Address, IN UINTN Count, OUT VOID *Buffer)
EFI_STATUS EFIAPI	CpuIoServiceWrite (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN EFI_PEI_CPU_IO_PPI_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN VOID *Buffer)
UINT8 EFIAPI	CpuIoRead8 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
UINT16 EFIAPI	CpuIoRead16 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
UINT32 EFIAPI	CpuIoRead32 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
UINT64 EFIAPI	CpuIoRead64 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
VOID EFIAPI	CpuIoWrite8 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT8 Data)
VOID EFIAPI	CpuIoWrite16 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT16 Data)
VOID EFIAPI	CpuIoWrite32 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT32 Data)
VOID EFIAPI	CpuIoWrite64 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT64 Data)
UINT8 EFIAPI	CpuMemRead8 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
UINT16 EFIAPI	CpuMemRead16 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
UINT32 EFIAPI	CpuMemRead32 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
UINT64 EFIAPI	CpuMemRead64 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address)
VOID EFIAPI	CpuMemWrite8 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT8 Data)
VOID EFIAPI	CpuMemWrite16 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT16 Data)
VOID EFIAPI	CpuMemWrite32 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT32 Data)
VOID EFIAPI	CpuMemWrite64 (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_CPU_IO_PPI *This, IN UINT64 Address, IN UINT64 Data)
EFI_STATUS EFIAPI	CpuIoInitialize (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

Variables
EFI_PEI_CPU_IO_PPI	gCpuIoPpi
EFI_PEI_PPI_DESCRIPTOR	gPpiList
UINT8	mInStride []
UINT8	mOutStride []

Detailed Description

Produces the CPU I/O PPI.

Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
Copyright (c) 2017, AMD Incorporated. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CpuIoPei.c.

Function Documentation

CpuIoCheckParameter()

EFI_STATUS CpuIoCheckParameter	(	IN BOOLEAN	MmioOperation,
		IN EFI_PEI_CPU_IO_PPI_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Check parameters to a CPU I/O PPI service request.

Parameters

[in]	MmioOperation	TRUE for an MMIO operation, FALSE for I/O Port operation.
[in]	Width	The width of the access. Enumerated in bytes.
[in]	Address	The physical address of the access.
[in]	Count	The number of accesses to perform.
[in]	Buffer	A pointer to the buffer of data.

Return values

EFI_SUCCESS	The parameters for this request pass the checks.
EFI_INVALID_PARAMETER	Width is invalid for this EFI system.
EFI_INVALID_PARAMETER	Buffer is NULL.
EFI_UNSUPPORTED	The address range specified by Address, Width, and Count is not valid for this EFI system.

Definition at line 105 of file CpuIoPei.c.

CpuIoInitialize()

EFI_STATUS EFIAPI CpuIoInitialize	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

The Entry point of the CPU I/O PEIM

This function is the Entry point of the CPU I/O PEIM which installs CpuIoPpi.

Parameters

[in]	FileHandle	Pointer to image file handle.
[in]	PeiServices	Pointer to PEI Services Table

Return values

EFI_SUCCESS

CPU I/O PPI successfully installed

Definition at line 885 of file CpuIoPei.c.

CpuIoRead16()

UINT16 EFIAPI CpuIoRead16	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

16-bit I/O read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

A 16-bit value returned from the I/O space.

Definition at line 555 of file CpuIoPei.c.

CpuIoRead32()

UINT32 EFIAPI CpuIoRead32	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

32-bit I/O read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

A 32-bit value returned from the I/O space.

Definition at line 577 of file CpuIoPei.c.

CpuIoRead64()

UINT64 EFIAPI CpuIoRead64	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

64-bit I/O read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

A 64-bit value returned from the I/O space.

Definition at line 599 of file CpuIoPei.c.

CpuIoRead8()

UINT8 EFIAPI CpuIoRead8	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

8-bit I/O read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

An 8-bit value returned from the I/O space.

Definition at line 533 of file CpuIoPei.c.

CpuIoServiceRead()

EFI_STATUS EFIAPI CpuIoServiceRead	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN EFI_PEI_CPU_IO_PPI_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		OUT VOID *	Buffer
	)

Reads I/O registers.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Width	The width of the access. Enumerated in bytes.
[in]	Address	The physical address of the access.
[in]	Count	The number of accesses to perform.
[out]	Buffer	A pointer to the buffer of data.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Width is invalid for this EFI system.
EFI_INVALID_PARAMETER	Buffer is NULL.
EFI_UNSUPPORTED	The address range specified by Address, Width, and Count is not valid for this EFI system.

Definition at line 350 of file CpuIoPei.c.

CpuIoServiceWrite()

EFI_STATUS EFIAPI CpuIoServiceWrite	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN EFI_PEI_CPU_IO_PPI_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Write I/O registers.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Width	The width of the access. Enumerated in bytes.
[in]	Address	The physical address of the access.
[in]	Count	The number of accesses to perform.
[in]	Buffer	A pointer to the buffer of data.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Width is invalid for this EFI system.
EFI_INVALID_PARAMETER	Buffer is NULL.
EFI_UNSUPPORTED	The address range specified by Address, Width, and Count is not valid for this EFI system.

Definition at line 444 of file CpuIoPei.c.

CpuIoWrite16()

VOID EFIAPI CpuIoWrite16	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT16	Data
	)

16-bit I/O write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 642 of file CpuIoPei.c.

CpuIoWrite32()

VOID EFIAPI CpuIoWrite32	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT32	Data
	)

32-bit I/O write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 664 of file CpuIoPei.c.

CpuIoWrite64()

VOID EFIAPI CpuIoWrite64	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT64	Data
	)

64-bit I/O write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 686 of file CpuIoPei.c.

CpuIoWrite8()

VOID EFIAPI CpuIoWrite8	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT8	Data
	)

8-bit I/O write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 620 of file CpuIoPei.c.

CpuMemoryServiceRead()

EFI_STATUS EFIAPI CpuMemoryServiceRead	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN EFI_PEI_CPU_IO_PPI_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		OUT VOID *	Buffer
	)

Reads memory-mapped registers.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Width	The width of the access. Enumerated in bytes.
[in]	Address	The physical address of the access.
[in]	Count	The number of accesses to perform.
[out]	Buffer	A pointer to the buffer of data.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Width is invalid for this EFI system.
EFI_INVALID_PARAMETER	Buffer is NULL.
EFI_UNSUPPORTED	The address range specified by Address, Width, and Count is not valid for this EFI system.

Definition at line 200 of file CpuIoPei.c.

CpuMemoryServiceWrite()

EFI_STATUS EFIAPI CpuMemoryServiceWrite	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN EFI_PEI_CPU_IO_PPI_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Writes memory-mapped registers.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Width	The width of the access. Enumerated in bytes.
[in]	Address	The physical address of the access.
[in]	Count	The number of accesses to perform.
[in]	Buffer	A pointer to the buffer of data.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Width is invalid for this EFI system.
EFI_INVALID_PARAMETER	Buffer is NULL.
EFI_UNSUPPORTED	The address range specified by Address, Width, and Count is not valid for this EFI system.

Definition at line 275 of file CpuIoPei.c.

CpuMemRead16()

UINT16 EFIAPI CpuMemRead16	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

16-bit memory read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

A 16-bit value returned from the memory space.

Definition at line 731 of file CpuIoPei.c.

CpuMemRead32()

UINT32 EFIAPI CpuMemRead32	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

32-bit memory read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

A 32-bit value returned from the memory space.

Definition at line 753 of file CpuIoPei.c.

CpuMemRead64()

UINT64 EFIAPI CpuMemRead64	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

64-bit memory read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

A 64-bit value returned from the memory space.

Definition at line 775 of file CpuIoPei.c.

CpuMemRead8()

UINT8 EFIAPI CpuMemRead8	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address
	)

8-bit memory read operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.

Returns

An 8-bit value returned from the memory space.

Definition at line 709 of file CpuIoPei.c.

CpuMemWrite16()

VOID EFIAPI CpuMemWrite16	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT16	Data
	)

16-bit memory write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 818 of file CpuIoPei.c.

CpuMemWrite32()

VOID EFIAPI CpuMemWrite32	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT32	Data
	)

32-bit memory write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 840 of file CpuIoPei.c.

CpuMemWrite64()

VOID EFIAPI CpuMemWrite64	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT64	Data
	)

64-bit memory write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 862 of file CpuIoPei.c.

CpuMemWrite8()

VOID EFIAPI CpuMemWrite8	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_CPU_IO_PPI *	This,
		IN UINT64	Address,
		IN UINT8	Data
	)

8-bit memory write operations.

Parameters

[in]	PeiServices	An indirect pointer to the PEI Services Table published by the PEI Foundation.
[in]	This	Pointer to local data for the interface.
[in]	Address	The physical address of the access.
[in]	Data	The data to write.

Definition at line 796 of file CpuIoPei.c.

Variable Documentation

gCpuIoPpi

EFI_PEI_CPU_IO_PPI gCpuIoPpi

Initial value:

= {
  {
    CpuMemoryServiceRead,
    CpuMemoryServiceWrite
  },
  {
    CpuIoServiceRead,
    CpuIoServiceWrite
  },
  CpuIoRead8,
  CpuIoRead16,
  CpuIoRead32,
  CpuIoRead64,
  CpuIoWrite8,
  CpuIoWrite16,
  CpuIoWrite32,
  CpuIoWrite64,
  CpuMemRead8,
  CpuMemRead16,
  CpuMemRead32,
  CpuMemRead64,
  CpuMemWrite8,
  CpuMemWrite16,
  CpuMemWrite32,
  CpuMemWrite64
}

Definition at line 16 of file CpuIoPei.c.

gPpiList

EFI_PEI_PPI_DESCRIPTOR gPpiList

Initial value:

= {
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
  &gEfiPeiCpuIoPpiInstalledGuid,
  NULL
}

Definition at line 46 of file CpuIoPei.c.

mInStride

UINT8 mInStride[]

Initial value:

= {
  1, 
  2, 
  4, 
  8, 
  0, 
  0, 
  0, 
  0, 
  1, 
  2, 
  4, 
  8  
}

Definition at line 55 of file CpuIoPei.c.

mOutStride

UINT8 mOutStride[]

Initial value:

= {
  1, 
  2, 
  4, 
  8, 
  1, 
  2, 
  4, 
  8, 
  0, 
  0, 
  0, 
  0  
}

Definition at line 73 of file CpuIoPei.c.