summaryrefslogtreecommitdiff
path: root/riscv/riscv_sys.sail
blob: 84002ed77ab89648e93bf5d09b85aa72f09c02c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/* exception codes */

enum Interrupts = {
  UserSWIntr,
  SupervisorSWIntr,
  ReservedIntr0,
  MachineSWIntr,

  UserTimerIntr,
  SupervisorTimerIntr,
  ReservedIntr1,
  MachineTimerIntr,

  UserExternalIntr,
  SupervisorExternalIntr,
  ReservedIntr2,
  MachineExternalIntr
}

enum ExceptionCode = {
  Misaligned_Fetch,
  Fetch_Access,
  Illegal_Instr,
  Breakpoint,
  Misaligned_Load,

  Load_Access,
  Misaligned_Store,
  Store_Access,

  User_ECall,
  Supervisor_ECall,
  ReservedExc0,
  Machine_ECall,

  Fetch_PageFault,
  Load_PageFault,
  ReservedExc1,
  Store_PageFault
}

/* machine mode registers */

/* FIXME: currently we have only those used by riscv-tests. */

bitfield Mstatus : bits(64) = {
  SD   : 63,

  SXL  : 35 .. 34,
  UXL  : 33 .. 32,

  TSR  : 22,
  TW   : 21,
  TVM  : 20,
  MXR  : 19,
  SUM  : 18,
  MPRV : 17,

  XS   : 16 .. 15,
  FS   : 14 .. 13,

  MPP  : 12 .. 11,
  SPP  : 8,

  MPIE : 7,
  SPIE : 5,
  UPIE : 4,

  MIE  : 3,
  SIE  : 1,
  UIE  : 0
}
register mstatus : Mstatus

bitfield Mip : bits(64) = {
  MEIP : 11,
  SEIP : 9,
  UEIP : 8,

  MTIP : 7,
  STIP : 5,
  UTIP : 4,

  MSIP : 3,
  SSIP : 1,
  USIP : 0,

}
register mip : Mip

bitfield Mie : bits(64) = {
  MEIE : 11,
  SEIE : 9,
  UEIE : 8,

  MTIE : 7,
  STIE : 5,
  UTIE : 4,

  MSIE : 3,
  SSIE : 1,
  USIE : 0,

}
register mie : Mie

bitfield Mideleg : bits(64) = {
  MEID : 6,
  SEID : 5,
  UEID : 4,

  MTID : 6,
  STID : 5,
  UTID : 4,

  MSID : 3,
  SSID : 1,
  USID : 0
}
register mideleg : Mideleg

bitfield Medeleg : bits(64) = {
  STORE_PAGE_FAULT  : 15,
  LOAD_PAGE_FAULT   : 13,
  FETCH_PAGE_FAULT  : 12,
  MACHINE_ECALL     : 10,
  SUPERVISOR_ECALL  : 9,
  USER_ECALL        : 8,
  STORE_ACCESS      : 7,
  MISALIGNED_STORE  : 6,
  LOAD_ACCESS       : 5,
  MISALIGNED_LOAD   : 4,
  BREAKPOINT        : 3,
  ILLEGAL_INSTR     : 2,
  FETCH_ACCESS      : 1,
  MISALIGNED_FETCH  : 0
}
register medeleg : Medeleg

/* exception registers */
register mepc : regval
register mtval : regval
register mtvec : regval
register mscratch : regval

/* other registers */

register pmpaddr0 : regval
register pmpcfg0 : regval
/* TODO: this should be readonly, and always 0 for now */
register mhartid : regval

/* instruction control flow */

struct sync_exception = {
  trap : ExceptionCode,
  badaddr : option(regval)
}

union ctl_result = {
  CTL_TRAP : sync_exception,
/* TODO:
  CTL_URET,
  CTL_SRET,
*/
  CTL_MRET
}

/* privilege level */

union privilege = {
  MACHINE,
  USER
}
register cur_privilege : privilege

function priv_to_bits(p : privilege) -> bits(2) =
  match (p) {
    USER    => 0b00,
    MACHINE => 0b11
  }
function bits_to_priv(b : bits(2)) -> privilege =
  match (b) {
    0b00    => USER,
    0b11    => MACHINE
  }

/* handle exceptional ctl flow by updating nextPC */

function handle_exception_ctl(cur_priv : privilege, ctl : ctl_result,
                              pc: regval) -> regval =
  /* TODO: check delegation */
  match (cur_priv, ctl) {
    (_, CTL_TRAP(e)) => {
      mepc            = pc;
      mcause          = e.trap;

      mstatus->MPIE() = mstatus.MIE();
      mstatus->MIE()  = false;
      mstatus->MPP()  = priv_to_bits(cur_priv);
      cur_privilege   = MACHINE;

      match (e.trap) {
        Misaligned_Fetch => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },
        Fetch_Access => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },
        Illegal_Instr => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },

        Breakpoint => not_implemented("breakpoint"),

        Misaligned_Load => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },
        Load_Access => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },
        Misaligned_Store => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },
        Store_Access => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },

        User_ECall => {
          mtval  = EXTZ(0b0)
        },
        Supervisor_ECall => {
          mtval  = EXTZ(0b0)
        },
        Machine_ECall => {
          mtval  = EXTZ(0b0)
        },

        Fetch_PageFault => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },
        Load_PageFault => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        },
        Store_PageFault => {
          match (e.badaddr) {
            Some(a) => mtval = a,
            None    => throw(Error_internal_error)
          }
        }
      };
      /* TODO: make register read explicit */
      mtvec
    },
    (_, CTL_MRET) => {
      mstatus->MIE()  = mstatus.MPIE();
      mstatus->MPIE() = true;
      cur_privilege   = bits_to_priv(mstatus.MPP());
      mstatus->MPP()  = priv_to_bits(USER);
      mepc
    }
  }