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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
//! Exception and interrupt handling.

use super::ExceptionLevel;
use crate::system_register_access;
use core::arch::asm;
use tartan_bitfield::bitfield;
use tartan_c_enum::c_enum;

// Must be re-exported so that crates that use these macros will be able to resolve it
#[doc(hidden)]
pub use paste::paste;


/// Define an exception vector table that forwards all exceptions to the designated
/// handler.
///
/// The first argument is the name of the vector table, which will be exported as an
/// unmangled symbol and exposed to Rust code as an immutable static of type
/// [`VectorTable`].
///
/// The second argument is the name of the handler function, which should have
/// signature `func(Kind, Source)`.
///
/// # Example
/// ```ignore
/// # use tartan_arch::aarch64_exception_vector_table;
/// # use tartan_arch::aarch64::ExceptionLevel;
/// # use tartan_arch::aarch64::interrupt::{Kind, Source, VectorBaseAddressRegister};
/// #
/// aarch64_exception_vector_table!(exception_table_el1, handle_exception);
///
/// fn handle_exception(kind: Kind, source: Source) {
///     panic!("Exception {:?} from {:?}", kind, source);
/// }
///
/// fn main() {
///     VectorBaseAddressRegister::set(
///         ExceptionLevel::One,
///         unsafe { &exception_table_el1 }
///     );
/// }
/// ```
#[macro_export]
macro_rules! aarch64_exception_vector_table {
    [$table:ident, $handler:path] => {
        extern "C" {
            #[no_mangle]
            static $table: $crate::aarch64::interrupt::VectorTable;
        }

        core::arch::global_asm!(concat!(
            "
            //
            // Exceptions from current level using SP_EL0 (thread mode)

            .balign 0x800
        ", stringify!($table), ":
            // Synchronous exception
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_sync_exception_from_thread
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_interrupt_from_thread
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Fast interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_fast_interrupt_from_thread
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // System error
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_system_error_from_thread
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            //
            // Exceptions from current level using current-level SP (handler mode)

            .balign 0x80
            // Synchronous exception
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_sync_exception_from_handler
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_interrupt_from_handler
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Fast interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_fast_interrupt_from_handler
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // System error
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_system_error_from_handler
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            //
            // Exceptions from lower level in 64-bit mode

            .balign 0x80
            // Synchronous exception
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_sync_exception_from_lower
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_interrupt_from_lower
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Fast interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_fast_interrupt_from_lower
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // System error
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_system_error_from_lower
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            //
            // Exceptions from lower level in 32-bit mode

            .balign 0x80
            // Synchronous exception
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_sync_exception_from_lower_32bit
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_interrupt_from_lower_32bit
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // Fast interrupt
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_fast_interrupt_from_lower_32bit
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret

            .balign 0x80
            // System error
            stp lr, fp, [sp, #-16]!
            bl ", stringify!($table), "_save
            bl ", stringify!($table), "_system_error_from_lower_32bit
            bl ", stringify!($table), "_restore
            ldp lr, fp, [sp], #16
            eret


        ", stringify!($table), "_save:
            stp x0, x1, [sp, #-16]!
            stp x2, x3, [sp, #-16]!
            stp x4, x5, [sp, #-16]!
            stp x6, x7, [sp, #-16]!
            stp x8, x9, [sp, #-16]!
            stp x10, x11, [sp, #-16]!
            stp x12, x13, [sp, #-16]!
            stp x14, x15, [sp, #-16]!

        ", stringify!($table), "_restore:
            ldp x14, x15, [sp], #16
            ldp x12, x13, [sp], #16
            ldp x10, x11, [sp], #16
            ldp x8, x9, [sp], #16
            ldp x6, x7, [sp], #16
            ldp x4, x5, [sp], #16
            ldp x2, x3, [sp], #16
            ldp x0, x1, [sp], #16
            "
        ));

        $crate::aarch64::interrupt::paste! {
            #[no_mangle]
            fn [< $table _sync_exception_from_thread >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Synchronous,
                    $crate::aarch64::interrupt::Source::CurrentLevelThread,
                )
            }

            #[no_mangle]
            fn [< $table _interrupt_from_thread >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Interrupt,
                    $crate::aarch64::interrupt::Source::CurrentLevelThread,
                )
            }

            #[no_mangle]
            fn [< $table _fast_interrupt_from_thread >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::FastInterrupt,
                    $crate::aarch64::interrupt::Source::CurrentLevelThread,
                )
            }

            #[no_mangle]
            fn [< $table _system_error_from_thread >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::SystemError,
                    $crate::aarch64::interrupt::Source::CurrentLevelThread,
                )
            }

            #[no_mangle]
            fn [< $table _sync_exception_from_handler >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Synchronous,
                    $crate::aarch64::interrupt::Source::CurrentLevelHandler,
                )
            }

            #[no_mangle]
            fn [< $table _interrupt_from_handler >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Interrupt,
                    $crate::aarch64::interrupt::Source::CurrentLevelHandler,
                )
            }

            #[no_mangle]
            fn [< $table _fast_interrupt_from_handler >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::FastInterrupt,
                    $crate::aarch64::interrupt::Source::CurrentLevelHandler,
                )
            }

            #[no_mangle]
            fn [< $table _system_error_from_handler >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::SystemError,
                    $crate::aarch64::interrupt::Source::CurrentLevelHandler,
                )
            }

            #[no_mangle]
            fn [< $table _sync_exception_from_lower >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Synchronous,
                    $crate::aarch64::interrupt::Source::LowerLevel,
                )
            }

            #[no_mangle]
            fn [< $table _interrupt_from_lower >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Interrupt,
                    $crate::aarch64::interrupt::Source::LowerLevel,
                )
            }

            #[no_mangle]
            fn [< $table _fast_interrupt_from_lower >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::FastInterrupt,
                    $crate::aarch64::interrupt::Source::LowerLevel,
                )
            }

            #[no_mangle]
            fn [< $table _system_error_from_lower >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::SystemError,
                    $crate::aarch64::interrupt::Source::LowerLevel,
                )
            }

            #[no_mangle]
            fn [< $table _sync_exception_from_lower_32bit >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Synchronous,
                    $crate::aarch64::interrupt::Source::LowerLevel32Bit,
                )
            }

            #[no_mangle]
            fn [< $table _interrupt_from_lower_32bit >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::Interrupt,
                    $crate::aarch64::interrupt::Source::LowerLevel32Bit,
                )
            }

            #[no_mangle]
            fn [< $table _fast_interrupt_from_lower_32bit >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::FastInterrupt,
                    $crate::aarch64::interrupt::Source::LowerLevel32Bit,
                )
            }

            #[no_mangle]
            fn [< $table _system_error_from_lower_32bit >]() {
                $handler(
                    $crate::aarch64::interrupt::Kind::SystemError,
                    $crate::aarch64::interrupt::Source::LowerLevel32Bit,
                )
            }
        }
    };
}

