somehal 0.7.5

SomeHAL: A hardware abstraction layer for kernel development.
Documentation 
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

use arm_gic_driver::fdt_parse_irq_config;
use irq_framework::{IrqDomainId, IrqId};
use rdif_intc::{Intc, Interface};
use rdrive::Device;

mod its;
mod v2;
mod v3;

use core::sync::atomic::{AtomicU8, Ordering};

#[derive(Clone, Copy, Eq, PartialEq)]
enum GicBackend {
    None = 0,
    V2   = 2,
    V3   = 3,
}

static GIC_BACKEND: AtomicU8 = AtomicU8::new(GicBackend::None as u8);

fn set_backend(backend: GicBackend) {
    GIC_BACKEND.store(backend as u8, Ordering::Release);
}

fn backend() -> GicBackend {
    match GIC_BACKEND.load(Ordering::Acquire) {
        2 => GicBackend::V2,
        3 => GicBackend::V3,
        _ => GicBackend::None,
    }
}

pub fn init_current_cpu() {
    let cpu_idx = crate::cpu::current_cpu_idx()
        .unwrap_or_else(|| panic!("current logical CPU index is not available for GIC init"));
    init_cpu(cpu_idx);
}

pub fn init_cpu(cpu_idx: usize) {
    match backend() {
        GicBackend::V2 => v2::init_cpu(),
        GicBackend::V3 => v3::init_cpu(cpu_idx),
        GicBackend::None => {
            if v3::is_support_icc() {
                v3::init_cpu(cpu_idx);
            } else {
                v2::init_cpu();
            }
        }
    }
}

fn get_primary_gicd() -> Result<Device<Intc>, crate::irq::IrqError> {
    let domain = crate::irq::domain_by_kind_fast(crate::irq::IrqDomainKind::AArch64Gic)
        .ok_or(crate::irq::IrqError::Unsupported)?;
    crate::irq::intc_by_domain(domain)
}

pub fn with_gic_domain<T: Interface, R>(
    domain: IrqDomainId,
    f: impl FnOnce(&mut T) -> R,
) -> Result<R, crate::irq::IrqError> {
    let mut intc = crate::irq::intc_by_domain(domain)?
        .try_lock()
        .map_err(|_| crate::irq::IrqError::Busy)?;
    let gic = intc
        .typed_mut::<T>()
        .ok_or(crate::irq::IrqError::Unsupported)?;
    Ok(f(gic))
}

pub fn with_primary_gic<T: Interface, R>(
    f: impl FnOnce(&mut T) -> R,
) -> Result<R, crate::irq::IrqError> {
    let mut intc = get_primary_gicd()?
        .try_lock()
        .map_err(|_| crate::irq::IrqError::Busy)?;
    let gic = intc
        .typed_mut::<T>()
        .ok_or(crate::irq::IrqError::Unsupported)?;
    Ok(f(gic))
}

pub fn irq_set_enable(irq: IrqId, enable: bool) -> Result<(), crate::irq::IrqError> {
    match backend() {
        GicBackend::V2 => v2::irq_set_enable(irq, enable),
        GicBackend::V3 => v3::irq_set_enable(irq, enable),
        GicBackend::None => Err(crate::irq::IrqError::Unsupported),
    }
}

pub fn irq_set_affinity(
    irq: IrqId,
    affinity: crate::irq::IrqAffinity,
) -> Result<(), crate::irq::IrqError> {
    match backend() {
        GicBackend::V2 => v2::irq_set_affinity(irq, affinity),
        GicBackend::V3 => v3::irq_set_affinity(irq, affinity),
        GicBackend::None => {
            if v3::is_support_icc() {
                v3::irq_set_affinity(irq, affinity)
            } else {
                v2::irq_set_affinity(irq, affinity)
            }
        }
    }
}

pub fn setup_irq_by_fdt(cells: &[u32]) -> Result<rdif_intc::IrqTranslation, crate::irq::IrqError> {
    fdt_parse_irq_config(cells).map_err(|_| crate::irq::IrqError::InvalidIrq)?;
    let mut gic = rdrive::get_one::<Intc>()
        .ok_or(crate::irq::IrqError::Unsupported)?
        .lock()
        .map_err(|_| crate::irq::IrqError::Controller)?;
    let translation = gic.translate_fdt(cells)?;
    gic.configure(&translation)?;
    Ok(translation)
}

pub fn send_ipi(irq: rdrive::IrqId, target: crate::irq::IpiTarget) {
    let raw = irq.into();
    match backend() {
        GicBackend::V2 => v2::send_ipi(raw, target),
        GicBackend::V3 => v3::send_ipi(raw, target),
        GicBackend::None => {
            if v3::is_support_icc() {
                v3::send_ipi(raw, target);
            } else {
                v2::send_ipi(raw, target);
            }
        }
    }
}

fn hardware_cpu_id(cpu_idx: usize) -> usize {
    someboot::smp::cpu_idx_to_id(cpu_idx).unwrap_or(cpu_idx)
}

pub enum ActiveIrq {
    V2(v2::ActiveIrq),
    V3(v3::ActiveIrq),
}

impl ActiveIrq {
    pub fn id(&self) -> rdrive::IrqId {
        match self {
            Self::V2(active) => active.id(),
            Self::V3(active) => active.id(),
        }
    }
}

pub fn begin_irq() -> Option<ActiveIrq> {
    match backend() {
        GicBackend::V2 => v2::begin_irq().map(ActiveIrq::V2),
        GicBackend::V3 => v3::begin_irq().map(ActiveIrq::V3),
        GicBackend::None => {
            if v3::is_support_icc() {
                v3::begin_irq().map(ActiveIrq::V3)
            } else {
                v2::begin_irq().map(ActiveIrq::V2)
            }
        }
    }
}