openthread/ot/types/
mod.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
5mod backbone_router_multicast_listener_event;
6mod backbone_router_multicast_listener_info;
7mod border_router_config;
8mod border_routing_counters;
9mod castable;
10mod channel_mask;
11mod device_role;
12mod dnssd_counters;
13mod ext_address;
14mod extended_pan_id;
15mod external_route_config;
16mod ip_counters;
17mod ipv6;
18mod leader_data;
19mod link_metrics;
20mod link_mode;
21mod log_region;
22mod mac_counters;
23mod nat64;
24mod neighbor_info;
25mod network_key;
26mod network_name;
27mod operational_dataset;
28mod packets_and_bytes;
29mod radio_coex_metrics;
30mod radio_region;
31mod resolver;
32mod route_preference;
33mod router_info;
34mod scan_results;
35mod security_policy;
36mod srp_server_lease_info;
37mod srp_server_response_counters;
38mod timestamp;
39mod tlv;
40mod trel;
41
42use crate::prelude_internal::*;
43
44pub use backbone_router_multicast_listener_event::*;
45pub use backbone_router_multicast_listener_info::*;
46pub use border_router_config::*;
47pub use border_routing_counters::*;
48pub use castable::*;
49pub use channel_mask::*;
50pub use device_role::*;
51pub use dnssd_counters::*;
52pub use ext_address::*;
53pub use extended_pan_id::*;
54pub use external_route_config::*;
55pub use ip_counters::*;
56pub use ipv6::*;
57pub use leader_data::*;
58pub use link_metrics::*;
59pub use link_mode::*;
60pub use log_region::*;
61pub use mac_counters::*;
62pub use nat64::*;
63pub use neighbor_info::*;
64pub use network_key::*;
65pub use network_name::*;
66pub use operational_dataset::*;
67pub use packets_and_bytes::*;
68pub use radio_coex_metrics::*;
69pub use radio_region::*;
70pub use resolver::*;
71pub use route_preference::*;
72pub use router_info::*;
73pub use scan_results::*;
74pub use security_policy::*;
75pub use srp_server_lease_info::*;
76pub use srp_server_response_counters::*;
77pub use timestamp::*;
78pub use tlv::*;
79pub use trel::*;
80
81/// 802.15.4 PAN Identifier. Same type as [`otsys::otPanId`](crate::otsys::otPanId).
82pub type PanId = otPanId;
83
84/// 802.15.4 Short Address. Same type as [`otsys::otShortAddress`](crate::otsys::otShortAddress).
85pub type ShortAddress = otShortAddress;
86
87/// Type for representing decibels, such as RSSI or transmit power.
88pub type Decibels = i8;
89
90/// Channel index value. Identifies an individual radio channel for transmitting and receiving.
91pub type ChannelIndex = u8;
92
93/// Mesh-Local Prefix.
94///
95/// Same type as [`Ip6NetworkPrefix`]. Functional equivalent of [`otsys::otMeshLocalPrefix`](crate::otsys::otMeshLocalPrefix).
96pub type MeshLocalPrefix = Ip6NetworkPrefix;
97
98/// Network Interface Identifier.
99pub type NetifIndex = u32;
100
101/// Unspecified network index.
102pub const NETIF_INDEX_UNSPECIFIED: NetifIndex = 0;
103
104/// Unspecified power
105pub const DECIBELS_UNSPECIFIED: Decibels = -128;
106
107/// The largest child ID supported by OpenThread, 511.
108pub const MAX_CHILD_ID: u16 = 0x1FF;
109
110/// The bit offset to the router ID in an RLOC16.
111pub const ROUTER_ID_OFFSET: usize = 9;
112
113/// Extracts the child ID from an RLOC16.
114pub fn rloc16_to_child_id(rloc16: u16) -> u16 {
115    rloc16 & MAX_CHILD_ID
116}
117
118/// Extracts the router ID from an RLOC16.
119pub fn rloc16_to_router_id(rloc16: u16) -> u8 {
120    (rloc16 >> ROUTER_ID_OFFSET) as u8
121}
openthread/ot/types/mod.rs

openthread/ot/types/
mod.rs
