MdePkg/Include/Library/CacheMaintenanceLib.h File Reference


Functions

VOID EFIAPI InvalidateInstructionCache (VOID)
VOID *EFIAPI InvalidateInstructionCacheRange (IN VOID *Address, IN UINTN Length)
VOID EFIAPI WriteBackInvalidateDataCache (VOID)
VOID *EFIAPI WriteBackInvalidateDataCacheRange (IN VOID *Address, IN UINTN Length)
VOID EFIAPI WriteBackDataCache (VOID)
VOID *EFIAPI WriteBackDataCacheRange (IN VOID *Address, IN UINTN Length)
VOID EFIAPI InvalidateDataCache (VOID)
VOID *EFIAPI InvalidateDataCacheRange (IN VOID *Address, IN UINTN Length)

Detailed Description

Provides services to maintain instruction and data caches.

The Cache Maintenance Library provides abstractions for basic processor cache operations. It removes the need to use assembly in C code.

Copyright (c) 2006 - 2008, Intel Corporation. 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.


Function Documentation

VOID EFIAPI InvalidateDataCache ( VOID   ) 

Invalidates the entire data cache in cache coherency domain of the calling CPU.

Invalidates the entire data cache in cache coherency domain of the calling CPU. This function must be used with care because dirty cache lines are not written back to system memory. It is typically used for cache diagnostics. If the CPU does not support invalidation of the entire data cache, then a write back and invalidate operation should be performed on the entire data cache.

References AsmInvd(), ASSERT, FALSE, and WriteBackInvalidateDataCache().

VOID* EFIAPI InvalidateDataCacheRange ( IN VOID *  Address,
IN UINTN  Length 
)

Invalidates a range of data cache lines in the cache coherency domain of the calling CPU.

Invalidates the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is invalidated. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is invalidated. This function must never invalidate any cache lines outside the specified range. If Length is 0, the no data cache lines are invalidated. Address is returned. This function must be used with care because dirty cache lines are not written back to system memory. It is typically used for cache diagnostics. If the CPU does not support invalidation of a data cache range, then a write back and invalidate operation should be performed on the data cache range.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to invalidate from the data cache.
Returns:
Address.
Invalidates a range of data cache lines in the cache coherency domain of the calling CPU.

Invalidates the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is invalidated. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is invalidated. This function must never invalidate any cache lines outside the specified range. If Length is 0, then no data cache lines are invalidated. Address is returned. This function must be used with care because dirty cache lines are not written back to system memory. It is typically used for cache diagnostics. If the CPU does not support invalidation of a data cache range, then a write back and invalidate operation should be performed on the data cache range.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to invalidate from the data cache.
Returns:
Address.
Invalidates a range of data cache lines in the cache coherency domain of the calling CPU.

Invalidates the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is invalidated. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is invalidated. This function must never invalidate any cache lines outside the specified range. If Length is 0, then no data cache lines are invalidated. Address is returned. This function must be used with care because dirty cache lines are not written back to system memory. It is typically used for cache diagnostics. If the CPU does not support invalidation of a data cache range, then a write back and invalidate operation should be performed on the data cache range.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to invalidate from the data cache.
Returns:
Address

References AsmFlushCacheRange(), ASSERT, FALSE, MAX_ADDRESS, and WriteBackInvalidateDataCacheRange().

VOID EFIAPI InvalidateInstructionCache ( VOID   ) 

Invalidates the entire instruction cache in cache coherency domain of the calling CPU.

Invalidates the entire instruction cache in cache coherency domain of the calling CPU.

Invalidates the entire instruction cache in cache coherency domain of the calling CPU.

References ASSERT, FALSE, PAL_CACHE_FLUSH, PAL_CACHE_FLUSH_INSTRUCTION_ALL, PAL_CACHE_FLUSH_INVALIDATE_LINES, PAL_CACHE_FLUSH_NO_INTERRUPT, and PalCall().

VOID* EFIAPI InvalidateInstructionCacheRange ( IN VOID *  Address,
IN UINTN  Length 
)

Invalidates a range of instruction cache lines in the cache coherency domain of the calling CPU.

Invalidates the instruction cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire instruction cache line containing Address is invalidated. If Address + Length is not aligned on a cache line boundary, then the entire instruction cache line containing Address + Length -1 is invalidated. This function may choose to invalidate the entire instruction cache if that is more efficient than invalidating the specified range. If Length is 0, then no instruction cache lines are invalidated. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the instruction cache lines to invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to invalidate from the instruction cache.
Returns:
Address.
Invalidates a range of instruction cache lines in the cache coherency domain of the calling CPU.

Invalidates the instruction cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire instruction cache line containing Address is invalidated. If Address + Length is not aligned on a cache line boundary, then the entire instruction cache line containing Address + Length -1 is invalidated. This function may choose to invalidate the entire instruction cache if that is more efficient than invalidating the specified range. If Length is 0, then no instruction cache lines are invalidated. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the instruction cache lines to invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to invalidate from the instruction cache.
Returns:
Address

References AsmFlushCacheRange(), ASSERT, FALSE, and MAX_ADDRESS.

VOID EFIAPI WriteBackDataCache ( VOID   ) 

Writes Back the entire data cache in cache coherency domain of the calling CPU.

Writes Back the entire data cache in cache coherency domain of the calling CPU. This function guarantees that all dirty cache lines are written back to system memory. This function may also invalidate all the data cache lines in the cache coherency domain of the calling CPU.

Writes back the entire data cache in cache coherency domain of the calling CPU.

Writes back the entire data cache in cache coherency domain of the calling CPU. This function guarantees that all dirty cache lines are written back to system memory. This function may also invalidate all the data cache lines in the cache coherency domain of the calling CPU.

