ArmPkg/Library/ArmLib/Common/ArmLibPrivate.h

   1 /** @file
   2
   3   Copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
   4
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __ARM_LIB_PRIVATE_H__
  16 #define __ARM_LIB_PRIVATE_H__
  17
  18 #define CACHE_SIZE_4_KB             (3UL)
  19 #define CACHE_SIZE_8_KB             (4UL)
  20 #define CACHE_SIZE_16_KB            (5UL)
  21 #define CACHE_SIZE_32_KB            (6UL)
  22 #define CACHE_SIZE_64_KB            (7UL)
  23 #define CACHE_SIZE_128_KB           (8UL)
  24
  25 #define CACHE_ASSOCIATIVITY_DIRECT  (0UL)
  26 #define CACHE_ASSOCIATIVITY_4_WAY   (2UL)
  27 #define CACHE_ASSOCIATIVITY_8_WAY   (3UL)
  28
  29 #define CACHE_PRESENT               (0UL)
  30 #define CACHE_NOT_PRESENT           (1UL)
  31
  32 #define CACHE_LINE_LENGTH_32_BYTES  (2UL)
  33
  34 #define SIZE_FIELD_TO_CACHE_SIZE(x)           (((x) >> 6) & 0x0F)
  35 #define SIZE_FIELD_TO_CACHE_ASSOCIATIVITY(x)  (((x) >> 3) & 0x07)
  36 #define SIZE_FIELD_TO_CACHE_PRESENCE(x)       (((x) >> 2) & 0x01)
  37 #define SIZE_FIELD_TO_CACHE_LINE_LENGTH(x)    (((x) >> 0) & 0x03)
  38
  39 #define DATA_CACHE_SIZE_FIELD(x)              (((x) >> 12) & 0x0FFF)
  40 #define INSTRUCTION_CACHE_SIZE_FIELD(x)       (((x) >>  0) & 0x0FFF)
  41
  42 #define DATA_CACHE_SIZE(x)                    (SIZE_FIELD_TO_CACHE_SIZE(DATA_CACHE_SIZE_FIELD(x)))
  43 #define DATA_CACHE_ASSOCIATIVITY(x)           (SIZE_FIELD_TO_CACHE_ASSOCIATIVITY(DATA_CACHE_SIZE_FIELD(x)))
  44 #define DATA_CACHE_PRESENT(x)                 (SIZE_FIELD_TO_CACHE_PRESENCE(DATA_CACHE_SIZE_FIELD(x)))
  45 #define DATA_CACHE_LINE_LENGTH(x)             (SIZE_FIELD_TO_CACHE_LINE_LENGTH(DATA_CACHE_SIZE_FIELD(x)))
  46
  47 #define INSTRUCTION_CACHE_SIZE(x)             (SIZE_FIELD_TO_CACHE_SIZE(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  48 #define INSTRUCTION_CACHE_ASSOCIATIVITY(x)    (SIZE_FIELD_TO_CACHE_ASSOCIATIVITY(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  49 #define INSTRUCTION_CACHE_PRESENT(x)          (SIZE_FIELD_TO_CACHE_PRESENCE(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  50 #define INSTRUCTION_CACHE_LINE_LENGTH(x)      (SIZE_FIELD_TO_CACHE_LINE_LENGTH(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  51
  52 #define CACHE_TYPE(x)                         (((x) >> 25) & 0x0F)
  53 #define CACHE_TYPE_WRITE_BACK                 (0x0EUL)
  54
  55 #define CACHE_ARCHITECTURE(x)                 (((x) >> 24) & 0x01)
  56 #define CACHE_ARCHITECTURE_UNIFIED            (0UL)
  57 #define CACHE_ARCHITECTURE_SEPARATE           (1UL)
  58
  59 typedef VOID (*ARM_V7_CACHE_OPERATION)(UINT32);
  60
  61 VOID
  62 CPSRMaskInsert (
  63   IN  UINT32  Mask,
  64   IN  UINT32  Value
  65   );
  66
  67 UINT32
  68 CPSRRead (
  69   VOID
  70   );
  71
  72
  73 UINT32
  74 ReadCCSIDR (
  75   IN UINT32 CSSELR
  76   );
  77
  78
  79 UINT32
  80 ReadCLIDR (
  81   VOID
  82   );
  83
  84 VOID
  85 ArmV7AllDataCachesOperation (
  86   IN  ARM_V7_CACHE_OPERATION  DataCacheOperation
  87   );
  88
  89
  90 #endif // __ARM_LIB_PRIVATE_H__