/// The kind of exception being handled: sync, IRQ, FIQ, SError.
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Kind {
    /// A standard exception traceable to a specific instruction.
    Synchronous,
    /// An external interrupt (IRQ).
    Interrupt,
    /// An external interrupt through the higher-priority fast interrupt (FIQ) mechanism.
    FastInterrupt,
    /// An internal error with the processor (SError).
    SystemError,
}

/// The exception level that generated an exception.
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Source {
    /// Exception from current level using SP_EL0 (thread mode)
    CurrentLevelThread,
    /// Exception from current level using current-level SP (handler mode)
    CurrentLevelHandler,
    /// Exception from lower level (e.g., EL0) in 64-bit mode
    LowerLevel,
    /// Exception from lower level (e.g., EL0) in 32-bit mode
    LowerLevel32Bit,
}


/// A single entry in the exception [`VectorTable`].
///
/// The bytes of the entry are interpreted as instructions and executed when an exception
/// of the corresponding [`Kind`] + [`Source`] is encountered. Consequently, it isn't
/// useful to instantiate this type directly. Use [`aarch64_exception_vector_table`]
/// instead.
#[repr(align(0x80))]
#[allow(dead_code)]
pub struct VectorEntry([u8; 0x80]);


/// Exception vector table that contains code to handle exceptions from each combination
/// of [`Kind`] and [`Source`].
#[repr(align(0x800))]
#[allow(dead_code)]
pub struct VectorTable([VectorEntry; 16]);


/// `VBAR_ELx`: Contains the address of the [`VectorTable`] that the processor should use
/// at a given exception level.
pub enum VectorBaseAddressRegister {}

impl VectorBaseAddressRegister {
    /// Retrieve the current value of this register for the specified exception level.
    ///
    /// Only defined for exception levels 1–3. The register for a given exception level is
    /// only accessible from that level or higher.
    pub fn get(level: ExceptionLevel) -> *const VectorTable {
        let mut value: *const VectorTable;
        unsafe {
            match level {
                ExceptionLevel::Zero => panic!("This register does not exist for EL0"),
                ExceptionLevel::One => asm!("mrs {}, vbar_el1", out(reg) value),
                ExceptionLevel::Two => asm!("mrs {}, vbar_el2", out(reg) value),
                ExceptionLevel::Three => asm!("mrs {}, vbar_el3", out(reg) value),
            }
        }
        value
    }

    /// Update the register for the specified exception level with the given value.
    ///
    /// Address must be aligned to 11 bits (2048).
    pub fn set(level: ExceptionLevel, value: *const VectorTable) {
        unsafe {
            match level {
                ExceptionLevel::Zero => panic!("This register does not exist for EL0"),
                ExceptionLevel::One => asm!("msr vbar_el1, {}", in(reg) value),
                ExceptionLevel::Two => asm!("msr vbar_el2, {}", in(reg) value),
                ExceptionLevel::Three => asm!("msr vbar_el3, {}", in(reg) value),
            }
        }
    }
}


