Home | History | Annotate | Download | only in bl31
      1 /*
      2  * Copyright (c) 2014, ARM Limited and Contributors. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are met:
      6  *
      7  * Redistributions of source code must retain the above copyright notice, this
      8  * list of conditions and the following disclaimer.
      9  *
     10  * Redistributions in binary form must reproduce the above copyright notice,
     11  * this list of conditions and the following disclaimer in the documentation
     12  * and/or other materials provided with the distribution.
     13  *
     14  * Neither the name of ARM nor the names of its contributors may be used
     15  * to endorse or promote products derived from this software without specific
     16  * prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
     22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     28  * POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef __CPU_DATA_H__
     32 #define __CPU_DATA_H__
     33 
     34 /* Offsets for the cpu_data structure */
     35 #define CPU_DATA_CRASH_BUF_OFFSET	0x18
     36 #if CRASH_REPORTING
     37 #define CPU_DATA_LOG2SIZE		7
     38 #else
     39 #define CPU_DATA_LOG2SIZE		6
     40 #endif
     41 /* need enough space in crash buffer to save 8 registers */
     42 #define CPU_DATA_CRASH_BUF_SIZE		64
     43 #define CPU_DATA_CPU_OPS_PTR		0x10
     44 
     45 #ifndef __ASSEMBLY__
     46 
     47 #include <arch_helpers.h>
     48 #include <cassert.h>
     49 #include <platform_def.h>
     50 #include <psci.h>
     51 #include <stdint.h>
     52 
     53 /* Offsets for the cpu_data structure */
     54 #define CPU_DATA_PSCI_LOCK_OFFSET	__builtin_offsetof\
     55 		(cpu_data_t, psci_svc_cpu_data.pcpu_bakery_info)
     56 
     57 #if PLAT_PCPU_DATA_SIZE
     58 #define CPU_DATA_PLAT_PCPU_OFFSET	__builtin_offsetof\
     59 		(cpu_data_t, platform_cpu_data)
     60 #endif
     61 
     62 /*******************************************************************************
     63  * Function & variable prototypes
     64  ******************************************************************************/
     65 
     66 /*******************************************************************************
     67  * Cache of frequently used per-cpu data:
     68  *   Pointers to non-secure and secure security state contexts
     69  *   Address of the crash stack
     70  * It is aligned to the cache line boundary to allow efficient concurrent
     71  * manipulation of these pointers on different cpus
     72  *
     73  * TODO: Add other commonly used variables to this (tf_issues#90)
     74  *
     75  * The data structure and the _cpu_data accessors should not be used directly
     76  * by components that have per-cpu members. The member access macros should be
     77  * used for this.
     78  ******************************************************************************/
     79 typedef struct cpu_data {
     80 	void *cpu_context[2];
     81 	uint64_t cpu_ops_ptr;
     82 #if CRASH_REPORTING
     83 	uint64_t crash_buf[CPU_DATA_CRASH_BUF_SIZE >> 3];
     84 #endif
     85 	struct psci_cpu_data psci_svc_cpu_data;
     86 #if PLAT_PCPU_DATA_SIZE
     87 	uint8_t platform_cpu_data[PLAT_PCPU_DATA_SIZE];
     88 #endif
     89 } __aligned(CACHE_WRITEBACK_GRANULE) cpu_data_t;
     90 
     91 #if CRASH_REPORTING
     92 /* verify assembler offsets match data structures */
     93 CASSERT(CPU_DATA_CRASH_BUF_OFFSET == __builtin_offsetof
     94 	(cpu_data_t, crash_buf),
     95 	assert_cpu_data_crash_stack_offset_mismatch);
     96 #endif
     97 
     98 CASSERT((1 << CPU_DATA_LOG2SIZE) == sizeof(cpu_data_t),
     99 	assert_cpu_data_log2size_mismatch);
    100 
    101 CASSERT(CPU_DATA_CPU_OPS_PTR == __builtin_offsetof
    102 		(cpu_data_t, cpu_ops_ptr),
    103 		assert_cpu_data_cpu_ops_ptr_offset_mismatch);
    104 
    105 struct cpu_data *_cpu_data_by_index(uint32_t cpu_index);
    106 struct cpu_data *_cpu_data_by_mpidr(uint64_t mpidr);
    107 
    108 /* Return the cpu_data structure for the current CPU. */
    109 static inline struct cpu_data *_cpu_data(void)
    110 {
    111 	return (cpu_data_t *)read_tpidr_el3();
    112 }
    113 
    114 
    115 /**************************************************************************
    116  * APIs for initialising and accessing per-cpu data
    117  *************************************************************************/
    118 
    119 void init_cpu_data_ptr(void);
    120 
    121 #define get_cpu_data(_m)		   _cpu_data()->_m
    122 #define set_cpu_data(_m, _v)		   _cpu_data()->_m = _v
    123 #define get_cpu_data_by_index(_ix, _m)	   _cpu_data_by_index(_ix)->_m
    124 #define set_cpu_data_by_index(_ix, _m, _v) _cpu_data_by_index(_ix)->_m = _v
    125 #define get_cpu_data_by_mpidr(_id, _m)	   _cpu_data_by_mpidr(_id)->_m
    126 #define set_cpu_data_by_mpidr(_id, _m, _v) _cpu_data_by_mpidr(_id)->_m = _v
    127 
    128 #define flush_cpu_data(_m)	   flush_dcache_range((uint64_t) 	  \
    129 						      &(_cpu_data()->_m), \
    130 						      sizeof(_cpu_data()->_m))
    131 #define flush_cpu_data_by_index(_ix, _m)	\
    132 				   flush_dcache_range((uint64_t)	  \
    133 					 &(_cpu_data_by_index(_ix)->_m),  \
    134 					 sizeof(_cpu_data_by_index(_ix)->_m))
    135 
    136 
    137 #endif /* __ASSEMBLY__ */
    138 #endif /* __CPU_DATA_H__ */
    139