ArmPkg/Library/ArmLib/ArmLibPrivate.h

   1 /** @file
   2
   3   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
   4
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __ARM_LIB_PRIVATE_H__
  10 #define __ARM_LIB_PRIVATE_H__
  11
  12 #define CACHE_SIZE_4_KB             (3UL)
  13 #define CACHE_SIZE_8_KB             (4UL)
  14 #define CACHE_SIZE_16_KB            (5UL)
  15 #define CACHE_SIZE_32_KB            (6UL)
  16 #define CACHE_SIZE_64_KB            (7UL)
  17 #define CACHE_SIZE_128_KB           (8UL)
  18
  19 #define CACHE_ASSOCIATIVITY_DIRECT  (0UL)
  20 #define CACHE_ASSOCIATIVITY_4_WAY   (2UL)
  21 #define CACHE_ASSOCIATIVITY_8_WAY   (3UL)
  22
  23 #define CACHE_PRESENT               (0UL)
  24 #define CACHE_NOT_PRESENT           (1UL)
  25
  26 #define CACHE_LINE_LENGTH_32_BYTES  (2UL)
  27
  28 #define SIZE_FIELD_TO_CACHE_SIZE(x)           (((x) >> 6) & 0x0F)
  29 #define SIZE_FIELD_TO_CACHE_ASSOCIATIVITY(x)  (((x) >> 3) & 0x07)
  30 #define SIZE_FIELD_TO_CACHE_PRESENCE(x)       (((x) >> 2) & 0x01)
  31 #define SIZE_FIELD_TO_CACHE_LINE_LENGTH(x)    (((x) >> 0) & 0x03)
  32
  33 #define DATA_CACHE_SIZE_FIELD(x)              (((x) >> 12) & 0x0FFF)
  34 #define INSTRUCTION_CACHE_SIZE_FIELD(x)       (((x) >>  0) & 0x0FFF)
  35
  36 #define DATA_CACHE_SIZE(x)                    (SIZE_FIELD_TO_CACHE_SIZE(DATA_CACHE_SIZE_FIELD(x)))
  37 #define DATA_CACHE_ASSOCIATIVITY(x)           (SIZE_FIELD_TO_CACHE_ASSOCIATIVITY(DATA_CACHE_SIZE_FIELD(x)))
  38 #define DATA_CACHE_PRESENT(x)                 (SIZE_FIELD_TO_CACHE_PRESENCE(DATA_CACHE_SIZE_FIELD(x)))
  39 #define DATA_CACHE_LINE_LENGTH(x)             (SIZE_FIELD_TO_CACHE_LINE_LENGTH(DATA_CACHE_SIZE_FIELD(x)))
  40
  41 #define INSTRUCTION_CACHE_SIZE(x)             (SIZE_FIELD_TO_CACHE_SIZE(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  42 #define INSTRUCTION_CACHE_ASSOCIATIVITY(x)    (SIZE_FIELD_TO_CACHE_ASSOCIATIVITY(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  43 #define INSTRUCTION_CACHE_PRESENT(x)          (SIZE_FIELD_TO_CACHE_PRESENCE(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  44 #define INSTRUCTION_CACHE_LINE_LENGTH(x)      (SIZE_FIELD_TO_CACHE_LINE_LENGTH(INSTRUCTION_CACHE_SIZE_FIELD(x)))
  45
  46 #define CACHE_TYPE(x)                         (((x) >> 25) & 0x0F)
  47 #define CACHE_TYPE_WRITE_BACK                 (0x0EUL)
  48
  49 #define CACHE_ARCHITECTURE(x)                 (((x) >> 24) & 0x01)
  50 #define CACHE_ARCHITECTURE_UNIFIED            (0UL)
  51 #define CACHE_ARCHITECTURE_SEPARATE           (1UL)
  52
  53 VOID
  54 CPSRMaskInsert (
  55   IN  UINT32  Mask,
  56   IN  UINT32  Value
  57   );
  58
  59 UINT32
  60 CPSRRead (
  61   VOID
  62   );
  63
  64 UINT32
  65 ReadCCSIDR (
  66   IN UINT32 CSSELR
  67   );
  68
  69 UINT32
  70 ReadCLIDR (
  71   VOID
  72   );
  73
  74 #endif // __ARM_LIB_PRIVATE_H__