SBI 标准的 Rust 实现

这个库用 Rust 实现了 SBI 标准定义的常量和结构。

2.0 标准各章节的实现情况：

• §3
  • [x] 常量
  • [x] 结构
• §4
  • [x] 常量
• §5
  • [x] 常量
• §6
  • [x] 常量
• §7
  • [x] 常量
• §8
  • [x] 常量
• §9
  • [x] 常量
• §10
  • [x] 常量
• §11
  • [x] 常量
• §12
  • [x] 常量
• §13
  • [x] 常量
• §14
  • [x] 常量
• §15
  • [x] 常量
• §16
  • [x] 常量

安装

在项目目录中运行以下 Cargo 命令：

cargo add sbi-spec

或者在 Cargo.toml 中添加以下行：

sbi-spec = "0.0.8"

使用示例

下面是一个使用 sbi-spec 库的完整示例代码：

use sbi_spec::{
    binary::SbiRet,
    legacy::console::*,
    rfnc::*,
    time::*,
};

// 实现SBI接口的结构体
struct MySbiImpl;

impl SbiConsole for MySbiImpl {
    fn console_putchar(ch: u8) -> SbiRet {
        // 实现字符输出逻辑
        unsafe { core::ptr::write_volatile(0x10000000 as *mut u8, ch) };
        SbiRet::ok(0)
    }
}

impl SbiTimer for MySbiImpl {
    fn set_timer(time: u64) -> SbiRet {
        // 实现定时器设置逻辑
        SbiRet::ok(0)
    }
}

impl SbiRfnc for MySbiImpl {
    fn probe_feature(fid: usize) -> SbiRet {
        // 实现功能探测
        SbiRet::ok(0)
    }
    
    fn get_spec_version() -> SbiRet {
        // 返回SBI规范版本
        SbiRet::ok(0x200) // 2.0版本
    }
    
    fn get_impl_id() -> SbiRet {
        // 返回实现ID
        SbiRet::ok(0x1234) // 自定义ID
    }
    
    fn get_impl_version() -> SbiRet {
        // 返回实现版本
        SbiRet::ok(0x1) // 版本1
    }
}

fn main() {
    // 调用SBI接口示例
    let ret = MySbiImpl::console_putchar(b'A');
    if !ret.is_ok() {
        panic!("Failed to putchar");
    }
    
    let version = MySbiImpl::get_spec_version();
    println!("SBI spec version: 0x{:x}", version.value);
    
    let timer_ret = MySbiImpl::set_timer(1000000);
    if !timer_ret.is_ok() {
        panic!("Failed to set timer");
    }
}

完整示例

以下是一个更完整的 SBI 实现示例，展示了如何实现多个 SBI 扩展功能：

use sbi_spec::{
    binary::SbiRet,
    legacy::console::*,
    rfnc::*,
    time::*,
    hsm::*,
    ipi::*,
};

// 完整的SBI实现结构体
struct FullSbiImplementation;

// 实现控制台扩展
impl SbiConsole for FullSbiImplementation {
    fn console_putchar(ch: u8) -> SbiRet {
        // 模拟写入串口
        unsafe { core::ptr::write_volatile(0x10000000 as *mut u8, ch) };
        SbiRet::ok(0)
    }
    
    fn console_getchar() -> SbiRet {
        // 模拟从串口读取
        let ch = unsafe { core::ptr::read_volatile(0x10000000 as *const u8) };
        SbiRet::ok(ch as usize)
    }
}

// 实现定时器扩展
impl SbiTimer for FullSbiImplementation {
    fn set_timer(time: u64) -> SbiRet {
        // 设置硬件定时器
        unsafe { core::ptr::write_volatile(0x2000000 as *mut u64, time) };
        SbiRet::ok(0)
    }
}

// 实现RFNC(基础功能)扩展
impl SbiRfnc for FullSbiImplementation {
    fn probe_feature(fid: usize) -> SbiRet {
        // 检查支持的功能
        match fid {
            0 => SbiRet::ok(1),  // 支持基础功能
            _ => SbiRet::not_supported()
        }
    }
    
    fn get_spec_version() -> SbiRet {
        SbiRet::ok(0x200) // SBI 2.0
    }
    
    fn get_impl_id() -> SbiRet {
        SbiRet::ok(0x1) // 自定义实现ID
    }
    
    fn get_impl_version() -> SbiRet {
        SbiRet::ok(0x1) // 实现版本1
    }
}

// 实现HSM(硬件状态管理)扩展
impl SbiHsm for FullSbiImplementation {
    fn hart_start(hartid: usize, start_addr: usize, opaque: usize) -> SbiRet {
        // 启动指定的hart
        SbiRet::ok(0)
    }
    
    fn hart_stop() -> SbiRet {
        // 停止当前hart
        SbiRet::ok(0)
    }
    
    fn hart_get_status(hartid: usize) -> SbiRet {
        // 获取hart状态
        SbiRet::ok(0) // 假设总是运行状态
    }
}

// 实现IPI(处理器间中断)扩展
impl SbiIpi for FullSbiImplementation {
    fn send_ipi(hart_mask: usize, hart_mask_base: usize) -> SbiRet {
        // 发送IPI到指定hart
        SbiRet::ok(0)
    }
}

fn main() {
    // 测试控制台功能
    println!("Testing console...");
    let put_ret = FullSbiImplementation::console_putchar(b'H');
    assert!(put_ret.is_ok());
    
    // 测试RFNC功能
    println!("Testing RFNC...");
    let version = FullSbiImplementation::get_spec_version();
    println!("SBI version: 0x{:x}", version.value);
    
    // 测试定时器功能
    println!("Testing timer...");
    let timer_ret = FullSbiImplementation::set_timer(1000000);
    assert!(timer_ret.is_ok());
    
    // 测试HSM功能
    println!("Testing HSM...");
    let status = FullSbiImplementation::hart_get_status(0);
    println!("Hart 0 status: {}", status.value);
    
    println!("All tests passed!");
}

许可证

该项目采用 MulanPSL-2.0 OR MIT 双许可证