[1] | 1 | /* |
---|
| 2 | * hal_special.h - Generic Special Registers Access API definition. |
---|
[17] | 3 | * |
---|
[101] | 4 | * Authors Alain Greiner (2016,2017) |
---|
[1] | 5 | * |
---|
| 6 | * Copyright (c) UPMC Sorbonne Universites |
---|
[17] | 7 | * |
---|
[1] | 8 | * This file is part of ALMOS-MKH. |
---|
| 9 | * |
---|
| 10 | * ALMOS-MKH is free software; you can redistribute it and/or modify it |
---|
| 11 | * under the terms of the GNU General Public License as published by |
---|
| 12 | * the Free Software Foundation; version 2.0 of the License. |
---|
| 13 | * |
---|
| 14 | * ALMOS-MKH is distributed in the hope that it will be useful, but |
---|
| 15 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
---|
| 17 | * General Public License for more details. |
---|
| 18 | * |
---|
| 19 | * You should have received a copy of the GNU General Public License |
---|
| 20 | * along with ALMOS-MKH; if not, write to the Free Software Foundation, |
---|
| 21 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
---|
| 22 | */ |
---|
| 23 | |
---|
| 24 | #ifndef _HAL_CPU_H_ |
---|
| 25 | #define _HAL_CPU_H_ |
---|
| 26 | |
---|
| 27 | #include <hal_types.h> |
---|
| 28 | |
---|
| 29 | /**** Forward declarations ***/ |
---|
| 30 | |
---|
| 31 | struct thread_s; |
---|
| 32 | |
---|
| 33 | /////////////////////////////////////////////////////////////////////////////////////////// |
---|
| 34 | // Generic Special Registers Access API (implementation in hal_special.c) |
---|
[17] | 35 | // |
---|
[296] | 36 | // ALMOS-MKH uses the following API to access the core protected registers. |
---|
[1] | 37 | /////////////////////////////////////////////////////////////////////////////////////////// |
---|
| 38 | |
---|
| 39 | /***************************************************************************************** |
---|
[279] | 40 | * This function returns the calling core status register value. |
---|
| 41 | ****************************************************************************************/ |
---|
| 42 | inline reg_t hal_get_sr(); |
---|
| 43 | |
---|
| 44 | /***************************************************************************************** |
---|
[1] | 45 | * This function returns the global core identifier from the calling core register. |
---|
| 46 | ****************************************************************************************/ |
---|
[121] | 47 | inline gid_t hal_get_gid(); |
---|
[1] | 48 | |
---|
| 49 | /***************************************************************************************** |
---|
[121] | 50 | * This function returns the current value of the hardware cycles counter. |
---|
[408] | 51 | * This cycle counter is reset when the core is initialised (at each boot). |
---|
[121] | 52 | ****************************************************************************************/ |
---|
[296] | 53 | inline reg_t hal_time_stamp(); |
---|
[121] | 54 | |
---|
| 55 | /***************************************************************************************** |
---|
[296] | 56 | * This function returns the content of the calling core private cycles counter, |
---|
| 57 | * taking into account overflow if the core hardware register is not 64 bits. |
---|
[101] | 58 | * This cycle counter is reset when the core is initialised (at each boot). |
---|
[1] | 59 | ****************************************************************************************/ |
---|
[296] | 60 | cycle_t hal_get_cycles(); |
---|
[1] | 61 | |
---|
| 62 | /***************************************************************************************** |
---|
| 63 | * This function returns the current thread pointer from the calling core register. |
---|
| 64 | ****************************************************************************************/ |
---|
[121] | 65 | inline struct thread_s * hal_get_current_thread(); |
---|
[1] | 66 | |
---|
| 67 | /***************************************************************************************** |
---|
| 68 | * This function registers a thread pointer in the calling core register. |
---|
| 69 | ****************************************************************************************/ |
---|
| 70 | void hal_set_current_thread( struct thread_s * thread ); |
---|
| 71 | |
---|
| 72 | /***************************************************************************************** |
---|
| 73 | * This function writes into the proper core register to enable the floating point unit. |
---|
| 74 | ****************************************************************************************/ |
---|
| 75 | void hal_fpu_enable(); |
---|
| 76 | |
---|
| 77 | /***************************************************************************************** |
---|
| 78 | * This function writes into the proper core register to disable the floating point unit. |
---|
| 79 | ****************************************************************************************/ |
---|
| 80 | void hal_fpu_disable(); |
---|
| 81 | |
---|
| 82 | /***************************************************************************************** |
---|
| 83 | * This function returns the current value of stack pointer from core register. |
---|
| 84 | ****************************************************************************************/ |
---|
| 85 | uint32_t hal_get_stack(); |
---|
| 86 | |
---|
| 87 | /***************************************************************************************** |
---|
| 88 | * This function registers a new value in the core stack pointer and returns previous one. |
---|
| 89 | ****************************************************************************************/ |
---|
| 90 | extern inline uint32_t hal_set_stack( void * new_val ); |
---|
| 91 | |
---|
| 92 | /***************************************************************************************** |
---|
| 93 | * This function returns the faulty address in case of address exception. |
---|
| 94 | ****************************************************************************************/ |
---|
| 95 | uint32_t hal_get_bad_vaddr(); |
---|
| 96 | |
---|
| 97 | /***************************************************************************************** |
---|
| 98 | * This function makes an uncachable read to a 32 bits variable in local memory. |
---|
| 99 | * @ ptr : pointer on the variable |
---|
| 100 | * @ returns the value |
---|
| 101 | ****************************************************************************************/ |
---|
| 102 | uint32_t hal_uncached_read( uint32_t * ptr ); |
---|
| 103 | |
---|
| 104 | /***************************************************************************************** |
---|
| 105 | * This function invalidates the cache line containing a given address. |
---|
| 106 | * @ ptr : address in local memory |
---|
| 107 | ****************************************************************************************/ |
---|
| 108 | void hal_invalid_dcache_line( void * ptr ); |
---|
| 109 | |
---|
| 110 | /***************************************************************************************** |
---|
| 111 | * This blocking function flushes the write buffer to synchronize all pending writes. |
---|
| 112 | ****************************************************************************************/ |
---|
[124] | 113 | void hal_fence(); |
---|
[1] | 114 | |
---|
| 115 | /***************************************************************************************** |
---|
[401] | 116 | * This forbids code reordering accross this barrier by the compiler. |
---|
[1] | 117 | ****************************************************************************************/ |
---|
| 118 | void hal_rdbar(); |
---|
| 119 | |
---|
| 120 | /***************************************************************************************** |
---|
| 121 | * This function forces the calling core in idle-low-power mode. |
---|
| 122 | ****************************************************************************************/ |
---|
| 123 | void hal_core_sleep(); |
---|
| 124 | |
---|
| 125 | /***************************************************************************************** |
---|
[407] | 126 | * This function returns after approximately <delay> cycles. |
---|
| 127 | * @ delay : number of cycles. |
---|
[1] | 128 | ****************************************************************************************/ |
---|
[407] | 129 | void hal_fixed_delay( uint32_t delay ); |
---|
[1] | 130 | |
---|
[16] | 131 | /***************************************************************************************** |
---|
[17] | 132 | * This function returns information on MMU exceptions : |
---|
[16] | 133 | * @ mmu_ins_excp_code : [out] instruction fetch exception code |
---|
| 134 | * @ mmu_ins_bad_vaddr : [out] instruction fetch faulty virtual address |
---|
| 135 | * @ mmu_dat_excp_code : [out] data access exception code |
---|
| 136 | * @ mmu_dat_bad_vaddr : [out] data access faulty virtual address |
---|
| 137 | ****************************************************************************************/ |
---|
| 138 | void hal_get_mmu_excp( intptr_t * mmu_ins_excp_code, |
---|
| 139 | intptr_t * mmu_ins_bad_vaddr, |
---|
| 140 | intptr_t * mmu_dat_excp_code, |
---|
| 141 | intptr_t * mmu_dat_bad_vaddr ); |
---|
[1] | 142 | |
---|
| 143 | |
---|
| 144 | #endif /* _HAL_SPECIAL_H_ */ |
---|