motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-27 04:13:53 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

rust: cell: add full example of declaring a SysBusDevice

Browse source 
Reviewed-by: Zhao Liu <zhao1.liu@intel.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
Paolo Bonzini 2025-02-14 14:10:38 +01:00
parent 519088b7cf
commit 5778ce9997
1 changed files with 28 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

28
rust/qemu-api/src/cell.rs
View file

@ -73,6 +73,34 @@
//! QEMU device implementations is usually incorrect and can lead to
//! thread-safety issues.
//!
//! ### Example
//!
//! ```
//! # use qemu_api::prelude::*;
//! # use qemu_api::{c_str, cell::BqlRefCell, irq::InterruptSource, irq::IRQState};
//! # use qemu_api::{sysbus::SysBusDevice, qom::Owned, qom::ParentField};
//! # const N_GPIOS: usize = 8;
//! # struct PL061Registers { /* ... */ }
//! # unsafe impl ObjectType for PL061State {
//! # type Class = <SysBusDevice as ObjectType>::Class;
//! # const TYPE_NAME: &'static std::ffi::CStr = c_str!("pl061");
//! # }
//! struct PL061State {
//! parent_obj: ParentField<SysBusDevice>,
//!
//! // Configuration is read-only after initialization
//! pullups: u32,
//! pulldowns: u32,
//!
//! // Single values shared with C code use BqlCell, in this case via InterruptSource
//! out: [InterruptSource; N_GPIOS],
//! interrupt: InterruptSource,
//!
//! // Larger state accessed by device methods uses BqlRefCell or Mutex
//! registers: BqlRefCell<PL061Registers>,
//! }
//! ```
//!
//! ### `BqlCell<T>`
//!
//! [`BqlCell<T>`] implements interior mutability by moving values in and out of