#ifndef CYGONCE_HAL_CACHE_H
|
#ifndef CYGONCE_HAL_CACHE_H
|
#define CYGONCE_HAL_CACHE_H
|
#define CYGONCE_HAL_CACHE_H
|
|
|
//=============================================================================
|
//=============================================================================
|
//
|
//
|
// hal_cache.h
|
// hal_cache.h
|
//
|
//
|
// HAL cache control API
|
// HAL cache control API
|
//
|
//
|
//=============================================================================
|
//=============================================================================
|
//####ECOSGPLCOPYRIGHTBEGIN####
|
//####ECOSGPLCOPYRIGHTBEGIN####
|
// -------------------------------------------
|
// -------------------------------------------
|
// This file is part of eCos, the Embedded Configurable Operating System.
|
// This file is part of eCos, the Embedded Configurable Operating System.
|
// Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
|
// Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
|
//
|
//
|
// eCos is free software; you can redistribute it and/or modify it under
|
// eCos is free software; you can redistribute it and/or modify it under
|
// the terms of the GNU General Public License as published by the Free
|
// the terms of the GNU General Public License as published by the Free
|
// Software Foundation; either version 2 or (at your option) any later version.
|
// Software Foundation; either version 2 or (at your option) any later version.
|
//
|
//
|
// eCos is distributed in the hope that it will be useful, but WITHOUT ANY
|
// eCos is distributed in the hope that it will be useful, but WITHOUT ANY
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// for more details.
|
// for more details.
|
//
|
//
|
// You should have received a copy of the GNU General Public License along
|
// You should have received a copy of the GNU General Public License along
|
// with eCos; if not, write to the Free Software Foundation, Inc.,
|
// with eCos; if not, write to the Free Software Foundation, Inc.,
|
// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
|
// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
|
//
|
//
|
// As a special exception, if other files instantiate templates or use macros
|
// As a special exception, if other files instantiate templates or use macros
|
// or inline functions from this file, or you compile this file and link it
|
// or inline functions from this file, or you compile this file and link it
|
// with other works to produce a work based on this file, this file does not
|
// with other works to produce a work based on this file, this file does not
|
// by itself cause the resulting work to be covered by the GNU General Public
|
// by itself cause the resulting work to be covered by the GNU General Public
|
// License. However the source code for this file must still be made available
|
// License. However the source code for this file must still be made available
|
// in accordance with section (3) of the GNU General Public License.
|
// in accordance with section (3) of the GNU General Public License.
|
//
|
//
|
// This exception does not invalidate any other reasons why a work based on
|
// This exception does not invalidate any other reasons why a work based on
|
// this file might be covered by the GNU General Public License.
|
// this file might be covered by the GNU General Public License.
|
//
|
//
|
// Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
|
// Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
|
// at http://sources.redhat.com/ecos/ecos-license/
|
// at http://sources.redhat.com/ecos/ecos-license/
|
// -------------------------------------------
|
// -------------------------------------------
|
//####ECOSGPLCOPYRIGHTEND####
|
//####ECOSGPLCOPYRIGHTEND####
|
//=============================================================================
|
//=============================================================================
|
//#####DESCRIPTIONBEGIN####
|
//#####DESCRIPTIONBEGIN####
|
//
|
//
|
// Author(s): nickg, gthomas
|
// Author(s): nickg, gthomas
|
// Contributors: nickg, gthomas
|
// Contributors: nickg, gthomas
|
// Date: 1998-09-28
|
// Date: 1998-09-28
|
// Purpose: Cache control API
|
// Purpose: Cache control API
|
// Description: The macros defined here provide the HAL APIs for handling
|
// Description: The macros defined here provide the HAL APIs for handling
|
// cache control operations.
|
// cache control operations.
|
// Usage:
|
// Usage:
|
// #include <cyg/hal/hal_cache.h>
|
// #include <cyg/hal/hal_cache.h>
|
// ...
|
// ...
|
//
|
//
|
//
|
//
|
//####DESCRIPTIONEND####
|
//####DESCRIPTIONEND####
|
//
|
//
|
//=============================================================================
|
//=============================================================================
|
|
|
#include <cyg/infra/cyg_type.h>
|
#include <cyg/infra/cyg_type.h>
|
|
|
//-----------------------------------------------------------------------------
|
//-----------------------------------------------------------------------------
|
// Cache dimensions
|
// Cache dimensions
|
|
|
// Data cache
|
// Data cache
|
//#define HAL_DCACHE_SIZE 0 // Size of data cache in bytes
|
//#define HAL_DCACHE_SIZE 0 // Size of data cache in bytes
|
//#define HAL_DCACHE_LINE_SIZE 0 // Size of a data cache line
|
//#define HAL_DCACHE_LINE_SIZE 0 // Size of a data cache line
|
//#define HAL_DCACHE_WAYS 0 // Associativity of the cache
|
//#define HAL_DCACHE_WAYS 0 // Associativity of the cache
|
|
|
// Instruction cache
|
// Instruction cache
|
//#define HAL_ICACHE_SIZE 0 // Size of cache in bytes
|
//#define HAL_ICACHE_SIZE 0 // Size of cache in bytes
|
//#define HAL_ICACHE_LINE_SIZE 0 // Size of a cache line
|
//#define HAL_ICACHE_LINE_SIZE 0 // Size of a cache line
|
//#define HAL_ICACHE_WAYS 0 // Associativity of the cache
|
//#define HAL_ICACHE_WAYS 0 // Associativity of the cache
|
|
|
//#define HAL_DCACHE_SETS (HAL_DCACHE_SIZE/(HAL_DCACHE_LINE_SIZE*HAL_DCACHE_WAYS))
|
//#define HAL_DCACHE_SETS (HAL_DCACHE_SIZE/(HAL_DCACHE_LINE_SIZE*HAL_DCACHE_WAYS))
|
//#define HAL_ICACHE_SETS (HAL_ICACHE_SIZE/(HAL_ICACHE_LINE_SIZE*HAL_ICACHE_WAYS))
|
//#define HAL_ICACHE_SETS (HAL_ICACHE_SIZE/(HAL_ICACHE_LINE_SIZE*HAL_ICACHE_WAYS))
|
|
|
//-----------------------------------------------------------------------------
|
//-----------------------------------------------------------------------------
|
// Global control of data cache
|
// Global control of data cache
|
|
|
// Enable the data cache
|
// Enable the data cache
|
#define HAL_DCACHE_ENABLE()
|
#define HAL_DCACHE_ENABLE()
|
|
|
// Disable the data cache
|
// Disable the data cache
|
#define HAL_DCACHE_DISABLE()
|
#define HAL_DCACHE_DISABLE()
|
|
|
// Invalidate the entire cache
|
// Invalidate the entire cache
|
#define HAL_DCACHE_INVALIDATE_ALL()
|
#define HAL_DCACHE_INVALIDATE_ALL()
|
|
|
// Synchronize the contents of the cache with memory.
|
// Synchronize the contents of the cache with memory.
|
#define HAL_DCACHE_SYNC()
|
#define HAL_DCACHE_SYNC()
|
|
|
// Purge contents of data cache
|
// Purge contents of data cache
|
#define HAL_DCACHE_PURGE_ALL()
|
#define HAL_DCACHE_PURGE_ALL()
|
|
|
// Query the state of the data cache (does not affect the caching)
|
// Query the state of the data cache (does not affect the caching)
|
#define HAL_DCACHE_IS_ENABLED(_state_) \
|
#define HAL_DCACHE_IS_ENABLED(_state_) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
(_state_) = 0; \
|
(_state_) = 0; \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
// Set the data cache refill burst size
|
// Set the data cache refill burst size
|
//#define HAL_DCACHE_BURST_SIZE(_size_)
|
//#define HAL_DCACHE_BURST_SIZE(_size_)
|
|
|
// Set the data cache write mode
|
// Set the data cache write mode
|
//#define HAL_DCACHE_WRITE_MODE( _mode_ )
|
//#define HAL_DCACHE_WRITE_MODE( _mode_ )
|
|
|
//#define HAL_DCACHE_WRITETHRU_MODE 0
|
//#define HAL_DCACHE_WRITETHRU_MODE 0
|
//#define HAL_DCACHE_WRITEBACK_MODE 1
|
//#define HAL_DCACHE_WRITEBACK_MODE 1
|
|
|
// Load the contents of the given address range into the data cache
|
// Load the contents of the given address range into the data cache
|
// and then lock the cache so that it stays there.
|
// and then lock the cache so that it stays there.
|
//#define HAL_DCACHE_LOCK(_base_, _size_)
|
//#define HAL_DCACHE_LOCK(_base_, _size_)
|
|
|
// Undo a previous lock operation
|
// Undo a previous lock operation
|
//#define HAL_DCACHE_UNLOCK(_base_, _size_)
|
//#define HAL_DCACHE_UNLOCK(_base_, _size_)
|
|
|
// Unlock entire cache
|
// Unlock entire cache
|
//#define HAL_DCACHE_UNLOCK_ALL()
|
//#define HAL_DCACHE_UNLOCK_ALL()
|
|
|
//-----------------------------------------------------------------------------
|
//-----------------------------------------------------------------------------
|
// Data cache line control
|
// Data cache line control
|
|
|
// Allocate cache lines for the given address range without reading its
|
// Allocate cache lines for the given address range without reading its
|
// contents from memory.
|
// contents from memory.
|
//#define HAL_DCACHE_ALLOCATE( _base_ , _size_ )
|
//#define HAL_DCACHE_ALLOCATE( _base_ , _size_ )
|
|
|
// Write dirty cache lines to memory and invalidate the cache entries
|
// Write dirty cache lines to memory and invalidate the cache entries
|
// for the given address range.
|
// for the given address range.
|
//#define HAL_DCACHE_FLUSH( _base_ , _size_ )
|
//#define HAL_DCACHE_FLUSH( _base_ , _size_ )
|
|
|
// Invalidate cache lines in the given range without writing to memory.
|
// Invalidate cache lines in the given range without writing to memory.
|
//#define HAL_DCACHE_INVALIDATE( _base_ , _size_ )
|
//#define HAL_DCACHE_INVALIDATE( _base_ , _size_ )
|
|
|
// Write dirty cache lines to memory for the given address range.
|
// Write dirty cache lines to memory for the given address range.
|
//#define HAL_DCACHE_STORE( _base_ , _size_ )
|
//#define HAL_DCACHE_STORE( _base_ , _size_ )
|
|
|
// Preread the given range into the cache with the intention of reading
|
// Preread the given range into the cache with the intention of reading
|
// from it later.
|
// from it later.
|
//#define HAL_DCACHE_READ_HINT( _base_ , _size_ )
|
//#define HAL_DCACHE_READ_HINT( _base_ , _size_ )
|
|
|
// Preread the given range into the cache with the intention of writing
|
// Preread the given range into the cache with the intention of writing
|
// to it later.
|
// to it later.
|
//#define HAL_DCACHE_WRITE_HINT( _base_ , _size_ )
|
//#define HAL_DCACHE_WRITE_HINT( _base_ , _size_ )
|
|
|
// Allocate and zero the cache lines associated with the given range.
|
// Allocate and zero the cache lines associated with the given range.
|
//#define HAL_DCACHE_ZERO( _base_ , _size_ )
|
//#define HAL_DCACHE_ZERO( _base_ , _size_ )
|
|
|
//-----------------------------------------------------------------------------
|
//-----------------------------------------------------------------------------
|
// Global control of Instruction cache
|
// Global control of Instruction cache
|
|
|
// Enable the instruction cache
|
// Enable the instruction cache
|
#define HAL_ICACHE_ENABLE()
|
#define HAL_ICACHE_ENABLE()
|
|
|
// Disable the instruction cache
|
// Disable the instruction cache
|
#define HAL_ICACHE_DISABLE()
|
#define HAL_ICACHE_DISABLE()
|
|
|
// Invalidate the entire cache
|
// Invalidate the entire cache
|
#define HAL_ICACHE_INVALIDATE_ALL()
|
#define HAL_ICACHE_INVALIDATE_ALL()
|
|
|
// Synchronize the contents of the cache with memory.
|
// Synchronize the contents of the cache with memory.
|
#define HAL_ICACHE_SYNC()
|
#define HAL_ICACHE_SYNC()
|
|
|
// Query the state of the instruction cache (does not affect the caching)
|
// Query the state of the instruction cache (does not affect the caching)
|
#define HAL_ICACHE_IS_ENABLED(_state_) \
|
#define HAL_ICACHE_IS_ENABLED(_state_) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
(_state_) = 0; \
|
(_state_) = 0; \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
// Set the instruction cache refill burst size
|
// Set the instruction cache refill burst size
|
//#define HAL_ICACHE_BURST_SIZE(_size_)
|
//#define HAL_ICACHE_BURST_SIZE(_size_)
|
|
|
// Load the contents of the given address range into the instruction cache
|
// Load the contents of the given address range into the instruction cache
|
// and then lock the cache so that it stays there.
|
// and then lock the cache so that it stays there.
|
//#define HAL_ICACHE_LOCK(_base_, _size_)
|
//#define HAL_ICACHE_LOCK(_base_, _size_)
|
|
|
// Undo a previous lock operation
|
// Undo a previous lock operation
|
//#define HAL_ICACHE_UNLOCK(_base_, _size_)
|
//#define HAL_ICACHE_UNLOCK(_base_, _size_)
|
|
|
// Unlock entire cache
|
// Unlock entire cache
|
//#define HAL_ICACHE_UNLOCK_ALL()
|
//#define HAL_ICACHE_UNLOCK_ALL()
|
|
|
//-----------------------------------------------------------------------------
|
//-----------------------------------------------------------------------------
|
// Instruction cache line control
|
// Instruction cache line control
|
|
|
// Invalidate cache lines in the given range without writing to memory.
|
// Invalidate cache lines in the given range without writing to memory.
|
//#define HAL_ICACHE_INVALIDATE( _base_ , _size_ )
|
//#define HAL_ICACHE_INVALIDATE( _base_ , _size_ )
|
|
|
//-----------------------------------------------------------------------------
|
//-----------------------------------------------------------------------------
|
#endif // ifndef CYGONCE_HAL_CACHE_H
|
#endif // ifndef CYGONCE_HAL_CACHE_H
|
// End of hal_cache.h
|
// End of hal_cache.h
|
|
|
