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

Last change on this file since 486 was 480, checked in by viala@…, 6 years ago

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