References ASSERT, FALSE, PAL_CACHE_FLUSH, PAL_CACHE_FLUSH_DATA_ALL, PAL_CACHE_FLUSH_NO_INTERRUPT, PAL_CACHE_FLUSH_NO_INVALIDATE_LINES, PalCall(), and WriteBackInvalidateDataCache().

VOID* EFIAPI WriteBackDataCacheRange ( IN VOID *  Address,
IN UINTN  Length 
)

Writes Back a range of data cache lines in the cache coherency domain of the calling CPU.

Writes Back the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is written back. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is written back. This function may choose to write back the entire data cache if that is more efficient than writing back the specified range. If Length is 0, then no data cache lines are written back. This function may also invalidate all the data cache lines in the specified range of the cache coherency domain of the calling CPU. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to write back. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to write back from the data cache.
Returns:
Address of cache written in main memory.
Writes back a range of data cache lines in the cache coherency domain of the calling CPU.

Writes back the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is written back. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is written back. This function may choose to write back the entire data cache if that is more efficient than writing back the specified range. If Length is 0, then no data cache lines are written back. This function may also invalidate all the data cache lines in the specified range of the cache coherency domain of the calling CPU. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to write back. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to write back from the data cache.
Returns:
Address of cache written in main memory.
Writes back a range of data cache lines in the cache coherency domain of the calling CPU.

Writes back the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is written back. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is written back. This function may choose to write back the entire data cache if that is more efficient than writing back the specified range. If Length is 0, then no data cache lines are written back. This function may also invalidate all the data cache lines in the specified range of the cache coherency domain of the calling CPU. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to write back. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to write back from the data cache.
Returns:
Address

References AsmFlushCacheRange(), ASSERT, FALSE, MAX_ADDRESS, and WriteBackInvalidateDataCacheRange().

VOID EFIAPI WriteBackInvalidateDataCache ( VOID   ) 

Writes Back and Invalidates the entire data cache in cache coherency domain of the calling CPU.

Writes Back and Invalidates the entire data cache in cache coherency domain of the calling CPU. This function guarantees that all dirty cache lines are written back to system memory, and also invalidates all the data cache lines in the cache coherency domain of the calling CPU.

Writes back and invalidates the entire data cache in cache coherency domain of the calling CPU.

Writes back and invalidates the entire data cache in cache coherency domain of the calling CPU. This function guarantees that all dirty cache lines are written back to system memory, and also invalidates all the data cache lines in the cache coherency domain of the calling CPU.

Writes back and invalidates the entire data cache in cache coherency domain of the calling CPU.

Writes Back and Invalidates the entire data cache in cache coherency domain of the calling CPU. This function guarantees that all dirty cache lines are written back to system memory, and also invalidates all the data cache lines in the cache coherency domain of the calling CPU.

References AsmWbinvd(), ASSERT, FALSE, PAL_CACHE_FLUSH, PAL_CACHE_FLUSH_DATA_ALL, PAL_CACHE_FLUSH_INVALIDATE_LINES, PAL_CACHE_FLUSH_NO_INTERRUPT, and PalCall().

Referenced by InvalidateDataCache(), and WriteBackDataCache().

VOID* EFIAPI WriteBackInvalidateDataCacheRange ( IN VOID *  Address,
IN UINTN  Length 
)

Writes Back and Invalidates a range of data cache lines in the cache coherency domain of the calling CPU.

Writes Back and Invalidate the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is written back and invalidated. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is written back and invalidated. This function may choose to write back and invalidate the entire data cache if that is more efficient than writing back and invalidating the specified range. If Length is 0, then no data cache lines are written back and invalidated. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to write back and invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to write back and invalidate from the data cache.
Returns:
Address of cache invalidation.
Writes back and invalidates a range of data cache lines in the cache coherency domain of the calling CPU.

Writes back and invalidates the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is written back and invalidated. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is written back and invalidated. This function may choose to write back and invalidate the entire data cache if that is more efficient than writing back and invalidating the specified range. If Length is 0, then no data cache lines are written back and invalidated. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to write back and invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to write back and invalidate from the data cache.
Returns:
Address of cache invalidation.
Writes back and invalidates a range of data cache lines in the cache coherency domain of the calling CPU.

Writes Back and Invalidate the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is written back and invalidated. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is written back and invalidated. This function may choose to write back and invalidate the entire data cache if that is more efficient than writing back and invalidating the specified range. If Length is 0, then no data cache lines are written back and invalidated. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to write back and invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to write back and invalidate from the data cache.
Returns:
Address of cache invalidation.
Writes back and invalidates a range of data cache lines in the cache coherency domain of the calling CPU.

Writes back and invalidates the data cache lines specified by Address and Length. If Address is not aligned on a cache line boundary, then entire data cache line containing Address is written back and invalidated. If Address + Length is not aligned on a cache line boundary, then the entire data cache line containing Address + Length -1 is written back and invalidated. This function may choose to write back and invalidate the entire data cache if that is more efficient than writing back and invalidating the specified range. If Length is 0, then no data cache lines are written back and invalidated. Address is returned.

If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().

Parameters:
Address The base address of the data cache lines to write back and invalidate. If the CPU is in a physical addressing mode, then Address is a physical address. If the CPU is in a virtual addressing mode, then Address is a virtual address.
Length The number of bytes to write back and invalidate from the data cache.
Returns:
Address

References AsmCpuid(), AsmFlushCacheLine(), AsmFlushCacheRange(), AsmWbinvd(), ASSERT, BIT19, FALSE, MAX_ADDRESS, NULL, and VOID.

Referenced by InvalidateDataCacheRange(), and WriteBackDataCacheRange().


Generated on Thu Sep 24 23:14:16 2015 for MdePkg[ALL] by  doxygen 1.5.7.1