source: trunk/hal/generic/hal_special.h @ 347

Last change on this file since 347 was 296, checked in by alain, 5 years ago

Several modifs in the generic scheduler and in the hal_context to
fix the context switch mechanism.

File size: 7.4 KB
Line 
1/*
2 * hal_special.h - Generic Special Registers Access API definition.
3 *
4 * Authors   Alain Greiner    (2016,2017)
5 *
6 * Copyright (c)  UPMC Sorbonne Universites
7 *
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
31struct thread_s;
32
33///////////////////////////////////////////////////////////////////////////////////////////
34//      Generic Special Registers Access API (implementation in hal_special.c)
35//
36// ALMOS-MKH uses the following API to access the core protected registers.
37///////////////////////////////////////////////////////////////////////////////////////////
38
39/*****************************************************************************************
40 * This function returns the calling core status register value.
41 ****************************************************************************************/
42inline reg_t hal_get_sr();
43
44/*****************************************************************************************
45 * This function returns the global core identifier from the calling core register.
46 ****************************************************************************************/
47inline gid_t hal_get_gid();
48
49/*****************************************************************************************
50 * This function returns the current value of the hardware cycles counter.
51 ****************************************************************************************/
52inline reg_t hal_time_stamp();
53
54/*****************************************************************************************
55 * This function returns the content of the calling core private cycles counter,
56 * taking into account overflow if the core hardware register is not 64 bits.
57 * This cycle counter is reset when the core is initialised (at each boot).
58 ****************************************************************************************/
59cycle_t hal_get_cycles();
60
61/*****************************************************************************************
62 * This function returns the current thread pointer from the calling core register.
63 ****************************************************************************************/
64inline struct thread_s * hal_get_current_thread();
65
66/*****************************************************************************************
67 * This function registers a thread pointer in the calling core register.
68 ****************************************************************************************/
69void hal_set_current_thread( struct thread_s * thread );
70
71/*****************************************************************************************
72 * This function registers a new kentry base address in the relevant core register.
73 ****************************************************************************************/
74void hal_set_ebase( reg_t base );
75
76/*****************************************************************************************
77 * This function writes into the proper core register to enable the floating point unit.
78 ****************************************************************************************/
79void hal_fpu_enable();
80
81/*****************************************************************************************
82 * This function writes into the proper core register to disable the floating point unit.
83 ****************************************************************************************/
84void hal_fpu_disable();
85
86/*****************************************************************************************
87 * This function returns the current value of stack pointer from core register.
88 ****************************************************************************************/
89uint32_t hal_get_stack();
90
91/*****************************************************************************************
92 * This function registers a new value in the core stack pointer and returns previous one.
93 ****************************************************************************************/
94extern inline uint32_t hal_set_stack( void * new_val );
95
96/*****************************************************************************************
97 * This function returns the faulty address in case of address exception.
98 ****************************************************************************************/
99uint32_t hal_get_bad_vaddr();
100
101/*****************************************************************************************
102 * This function makes an uncachable read to a 32 bits variable in local memory.
103 * @ ptr     : pointer on the variable
104 * @ returns the value
105 ****************************************************************************************/
106uint32_t hal_uncached_read( uint32_t * ptr );
107
108/*****************************************************************************************
109 * This function invalidates the cache line containing a given address.
110 * @ ptr     : address in local memory
111 ****************************************************************************************/
112void hal_invalid_dcache_line( void * ptr );
113
114/*****************************************************************************************
115 * This blocking function flushes the write buffer to synchronize all pending writes.
116 ****************************************************************************************/
117void hal_fence();
118
119/*****************************************************************************************
120 * This forbids code reordering by the compiler.
121 ****************************************************************************************/
122void hal_rdbar();
123
124/*****************************************************************************************
125 * This function forces the calling core in idle-low-power mode.
126 ****************************************************************************************/
127void hal_core_sleep();
128
129/*****************************************************************************************
130 * This function returns after a fixed delay of (4 * delay) cycles.
131 ****************************************************************************************/
132void hal_fixed_delay();
133
134/*****************************************************************************************
135 * This function returns information on MMU exceptions :
136 * @ mmu_ins_excp_code : [out] instruction fetch exception code
137 * @ mmu_ins_bad_vaddr : [out] instruction fetch faulty virtual address
138 * @ mmu_dat_excp_code : [out] data access exception code
139 * @ mmu_dat_bad_vaddr : [out] data access faulty virtual address
140 ****************************************************************************************/
141void hal_get_mmu_excp( intptr_t * mmu_ins_excp_code,
142                       intptr_t * mmu_ins_bad_vaddr,
143                       intptr_t * mmu_dat_excp_code,
144                       intptr_t * mmu_dat_bad_vaddr );
145
146
147#endif  /* _HAL_SPECIAL_H_ */
Note: See TracBrowser for help on using the repository browser.