bitfield! {
    /// `DAIF`: Controls masking of different kinds of exceptions.
    pub struct MaskRegister(u64) {
        /// `F`: Mask fast (FIQ) interrupts.
        [6] pub fast_interrupts_masked,
        /// `I`: Mask regular (IRQ) interrupts.
        [7] pub interrupts_masked,
        /// `A`: Mask system error (SError) exceptions.
        [8] pub system_error_masked,
        /// `D`: Mask debugging-related exceptions (breakpoints, watchpoints, stepping)
        /// for the current exception level.
        [9] pub debug_masked,
    }
}

system_register_access!(MaskRegister, "DAIF");


bitfield! {
    /// `ESR_ELx`: Holds information about the cause of the exception currently being
    /// handled.
    pub struct SyndromeRegister(u64) {
        /// `EC`: The class of exception that was triggered.
        [26..32] pub class: u8 as Class,
        /// `IL`: When set, indicates that the instruction that triggered this exception
        /// was a 32-bit opcode (A64 or classic Arm). Otherwise, the opcode was 16 bits
        /// (Thumb).
        [25] pub length_32bit,
        /// `ISS`: Additional data about the exception in a format that is specific to
        /// the [`class`](Self::class) value.
        [ 0..25] pub class_data: u32,
    }
}

impl SyndromeRegister {
    /// Retrieve the current value of this register for the specified exception level.
    ///
    /// Only defined for exception levels 1–3. The register for a given exception level is
    /// only accessible from that level or higher.
    pub fn get(level: ExceptionLevel) -> Self {
        let mut value = Self(0);
        unsafe {
            match level {
                ExceptionLevel::Zero => panic!("This register does not exist for EL0"),
                ExceptionLevel::One => asm!("mrs {}, esr_el1", out(reg) value.0),
                ExceptionLevel::Two => asm!("mrs {}, esr_el2", out(reg) value.0),
                ExceptionLevel::Three => asm!("mrs {}, esr_el3", out(reg) value.0),
            }
        }
        value
    }

    /// Update the register for the specified exception level with the given value.
    pub fn set(level: ExceptionLevel, value: Self) {
        unsafe {
            match level {
                ExceptionLevel::Zero => panic!("This register does not exist for EL0"),
                ExceptionLevel::One => asm!("msr esr_el1, {}", in(reg) value.0),
                ExceptionLevel::Two => asm!("msr esr_el2, {}", in(reg) value.0),
                ExceptionLevel::Three => asm!("msr esr_el3, {}", in(reg) value.0),
            }
        }
    }
}


c_enum! {
    /// Classifies different exception causes.
    ///
    /// Note that the Arm documentation defines more variants than are defined in this
    /// type. This only includes exception classes that can be triggered from Aarch64
    /// state and taken to EL1.
    pub enum Class(u8) {
        /// Tried to execute an undefined/unsupported opcode, or for any other reason that
        /// does not fall under another exception class.
        Unknown                     = 0b00_0000,
        /// Trapped execution of a wait instruction (`WFE`/`WFI`).
        Wait                        = 0b00_0001,
        /// Trapped access to a FPU/vector register or instruction.
        FPUAccess                   = 0b00_0111,
        /// Tried to execute instructions after an illegal return.
        IllegalState                = 0b00_1110,
        /// Triggered a system call via the `SVC` instruction.
        SupervisorCall              = 0b01_0101,
        /// Trapped access to a system register or instruction.
        SystemInstruction           = 0b01_1000,
        /// Trapped access to a vector register or instruction.
        VectorAccess                = 0b01_1001,
        /// Improperly authenticated pointer detected. Requires `FEAT_FPAC`.
        PointerAuthFailure          = 0b01_1100,
        /// Instruction abort triggered at lower exception level.
        InstructionAbortFromLower   = 0b10_0000,
        /// Instruction abort triggered at current exception level.
        InstructionAbortFromCurrent = 0b10_0001,
        /// Program counter not properly aligned.
        PCAlignment                 = 0b10_0010,
        /// Data abort triggered at lower exception level.
        DataAbortFromLower          = 0b10_0100,
        /// Data abort triggered at current exception level.
        DataAbortFromCurrent        = 0b10_0101,
        /// Stack pointer not properly aligned.
        SPAlignment                 = 0b10_0110,
        /// Trapped floating point exception.
        FloatException              = 0b10_1100,
        /// System error (SError).
        SystemError                 = 0b10_1111,
        /// Breakpoint triggered at lower exception level.
        BreakpointFromLower         = 0b11_0000,
        /// Breakpoint triggered at current exception level.
        BreakpointFromCurrent       = 0b11_0001,
        /// Software step at lower exception level.
        StepFromLower               = 0b11_0010,
        /// Software step at current exception level.
        StepFromCurrent             = 0b11_0011,
        /// Watchpoint triggered at lower exception level.
        WatchpointFromLower         = 0b11_0100,
        /// Watchpoint triggered at current exception level.
        WatchpointFromCurrent       = 0b11_0101,
        /// Executed a `BRK` breakpoint instruction.
        BreakpointInstruction       = 0b11_1100,
    }
}