mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-17 18:14:24 +00:00
c3cf06f1a3
All identifiers, regardless of use, that start with two underscores are reserved. This means they can't be used in header guards. The style that this project is now to use the full name of the file in capital letters followed by 'H'. For example, for a file called "uart_example.h", the header guard is UART_EXAMPLE_H. The exceptions are files that are imported from other projects: - CryptoCell driver - dt-bindings folders - zlib headers Change-Id: I50561bf6c88b491ec440d0c8385c74650f3c106e Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
230 lines
5.8 KiB
ArmAsm
230 lines
5.8 KiB
ArmAsm
/*
|
|
* Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
#ifndef CPU_MACROS_S
|
|
#define CPU_MACROS_S
|
|
|
|
#include <arch.h>
|
|
#include <errata_report.h>
|
|
|
|
#if defined(IMAGE_BL1) || defined(IMAGE_BL32) || (defined(IMAGE_BL2) && BL2_AT_EL3)
|
|
#define IMAGE_AT_EL3
|
|
#endif
|
|
|
|
#define CPU_IMPL_PN_MASK (MIDR_IMPL_MASK << MIDR_IMPL_SHIFT) | \
|
|
(MIDR_PN_MASK << MIDR_PN_SHIFT)
|
|
|
|
/* The number of CPU operations allowed */
|
|
#define CPU_MAX_PWR_DWN_OPS 2
|
|
|
|
/* Special constant to specify that CPU has no reset function */
|
|
#define CPU_NO_RESET_FUNC 0
|
|
|
|
/* Word size for 32-bit CPUs */
|
|
#define CPU_WORD_SIZE 4
|
|
|
|
/*
|
|
* Whether errata status needs reporting. Errata status is printed in debug
|
|
* builds for both BL1 and BL32 images.
|
|
*/
|
|
#if (defined(IMAGE_BL1) || defined(IMAGE_BL32)) && DEBUG
|
|
# define REPORT_ERRATA 1
|
|
#else
|
|
# define REPORT_ERRATA 0
|
|
#endif
|
|
|
|
|
|
.equ CPU_MIDR_SIZE, CPU_WORD_SIZE
|
|
.equ CPU_RESET_FUNC_SIZE, CPU_WORD_SIZE
|
|
.equ CPU_PWR_DWN_OPS_SIZE, CPU_WORD_SIZE * CPU_MAX_PWR_DWN_OPS
|
|
.equ CPU_ERRATA_FUNC_SIZE, CPU_WORD_SIZE
|
|
.equ CPU_ERRATA_LOCK_SIZE, CPU_WORD_SIZE
|
|
.equ CPU_ERRATA_PRINTED_SIZE, CPU_WORD_SIZE
|
|
|
|
#ifndef IMAGE_AT_EL3
|
|
.equ CPU_RESET_FUNC_SIZE, 0
|
|
#endif
|
|
|
|
/* The power down core and cluster is needed only in BL32 */
|
|
#ifndef IMAGE_BL32
|
|
.equ CPU_PWR_DWN_OPS_SIZE, 0
|
|
#endif
|
|
|
|
/* Fields required to print errata status */
|
|
#if !REPORT_ERRATA
|
|
.equ CPU_ERRATA_FUNC_SIZE, 0
|
|
#endif
|
|
|
|
/* Only BL32 requires mutual exclusion and printed flag. */
|
|
#if !(REPORT_ERRATA && defined(IMAGE_BL32))
|
|
.equ CPU_ERRATA_LOCK_SIZE, 0
|
|
.equ CPU_ERRATA_PRINTED_SIZE, 0
|
|
#endif
|
|
|
|
|
|
/*
|
|
* Define the offsets to the fields in cpu_ops structure.
|
|
* Every offset is defined based on the offset and size of the previous
|
|
* field.
|
|
*/
|
|
.equ CPU_MIDR, 0
|
|
.equ CPU_RESET_FUNC, CPU_MIDR + CPU_MIDR_SIZE
|
|
.equ CPU_PWR_DWN_OPS, CPU_RESET_FUNC + CPU_RESET_FUNC_SIZE
|
|
.equ CPU_ERRATA_FUNC, CPU_PWR_DWN_OPS + CPU_PWR_DWN_OPS_SIZE
|
|
.equ CPU_ERRATA_LOCK, CPU_ERRATA_FUNC + CPU_ERRATA_FUNC_SIZE
|
|
.equ CPU_ERRATA_PRINTED, CPU_ERRATA_LOCK + CPU_ERRATA_LOCK_SIZE
|
|
.equ CPU_OPS_SIZE, CPU_ERRATA_PRINTED + CPU_ERRATA_PRINTED_SIZE
|
|
|
|
/*
|
|
* Write given expressions as words
|
|
*
|
|
* _count:
|
|
* Write at least _count words. If the given number of expressions
|
|
* is less than _count, repeat the last expression to fill _count
|
|
* words in total
|
|
* _rest:
|
|
* Optional list of expressions. _this is for parameter extraction
|
|
* only, and has no significance to the caller
|
|
*
|
|
* Invoked as:
|
|
* fill_constants 2, foo, bar, blah, ...
|
|
*/
|
|
.macro fill_constants _count:req, _this, _rest:vararg
|
|
.ifgt \_count
|
|
/* Write the current expression */
|
|
.ifb \_this
|
|
.error "Nothing to fill"
|
|
.endif
|
|
.word \_this
|
|
|
|
/* Invoke recursively for remaining expressions */
|
|
.ifnb \_rest
|
|
fill_constants \_count-1, \_rest
|
|
.else
|
|
fill_constants \_count-1, \_this
|
|
.endif
|
|
.endif
|
|
.endm
|
|
|
|
/*
|
|
* Declare CPU operations
|
|
*
|
|
* _name:
|
|
* Name of the CPU for which operations are being specified
|
|
* _midr:
|
|
* Numeric value expected to read from CPU's MIDR
|
|
* _resetfunc:
|
|
* Reset function for the CPU. If there's no CPU reset function,
|
|
* specify CPU_NO_RESET_FUNC
|
|
* _power_down_ops:
|
|
* Comma-separated list of functions to perform power-down
|
|
* operatios on the CPU. At least one, and up to
|
|
* CPU_MAX_PWR_DWN_OPS number of functions may be specified.
|
|
* Starting at power level 0, these functions shall handle power
|
|
* down at subsequent power levels. If there aren't exactly
|
|
* CPU_MAX_PWR_DWN_OPS functions, the last specified one will be
|
|
* used to handle power down at subsequent levels
|
|
*/
|
|
.macro declare_cpu_ops _name:req, _midr:req, _resetfunc:req, \
|
|
_power_down_ops:vararg
|
|
.section cpu_ops, "a"
|
|
.align 2
|
|
.type cpu_ops_\_name, %object
|
|
.word \_midr
|
|
#if defined(IMAGE_AT_EL3)
|
|
.word \_resetfunc
|
|
#endif
|
|
#ifdef IMAGE_BL32
|
|
/* Insert list of functions */
|
|
fill_constants CPU_MAX_PWR_DWN_OPS, \_power_down_ops
|
|
#endif
|
|
|
|
#if REPORT_ERRATA
|
|
.ifndef \_name\()_cpu_str
|
|
/*
|
|
* Place errata reported flag, and the spinlock to arbitrate access to
|
|
* it in the data section.
|
|
*/
|
|
.pushsection .data
|
|
define_asm_spinlock \_name\()_errata_lock
|
|
\_name\()_errata_reported:
|
|
.word 0
|
|
.popsection
|
|
|
|
/* Place CPU string in rodata */
|
|
.pushsection .rodata
|
|
\_name\()_cpu_str:
|
|
.asciz "\_name"
|
|
.popsection
|
|
.endif
|
|
|
|
/*
|
|
* Mandatory errata status printing function for CPUs of
|
|
* this class.
|
|
*/
|
|
.word \_name\()_errata_report
|
|
|
|
#ifdef IMAGE_BL32
|
|
/* Pointers to errata lock and reported flag */
|
|
.word \_name\()_errata_lock
|
|
.word \_name\()_errata_reported
|
|
#endif
|
|
#endif
|
|
.endm
|
|
|
|
#if REPORT_ERRATA
|
|
/*
|
|
* Print status of a CPU errata
|
|
*
|
|
* _chosen:
|
|
* Identifier indicating whether or not a CPU errata has been
|
|
* compiled in.
|
|
* _cpu:
|
|
* Name of the CPU
|
|
* _id:
|
|
* Errata identifier
|
|
* _rev_var:
|
|
* Register containing the combined value CPU revision and variant
|
|
* - typically the return value of cpu_get_rev_var
|
|
*/
|
|
.macro report_errata _chosen, _cpu, _id, _rev_var=r4
|
|
/* Stash a string with errata ID */
|
|
.pushsection .rodata
|
|
\_cpu\()_errata_\_id\()_str:
|
|
.asciz "\_id"
|
|
.popsection
|
|
|
|
/* Check whether errata applies */
|
|
mov r0, \_rev_var
|
|
bl check_errata_\_id
|
|
|
|
.ifeq \_chosen
|
|
/*
|
|
* Errata workaround has not been compiled in. If the errata would have
|
|
* applied had it been compiled in, print its status as missing.
|
|
*/
|
|
cmp r0, #0
|
|
movne r0, #ERRATA_MISSING
|
|
.endif
|
|
ldr r1, =\_cpu\()_cpu_str
|
|
ldr r2, =\_cpu\()_errata_\_id\()_str
|
|
bl errata_print_msg
|
|
.endm
|
|
#endif
|
|
/*
|
|
* Helper macro that reads the part number of the current CPU and jumps
|
|
* to the given label if it matches the CPU MIDR provided.
|
|
*
|
|
* Clobbers: r0-r1
|
|
*/
|
|
.macro jump_if_cpu_midr _cpu_midr, _label
|
|
ldcopr r0, MIDR
|
|
ubfx r0, r0, #MIDR_PN_SHIFT, #12
|
|
ldr r1, =((\_cpu_midr >> MIDR_PN_SHIFT) & MIDR_PN_MASK)
|
|
cmp r0, r1
|
|
beq \_label
|
|
.endm
|
|
|
|
#endif /* CPU_MACROS_S */
|