axdevice 0.5.6

A reusable, OS-agnostic device abstraction layer designed for virtual machines.
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

// Copyright 2025 The Axvisor Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![no_std]

//! This module is designed for an environment where the standard library is not available (`no_std`).
//!
//! The `alloc` crate is used to enable dynamic memory allocation in the absence of the standard library.
//!
//! The `log` crate is included for logging purposes, with macros being imported globally.
//!
//! The module is structured into two main parts: `config` and `device`, which manage the configuration and handling of AxVm devices respectively.

extern crate alloc;
#[macro_use]
extern crate log;

mod device;
mod error;
mod factory;
mod fw_cfg;
// Keep the LoongArch-only implementation out of other production targets, but
// compile its unit tests on the host so output-port behavior is covered by CI.
#[cfg(any(target_arch = "loongarch64", test))]
#[cfg_attr(test, allow(dead_code))]
mod loongarch_pch_pic;
mod range_alloc;
mod registration;
mod service;
#[cfg(target_arch = "x86_64")]
mod x86;

pub use axdevice_base::{AccessWidth, Device, Port, SysRegAddr};
pub use axvm_types::GuestPhysAddr;
pub use device::{
    DeviceRuntime, RuntimeAccessPorts, StopAccessPort, TimerAccessPort, WakeAccessPort,
};
pub use error::{DeviceManagerError, DeviceManagerResult};
pub use factory::{
    DeviceBuildContext, DeviceFactory, DeviceFactoryRegistry, IrqResolver,
    register_builtin_factories,
};
pub use fw_cfg::{
    FwCfg, FwCfgAcpiBlobs, FwCfgBuildConfig, FwCfgDeviceFactory, FwCfgDmaDevice,
    FwCfgPayloadConfig, FwCfgPayloadFactory, FwCfgPlatformConfig, FwCfgRamRegion,
};
#[cfg(target_arch = "loongarch64")]
// Reusable LoongArch device models. These are target-gated device packages,
// not part of the architecture-neutral framework core.
pub use loongarch_pch_pic::{
    LoongArchPchPic, LoongArchPchPicFactory, PchPicOutputEvent, PchPicOutputPort,
    PchPicOutputPortKey,
};
pub use range_alloc::{GuestRangeAllocator, GuestRangeAllocatorKey};
pub use registration::{DeviceBundle, DeviceLifecycle, DeviceRegistration, PollableDeviceOps};
pub use service::{DeviceServices, ServiceCardinality, ServiceKey};
#[cfg(target_arch = "x86_64")]
// Reusable x86 device models and narrow typed services. These are target-gated
// device packages, not part of the architecture-neutral framework core.
pub use x86::{
    X86InterruptDomainKey, X86InterruptDomainOps, X86IoApicDevice, X86IoApicDeviceOps,
    X86IoApicServiceKey, X86PitDevice, X86PitDeviceOps, X86PitServiceKey, X86SerialDeviceOps,
    X86SerialPortDevice, X86SerialServiceKey,
};
#[cfg(target_arch = "x86_64")]
pub use x86_vlapic::IoApicInterrupt;
// pub use virtio_dev::*;