Adding `axklib` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add axklib

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

axklib = "0.2.0"

The axklib library will be automatically available globally. Read the axklib library documentation.

Back to the crate overview.

Readme

axklib

axklib — Small kernel-helper abstractions used across the ArceOS microkernel.

Overview

This crate exposes a tiny, no_std-compatible trait (Klib) that the platform/board layer must implement. The trait provides a handful of common kernel helpers such as:

Memory mapping helpers
Timing utilities (busy-wait)
IRQ registration and enabling/disabling

The implementation is typically supplied by the platform layer (e.g., modules/axklib-impl) and consumed by drivers and other modules.

The crate also provides small convenience modules (mem, time, irq) that re-export the trait methods with shorter names to make call sites more ergonomic.

Usage

Add this to your Cargo.toml:

[dependencies]
axklib = "0.2.0"

Example

// 1. Map 4K of device MMIO at physical address `paddr`
// Returns axerrno::AxResult<VirtAddr>
let vaddr = axklib::mem::iomap(paddr, 0x1000)?;

// 2. Busy-wait for 100 microseconds
axklib::time::busy_wait(core::time::Duration::from_micros(100));

// 3. Register an IRQ handler
// Returns bool indicating success
axklib::irq::register(32, my_irq_handler);

fn my_irq_handler() {
    // Handle interrupt...
}

License

Axklib is licensed under the Apache License, Version 2.0. See the LICENSE file for details.

Adding axklib library as a dependency

Adding `axklib` library as a dependency