diff options
| author | Paolo Bonzini <pbonzini@redhat.com> | 2025-02-14 14:10:38 +0100 |
|---|---|---|
| committer | Paolo Bonzini <pbonzini@redhat.com> | 2025-03-06 12:44:47 +0100 |
| commit | 5778ce99971f7e09952a1efbac91d0c97d7a0fee (patch) | |
| tree | 8fcb12735d9039abea1fe3f6fef541918d4b62e7 /rust/qemu-api/src | |
| parent | 519088b7cf6dbdef08d8753b57aa29162b83d1a1 (diff) | |
| download | qemu-5778ce99971f7e09952a1efbac91d0c97d7a0fee.zip qemu-5778ce99971f7e09952a1efbac91d0c97d7a0fee.tar.gz qemu-5778ce99971f7e09952a1efbac91d0c97d7a0fee.tar.bz2 | |
rust: cell: add full example of declaring a SysBusDevice
Reviewed-by: Zhao Liu <zhao1.liu@intel.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'rust/qemu-api/src')
| -rw-r--r-- | rust/qemu-api/src/cell.rs | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/rust/qemu-api/src/cell.rs b/rust/qemu-api/src/cell.rs index 448638e..ab0785a 100644 --- a/rust/qemu-api/src/cell.rs +++ b/rust/qemu-api/src/cell.rs @@ -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 |