source: trunk/hal/tsar_mips32/core/hal_types.h @ 343

Last change on this file since 343 was 315, checked in by alain, 7 years ago

Redefine the fuctions ppm_base2page() / ppm_page2base() / ppm_page2ppn() / ppm_ppn2page() / ppm_base2ppn() / ppm_ppn2base(),
to use explicitely extended pointers.
File size: 7.1 KB
Line 
1/*
2 * hal_types.h - common kernel types for MIPS 32 bits
3 *
4 * Author  Alain Greiner (2016)
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_TYPES_H_
25#define HAL_TYPES_H_
26
27#include <kernel_config.h>
28
29#define HAL_32BIT
30
31#ifndef NULL
32#define NULL (void*)        0
33#endif
34
35/**************************************************************************
36 *                      Exact-width integer types. 
37 **************************************************************************/
38
39typedef   signed           char     int8_t;
40typedef unsigned           char    uint8_t;
41
42typedef   signed           short    int16_t;
43typedef unsigned           short   uint16_t;
44
45typedef   signed long      int      int32_t;
46typedef unsigned long      int     uint32_t;
47
48typedef   signed long long int      int64_t;
49typedef unsigned long long int     uint64_t;
50
51/***************************************************************************
52 * Pthread related types
53 **************************************************************************/
54
55typedef uint32_t      pthread_t;               
56typedef uint32_t      pthread_mutexattr_t;
57typedef uint32_t      pthread_barrier_t;
58typedef uint32_t      pthread_barrierattr_t;
59typedef uint32_t      sem_t;
60typedef uint32_t      pthread_cond_t;
61typedef uint32_t      pthread_condattr_t;
62typedef uint32_t      pthread_rwlock_t;
63typedef uint32_t      pthread_rwlockattr_t;
64typedef uint32_t      pthread_key_t;
65
66/***************************************************************************
67 * Boolean type and macros
68 **************************************************************************/
69
70typedef uint32_t      bool_t;
71
72#define false         0
73#define true          1
74
75/***************************************************************************
76 * Kernel error type : signed
77 **************************************************************************/
78
79typedef int32_t       error_t;
80
81/***************************************************************************
82 * Time related type
83 **************************************************************************/
84
85typedef uint64_t      cycle_t;   // for cycle counters
86
87/***************************************************************************
88 * Global Process identifier type / fixed format
89 * 16 MSB = cluster XY identifier
90 * 16 LSB = local process index
91 **************************************************************************/
92
93typedef uint32_t      pid_t; 
94
95/***************************************************************************
96 * Local Process index 
97 **************************************************************************/
98
99typedef uint16_t      lpid_t;
100
101/***************************************************************************
102 * Thread  identifier type / fixed format
103 * 16 MSB = cluster XY identifier
104 * 16 LSB = local thread index
105 **************************************************************************/
106
107typedef uint32_t      trdid_t;
108
109/***************************************************************************
110 * Local Thread index
111 **************************************************************************/
112
113typedef uint16_t      ltid_t;
114
115/***************************************************************************
116 * User identifier type
117 **************************************************************************/
118
119typedef uint32_t      uid_t;
120
121/***************************************************************************
122 * CPU identifier types
123 **************************************************************************/
124
125typedef uint16_t      lid_t;    // local index in cluster
126typedef uint32_t      gid_t;    // global (hardware) identifier
127
128/***************************************************************************
129 * File Descriptor Index in File Descriptor Array
130 **************************************************************************/
131
132typedef uint32_t      fdid_t;
133
134/***************************************************************************
135 * This structure defines a single 32 bits integer alone in a cache line.
136 **************************************************************************/
137
138typedef struct cache_line_s
139{
140  union
141  {
142    uint32_t values[CONFIG_CACHE_LINE_SIZE>>2];
143    uint32_t value;
144  };
145}
146__attribute__((packed)) cacheline_t;
147
148/***************************************************************************
149 *  Address types and macros         !!!  hardware dependant  !!!
150 ***************************************************************************
151 * An extended pointer a 64 bits integer, structured in two fields :
152 * - cxy : cluster identifier.
153 * - ptr : pointer in the virtual space of a single cluster.
154 *
155 * In TSAR (MIPS32), the kernel virtual space has 4 Gbytes per cluster
156 * - the cxy field occupies bits[47:32]
157 * - the ptr field occupies bits[31:0]
158 ***************************************************************************
159 * A physical address is a 64 bits integer, structured in two fields :
160 * - cxy : cluster identifier.
161 * - lpa : local physical address inside cluster.
162 *
163 * In TSAR (MIPS32), the physical space has 4Gbytes per cluster.
164 * - the cxy field occupies bits[39:32]
165 * - the lpa field occupies bits[31:0]
166 **************************************************************************/
167
168typedef uint32_t               reg_t;         // core register
169
170typedef uint64_t               xptr_t;        // extended pointer
171
172typedef uint16_t               cxy_t;         // cluster identifier
173
174typedef uint64_t               paddr_t;       // global physical address
175
176typedef uint32_t               lpa_t;         // local physical address
177
178typedef uint32_t               intptr_t;      // local pointer stored as integer
179
180typedef uint32_t               ppn_t;         // Physical Page Number
181
182typedef uint32_t               vpn_t;         // Virtual Page number
183
184
185#define XPTR_NULL              0
186
187#define PTR_MASK               0x00000000FFFFFFFFULL
188
189#define PTR_SHIFT              32
190
191#define GET_CXY(xp)            ((cxy_t)((xp) >> PTR_SHIFT))
192
193#define GET_PTR(xp)            ((void*)(uint32_t)((xp) & PTR_MASK))
194
195#define XPTR(cxy,ptr)          (((uint64_t)(cxy) << PTR_SHIFT) | (((uint32_t)(ptr)) & PTR_MASK))
196
197
198#define LPA_MASK               0x00000000FFFFFFFFULL
199
200#define LPA_SHIFT              32
201
202#define CXY_FROM_PADDR(paddr)  ((cxy_t)((paddr) >> LPA_SHIFT))
203
204#define LPA_FROM_PADDR(paddr)  (lpa_t)(paddr & LPA_MASK)
205
206#define PADDR(cxy,lpa)         (((uint64_t)(cxy) << LPA_SHIFT) | (((uint64_t)(lpa)) & LPA_MASK))
207
208
209
210#endif  /* HAL_TYPES_H_ */
Note: See TracBrowser for help on using the repository browser.