fdf_component/
macros.rs

1// Copyright 2024 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5//! Implementation of the [`driver_register`] macro for registering driver implementations
6//! with the driver host.
7
8use crate::server::DriverServer;
9use crate::Driver;
10
11/// These re-exports are for the use of the macro and so should not be surfaced in documentation.
12#[doc(hidden)]
13pub use fdf_sys::{
14    fdf_dispatcher_get_current_dispatcher, DriverRegistration,
15    DriverRegistration_driver_registration_v1, DRIVER_REGISTRATION_VERSION_1,
16};
17
18/// Called by the macro [`driver_register`] to create the driver registration struct
19/// without exposing any of the internal implementation as a public API.
20#[doc(hidden)]
21pub const fn make_driver_registration<T: Driver>() -> DriverRegistration {
22    DriverRegistration {
23        version: DRIVER_REGISTRATION_VERSION_1 as u64,
24        v1: DriverRegistration_driver_registration_v1 {
25            initialize: Some(DriverServer::<T>::initialize),
26            destroy: Some(DriverServer::<T>::destroy),
27        },
28    }
29}
30
31/// Macro for declaring a driver's implementation of the [`Driver`] trait.
32///
33/// # Example
34///
35/// ```
36/// use fdf_server::{driver_register, Driver, DriverContext};
37/// use log::info;
38/// use zx::Status;
39///
40/// #[derive(Default)]
41/// struct TestDriver;
42///
43/// impl Driver for TestDriver {
44///     async fn start(context: DriverContext) -> Result<Self, Status> {
45///         info!("driver starting!");
46///         // implement binding the node client, creating children, etc. here.
47///         Ok(Self)
48///     }
49///     async fn stop(&self) {
50///         info!("driver stop message");
51///     }
52/// }
53///
54/// driver_register!(TestDriver);
55/// ```
56#[macro_export]
57macro_rules! driver_register {
58    ($ty:ty) => {
59        #[no_mangle]
60        #[link_section = ".driver_registration"]
61        #[allow(non_upper_case_globals)]
62        pub static __fuchsia_driver_registration__: $crate::macros::DriverRegistration =
63            $crate::macros::make_driver_registration::<$ty>();
64    };
65}
fdf_component/macros.rs

fdf_component/
macros.rs
