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

Last change on this file since 427 was 408, checked in by alain, 7 years ago

Fix several bugs in the fork() syscall.
File size: 7.3 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 * This cycle counter is reset when the core is initialised (at each boot).
52 ****************************************************************************************/
53inline reg_t hal_time_stamp();
54
55/*****************************************************************************************
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.
58 * This cycle counter is reset when the core is initialised (at each boot).
59 ****************************************************************************************/
60cycle_t hal_get_cycles();
61
62/*****************************************************************************************
63 * This function returns the current thread pointer from the calling core register.
64 ****************************************************************************************/
65inline struct thread_s * hal_get_current_thread();
66
67/*****************************************************************************************
68 * This function registers a thread pointer in the calling core register.
69 ****************************************************************************************/
70void 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 ****************************************************************************************/
75void hal_fpu_enable();
76
77/*****************************************************************************************
78 * This function writes into the proper core register to disable the floating point unit.
79 ****************************************************************************************/
80void hal_fpu_disable();
81
82/*****************************************************************************************
83 * This function returns the current value of stack pointer from core register.
84 ****************************************************************************************/
85uint32_t hal_get_stack();
86
87/*****************************************************************************************
88 * This function registers a new value in the core stack pointer and returns previous one.
89 ****************************************************************************************/
90extern inline uint32_t hal_set_stack( void * new_val );
91
92/*****************************************************************************************
93 * This function returns the faulty address in case of address exception.
94 ****************************************************************************************/
95uint32_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 ****************************************************************************************/
102uint32_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 ****************************************************************************************/
108void hal_invalid_dcache_line( void * ptr );
109
110/*****************************************************************************************
111 * This blocking function flushes the write buffer to synchronize all pending writes.
112 ****************************************************************************************/
113void hal_fence();
114
115/*****************************************************************************************
116 * This forbids code reordering accross this barrier by the compiler.
117 ****************************************************************************************/
118void hal_rdbar();
119
120/*****************************************************************************************
121 * This function forces the calling core in idle-low-power mode.
122 ****************************************************************************************/
123void hal_core_sleep();
124
125/*****************************************************************************************
126 * This function returns after approximately <delay> cycles.
127 * @ delay  : number of cycles.
128 ****************************************************************************************/
129void hal_fixed_delay( uint32_t delay );
130
131/*****************************************************************************************
132 * This function returns information on MMU exceptions :
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 ****************************************************************************************/
138void 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 );
142
143
144#endif  /* _HAL_SPECIAL_H_ */
Note: See TracBrowser for help on using the repository browser.