diff packages/hal/arm/ebsa285/current/include/hal_cache.h @ 76:435cced73e2f ecos-v1_3_1-release

eCos v1.3.1 merged from eCos master repository on 2000-03-27-23:22:51-BST
author jlarmour
date Tue, 28 Mar 2000 14:10:45 +0000
parents
children 6b5f480c6929
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/packages/hal/arm/ebsa285/current/include/hal_cache.h
@@ -0,0 +1,349 @@
+#ifndef CYGONCE_HAL_CACHE_H
+#define CYGONCE_HAL_CACHE_H
+
+//=============================================================================
+//
+//      hal_cache.h
+//
+//      HAL cache control API
+//
+//=============================================================================
+//####COPYRIGHTBEGIN####
+//                                                                          
+// -------------------------------------------                              
+// The contents of this file are subject to the Red Hat eCos Public License 
+// Version 1.1 (the "License"); you may not use this file except in         
+// compliance with the License.  You may obtain a copy of the License at    
+// http://www.redhat.com/                                                   
+//                                                                          
+// Software distributed under the License is distributed on an "AS IS"      
+// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.  See the 
+// License for the specific language governing rights and limitations under 
+// the License.                                                             
+//                                                                          
+// The Original Code is eCos - Embedded Configurable Operating System,      
+// released September 30, 1998.                                             
+//                                                                          
+// The Initial Developer of the Original Code is Red Hat.                   
+// Portions created by Red Hat are                                          
+// Copyright (C) 1998, 1999, 2000 Red Hat, Inc.                             
+// All Rights Reserved.                                                     
+// -------------------------------------------                              
+//                                                                          
+//####COPYRIGHTEND####
+//=============================================================================
+//#####DESCRIPTIONBEGIN####
+//
+// Author(s):   hmt
+// Contributors:hmt
+// Date:        1999-07-05
+// Purpose:     Cache control API
+// Description: The macros defined here provide the HAL APIs for handling
+//              cache control operations.
+// Usage:
+//              #include <cyg/hal/hal_cache.h>
+//              ...
+//              
+//
+//####DESCRIPTIONEND####
+//
+//=============================================================================
+
+#include <cyg/infra/cyg_type.h>
+//#include <cyg/hal/hal_mmu.h>
+
+//-----------------------------------------------------------------------------
+// Cache dimensions
+
+#define HAL_DCACHE_SIZE                 0x4000 // Size of data cache in bytes
+#define HAL_DCACHE_LINE_SIZE            32     // Size of a data cache line
+#define HAL_DCACHE_WAYS                 32     // Associativity of the cache
+#define HAL_DCACHE_SETS (HAL_UCACHE_SIZE/(HAL_UCACHE_LINE_SIZE*HAL_UCACHE_WAYS))
+
+#define HAL_ICACHE_SIZE                 0x4000 // Size of instruction cache in bytes
+#define HAL_ICACHE_LINE_SIZE            32     // Size of ins cache line
+#define HAL_ICACHE_WAYS                 32     // Associativity of the cache
+#define HAL_ICACHE_SETS (HAL_UCACHE_SIZE/(HAL_UCACHE_LINE_SIZE*HAL_UCACHE_WAYS))
+
+//-----------------------------------------------------------------------------
+// Global control of data cache
+
+// Enable the data cache
+#define HAL_DCACHE_ENABLE()                                             \
+CYG_MACRO_START                                                         \
+    /* SA-110 manual states that the control reg is read-write */       \
+    asm volatile (                                                      \
+        "mrc  p15,0,r1,c1,c0,0;"                                        \
+        "orr  r1,r1,#0x000F;" /* ensure MM is enabled */                \
+        "mcr  p15,0,r1,c1,c0,0"                                         \
+        :                                                               \
+        :                                                               \
+        : "r1" /* Clobber list */                                       \
+        );                                                              \
+CYG_MACRO_END
+
+// Disable the data cache (and invalidate it, required semanitcs)
+#define HAL_DCACHE_DISABLE()                                            \
+CYG_MACRO_START                                                         \
+    /* SA-110 manual states that the control reg is read-write */       \
+    asm volatile (                                                      \
+        "mrc  p15,0,r1,c1,c0,0;"                                        \
+        "bic  r1,r1,#0x000C;" /* but leave MM alone */                  \
+        "mcr  p15,0,r1,c1,c0,0;"                                        \
+        "mov    r1, #0;"                                                \
+        "mcr    p15,0,r1,c7,c6,0" /* clear data cache */                \
+        :                                                               \
+        :                                                               \
+        : "r1" /* Clobber list */                                       \
+        );                                                              \
+CYG_MACRO_END
+
+// Invalidate the entire cache (and both TLBs, just in case)
+#define HAL_DCACHE_INVALIDATE_ALL()                                     \
+CYG_MACRO_START                                                         \
+    /* this macro can discard dirty cache lines. */                     \
+    asm volatile (                                                      \
+        "mov    r1, #0;"                                                \
+        "mcr    p15,0,r1,c7,c6,0;"  /* clear data cache */              \
+        "mcr    p15,0,r1,c8,c7,0;"  /* flush I+D TLBs */                \
+        :                                                               \
+        :                                                               \
+        : "r1" /* Clobber list */                                       \
+        );                                                              \
+CYG_MACRO_END
+     
+
+// Synchronize the contents of the cache with memory.
+#define HAL_DCACHE_SYNC()                                               \
+CYG_MACRO_START                                                         \
+    /* This is slightly naff in that the only way to force a dirty */   \
+    /* line out is by loading other data into its slot, so         */   \
+    /* invalidating that slot.                                     */   \
+    asm volatile (                                                      \
+        "mov    r0, #0x50000000;" /* 21285~s cache flush region */      \
+        "add    r1, r0, #0x4000;" /* 16MB of fast don~t-care amnesia */ \
+ "667: "                          /* We read in 16kB of it */           \
+        "ldr    r2, [r0], #32;"                                         \
+        "teq    r1, r0;"                                                \
+        "bne    667b;"                                                  \
+        "mov    r0, #0;"                                                \
+        "mcr    p15,0,r0,c7,c6,0;"  /* clear data cache */              \
+        "mcr    p15,0,r0,c7,c10,4;" /* and drain the write buffer */    \
+        "nop;"  /* wait for the writethrough to occur... */             \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop"                                                           \
+        :                                                               \
+        :                                                               \
+        : "r0","r1","r2" /* Clobber list */                             \
+        );                                                              \
+CYG_MACRO_END
+
+// Query the state of the data cache
+#define HAL_DCACHE_IS_ENABLED(_state_)                                  \
+CYG_MACRO_START                                                         \
+    /* SA-110 manual states clearly that the control reg is readable */ \
+    register int reg;                                                   \
+    asm volatile ("mrc  p15,0,%0,c1,c0,0"                               \
+                  : "=r"(reg)                                           \
+                  :                                                     \
+                /*:*/                                                   \
+        );                                                              \
+    (_state_) = (0 != (4 & reg)); /* Bit 2 is DCache enable */          \
+CYG_MACRO_END
+
+// Set the data cache refill burst size
+//#define HAL_DCACHE_BURST_SIZE(_size_)
+
+// Set the data cache write mode
+//#define HAL_DCACHE_WRITE_MODE( _mode_ )
+
+#define HAL_DCACHE_WRITETHRU_MODE       0
+#define HAL_DCACHE_WRITEBACK_MODE       1
+
+// Get the current writeback mode - or only writeback mode if fixed
+#define HAL_DCACHE_QUERY_WRITE_MODE( _mode_ ) CYG_MACRO_START           \
+    _mode_ = HAL_DCACHE_WRITEBACK_MODE;                                 \
+CYG_MACRO_END
+
+// Load the contents of the given address range into the data cache
+// and then lock the cache so that it stays there.
+//#define HAL_DCACHE_LOCK(_base_, _size_)
+
+// Undo a previous lock operation
+//#define HAL_DCACHE_UNLOCK(_base_, _size_)
+
+// Unlock entire cache
+//#define HAL_DCACHE_UNLOCK_ALL()
+
+//-----------------------------------------------------------------------------
+// Data cache line control
+
+// Allocate cache lines for the given address range without reading its
+// contents from memory.
+//#define HAL_DCACHE_ALLOCATE( _base_ , _size_ )
+
+// Write dirty cache lines to memory and invalidate the cache entries
+// for the given address range.
+// ---- this seems not to work despite the documentation ---
+//#define HAL_DCACHE_FLUSH( _base_ , _size_ )
+//CYG_MACRO_START
+//    HAL_DCACHE_STORE( _base_ , _size_ );
+//    HAL_DCACHE_INVALIDATE( _base_ , _size_ );
+//CYG_MACRO_END
+
+// Invalidate cache lines in the given range without writing to memory.
+// ---- this seems not to work despite the documentation ---
+//#define HAL_DCACHE_INVALIDATE( _base_ , _size_ )
+//CYG_MACRO_START
+//    register int addr, enda;
+//    for ( addr = (~(HAL_DCACHE_LINE_SIZE - 1)) & (int)(_base_),
+//              enda = (int)(_base_) + (_size_);
+//          addr < enda ;
+//          addr += HAL_DCACHE_LINE_SIZE )
+//    {
+//        asm volatile (
+//                      "mcr  p15,0,%0,c7,c6,1;" /* flush entry away */
+//                      :
+//                      : "r"(addr)
+//                      : "memory"
+//            );
+//    }
+//CYG_MACRO_END
+                          
+// Write dirty cache lines to memory for the given address range.
+// ---- this seems not to work despite the documentation ---
+//#define HAL_DCACHE_STORE( _base_ , _size_ )
+//CYG_MACRO_START
+//    register int addr, enda;
+//    for ( addr = (~(HAL_DCACHE_LINE_SIZE - 1)) & (int)(_base_),
+//              enda = (int)(_base_) + (_size_);
+//          addr < enda ;
+//          addr += HAL_DCACHE_LINE_SIZE )
+//    {
+//        asm volatile ("mcr  p15,0,%0,c7,c10,1" /* push entry to RAM */
+//                      :
+//                      : "r"(addr)
+//                      : "memory"
+//            );
+//    }
+//CYG_MACRO_END
+
+
+// Preread the given range into the cache with the intention of reading
+// from it later.
+//#define HAL_DCACHE_READ_HINT( _base_ , _size_ )
+
+// Preread the given range into the cache with the intention of writing
+// to it later.
+//#define HAL_DCACHE_WRITE_HINT( _base_ , _size_ )
+
+// Allocate and zero the cache lines associated with the given range.
+//#define HAL_DCACHE_ZERO( _base_ , _size_ )
+
+//-----------------------------------------------------------------------------
+// Global control of Instruction cache
+
+// Enable the instruction cache
+#define HAL_ICACHE_ENABLE()                                             \
+CYG_MACRO_START                                                         \
+    /* SA-110 manual states that the control reg is read-write */       \
+    asm volatile (                                                      \
+        "mrc  p15,0,r1,c1,c0,0;"                                        \
+        "orr  r1,r1,#0x0003;" /* ensure MM is enabled */                \
+        "orr  r1,r1,#0x1000;" /* enable ICache */                       \
+        "mcr  p15,0,r1,c1,c0,0"                                         \
+        :                                                               \
+        :                                                               \
+        : "r1" /* Clobber list */                                       \
+        );                                                              \
+CYG_MACRO_END
+
+// Disable the instruction cache (and invalidate it, required semanitcs)
+#define HAL_ICACHE_DISABLE()                                            \
+CYG_MACRO_START                                                         \
+    /* SA-110 manual states that the control reg is read-write */       \
+    asm volatile (                                                      \
+        "mrc    p15,0,r1,c1,c0,0;"                                      \
+        "bic    r1,r1,#0x1000;" /* but leave MM alone */                \
+        "mcr    p15,0,r1,c1,c0,0;"                                      \
+        "mov    r1, #0;"                                                \
+        "mcr    p15,0,r1,c7,c5,0;"  /* clear instruction cache */       \
+        "nop;" /* next few instructions may be via cache */             \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop"                                                           \
+        :                                                               \
+        :                                                               \
+        : "r1" /* Clobber list */                                       \
+        );                                                              \
+CYG_MACRO_END
+
+// Invalidate the entire cache
+#define HAL_ICACHE_INVALIDATE_ALL()                                     \
+CYG_MACRO_START                                                         \
+    /* this macro can discard dirty cache lines (N/A for ICache) */     \
+    asm volatile (                                                      \
+        "mov    r1, #0;"                                                \
+        "mcr    p15,0,r1,c7,c5,0;"  /* clear instruction cache */       \
+        "mcr    p15,0,r1,c8,c5,0;"  /* flush I TLB only */              \
+        "nop;" /* next few instructions may be via cache */             \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop;"                                                          \
+        "nop"                                                           \
+        :                                                               \
+        :                                                               \
+        : "r1" /* Clobber list */                                       \
+        );                                                              \
+CYG_MACRO_END
+     
+
+// Synchronize the contents of the cache with memory.
+// (which includes flushing out pending writes)
+#define HAL_ICACHE_SYNC()                                       \
+CYG_MACRO_START                                                 \
+    HAL_DCACHE_SYNC(); /* ensure data gets to RAM */            \
+    HAL_ICACHE_INVALIDATE_ALL(); /* forget all we know */       \
+CYG_MACRO_END
+
+// Query the state of the instruction cache
+#define HAL_ICACHE_IS_ENABLED(_state_)                                  \
+CYG_MACRO_START                                                         \
+    /* SA-110 manual states clearly that the control reg is readable */ \
+    register cyg_uint32 reg;                                            \
+    asm volatile ("mrc  p15,0,%0,c1,c0,0"                               \
+                  : "=r"(reg)                                           \
+                  :                                                     \
+                /*:*/                                                   \
+        );                                                              \
+    (_state_) = (0 != (0x1000 & reg)); /* Bit 12 is ICache enable */    \
+CYG_MACRO_END
+
+// Set the instruction cache refill burst size
+//#define HAL_ICACHE_BURST_SIZE(_size_)
+
+// Load the contents of the given address range into the instruction cache
+// and then lock the cache so that it stays there.
+//#define HAL_ICACHE_LOCK(_base_, _size_)
+
+// Undo a previous lock operation
+//#define HAL_ICACHE_UNLOCK(_base_, _size_)
+
+// Unlock entire cache
+//#define HAL_ICACHE_UNLOCK_ALL()
+
+//-----------------------------------------------------------------------------
+// Instruction cache line control
+
+// Invalidate cache lines in the given range without writing to memory.
+//#define HAL_ICACHE_INVALIDATE( _base_ , _size_ )
+
+//-----------------------------------------------------------------------------
+#endif // ifndef CYGONCE_HAL_CACHE_H
+// End of hal_cache.h