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

openthread/ot/types/
mod.rs
