openthread/ot/
radio.rs

1// Copyright 2022 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
5use crate::prelude_internal::*;
6
7/// Methods from the [OpenThread "Radio" Module][1].
8///
9/// [1]: https://openthread.io/reference/group/radio-operation
10pub trait Radio {
11    /// Functional equivalent of
12    /// [`otsys::otPlatRadioGetCoexMetrics`](crate::otsys::otPlatRadioGetCoexMetrics).
13    fn get_coex_metrics(&self) -> Result<RadioCoexMetrics>;
14
15    /// Functional equivalent of
16    /// [`otsys::otPlatRadioGetRssi`](crate::otsys::otPlatRadioGetRssi).
17    fn get_rssi(&self) -> Decibels;
18
19    /// Functional equivalent of
20    /// [`otsys::otPlatRadioGetRegion`](crate::otsys::otPlatRadioGetRegion).
21    fn get_region(&self) -> Result<RadioRegion>;
22
23    /// Functional equivalent of
24    /// [`otsys::otPlatRadioSetRegion`](crate::otsys::otPlatRadioSetRegion).
25    fn set_region(&self, region: RadioRegion) -> Result;
26
27    /// Functional equivalent of
28    /// [`otsys::otPlatRadioGetTransmitPower`](crate::otsys::otPlatRadioGetTransmitPower).
29    fn get_transmit_power(&self) -> Result<Decibels>;
30
31    /// Functional equivalent of
32    /// [`otsys::otPlatRadioGetVersionString`](crate::otsys::otPlatRadioGetVersionString).
33    fn radio_get_version_string(&self) -> &str;
34}
35
36impl<T: Radio + Boxable> Radio for ot::Box<T> {
37    fn get_coex_metrics(&self) -> Result<RadioCoexMetrics> {
38        self.as_ref().get_coex_metrics()
39    }
40
41    fn get_rssi(&self) -> Decibels {
42        self.as_ref().get_rssi()
43    }
44
45    fn get_region(&self) -> Result<RadioRegion> {
46        self.as_ref().get_region()
47    }
48
49    fn set_region(&self, region: RadioRegion) -> Result {
50        self.as_ref().set_region(region)
51    }
52
53    fn get_transmit_power(&self) -> Result<Decibels> {
54        self.as_ref().get_transmit_power()
55    }
56
57    fn radio_get_version_string(&self) -> &str {
58        self.as_ref().radio_get_version_string()
59    }
60}
61
62impl Radio for Instance {
63    fn get_coex_metrics(&self) -> Result<RadioCoexMetrics> {
64        let mut ret = RadioCoexMetrics::default();
65        Error::from(unsafe { otPlatRadioGetCoexMetrics(self.as_ot_ptr(), ret.as_ot_mut_ptr()) })
66            .into_result()?;
67        Ok(ret)
68    }
69
70    fn get_rssi(&self) -> Decibels {
71        unsafe { otPlatRadioGetRssi(self.as_ot_ptr()) }
72    }
73
74    fn get_region(&self) -> Result<RadioRegion> {
75        let mut ret = 0u16;
76        Error::from(unsafe { otPlatRadioGetRegion(self.as_ot_ptr(), &mut ret as *mut u16) })
77            .into_result()?;
78        Ok(ret.into())
79    }
80
81    fn set_region(&self, region: RadioRegion) -> Result {
82        Error::from(unsafe { otPlatRadioSetRegion(self.as_ot_ptr(), region.into()) }).into()
83    }
84
85    fn get_transmit_power(&self) -> Result<Decibels> {
86        let mut ret = DECIBELS_UNSPECIFIED;
87        Error::from(unsafe {
88            otPlatRadioGetTransmitPower(self.as_ot_ptr(), &mut ret as *mut Decibels)
89        })
90        .into_result()?;
91        Ok(ret)
92    }
93
94    fn radio_get_version_string(&self) -> &str {
95        unsafe {
96            // SAFETY: `otPlatRadioGetVersionString` guarantees to return a C-String that will not
97            //         change.
98            CStr::from_ptr(otPlatRadioGetVersionString(self.as_ot_ptr()))
99                .to_str()
100                .expect("OpenThread version string was bad UTF8")
101        }
102    }
103}
openthread/ot/radio.rs

openthread/ot/
radio.rs
