xref: /aosp_15_r20/external/ot-br-posix/src/dbus/common/constants.hpp (revision 4a64e381480ef79f0532b2421e44e6ee336b8e0d) 
1 /*
2  *    Copyright (c) 2020, The OpenThread Authors.
3  *    All rights reserved.
4  *
5  *    Redistribution and use in source and binary forms, with or without
6  *    modification, are permitted provided that the following conditions are met:
7  *    1. Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *    2. Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *    3. Neither the name of the copyright holder nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *    POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * This file includes definitions for d-bus server constants.
32  */
33 
34 #ifndef OTBR_DBUS_CONSTANTS_HPP_
35 #define OTBR_DBUS_CONSTANTS_HPP_
36 
37 #define DBUS_PROPERTY_GET_METHOD "Get"
38 #define DBUS_PROPERTY_SET_METHOD "Set"
39 #define DBUS_PROPERTY_GET_ALL_METHOD "GetAll"
40 #define DBUS_PROPERTIES_CHANGED_SIGNAL "PropertiesChanged"
41 #define DBUS_INTROSPECT_METHOD "Introspect"
42 
43 #define OTBR_DBUS_SERVER_PREFIX "io.openthread.BorderRouter."
44 #define OTBR_DBUS_THREAD_INTERFACE "io.openthread.BorderRouter"
45 #define OTBR_DBUS_OBJECT_PREFIX "/io/openthread/BorderRouter/"
46 
47 #define OTBR_DBUS_SCAN_METHOD "Scan"
48 #define OTBR_DBUS_ENERGY_SCAN_METHOD "EnergyScan"
49 #define OTBR_DBUS_ATTACH_METHOD "Attach"
50 #define OTBR_DBUS_DETACH_METHOD "Detach"
51 #define OTBR_DBUS_JOIN_METHOD "Join"
52 #define OTBR_DBUS_FACTORY_RESET_METHOD "FactoryReset"
53 #define OTBR_DBUS_RESET_METHOD "Reset"
54 #define OTBR_DBUS_ADD_ON_MESH_PREFIX_METHOD "AddOnMeshPrefix"
55 #define OTBR_DBUS_REMOVE_ON_MESH_PREFIX_METHOD "RemoveOnMeshPrefix"
56 #define OTBR_DBUS_PERMIT_UNSECURE_JOIN_METHOD "PermitUnsecureJoin"
57 #define OTBR_DBUS_JOINER_START_METHOD "JoinerStart"
58 #define OTBR_DBUS_JOINER_STOP_METHOD "JoinerStop"
59 #define OTBR_DBUS_ADD_EXTERNAL_ROUTE_METHOD "AddExternalRoute"
60 #define OTBR_DBUS_REMOVE_EXTERNAL_ROUTE_METHOD "RemoveExternalRoute"
61 #define OTBR_DBUS_ATTACH_ALL_NODES_TO_METHOD "AttachAllNodesTo"
62 #define OTBR_DBUS_UPDATE_VENDOR_MESHCOP_TXT_METHOD "UpdateVendorMeshCopTxtEntries"
63 #define OTBR_DBUS_GET_PROPERTIES_METHOD "GetProperties"
64 #define OTBR_DBUS_LEAVE_NETWORK_METHOD "LeaveNetwork"
65 #define OTBR_DBUS_SET_NAT64_ENABLED_METHOD "SetNat64Enabled"
66 #define OTBR_DBUS_ACTIVATE_EPHEMERAL_KEY_MODE_METHOD "ActivateEphemeralKeyMode"
67 #define OTBR_DBUS_DEACTIVATE_EPHEMERAL_KEY_MODE_METHOD "DeactivateEphemeralKeyMode"
68 #define OTBR_DBUS_SCHEDULE_MIGRATION_METHOD "ScheduleMigration"
69 
70 #define OTBR_DBUS_PROPERTY_MESH_LOCAL_PREFIX "MeshLocalPrefix"
71 #define OTBR_DBUS_PROPERTY_LINK_MODE "LinkMode"
72 #define OTBR_DBUS_PROPERTY_DEVICE_ROLE "DeviceRole"
73 #define OTBR_DBUS_PROPERTY_NETWORK_NAME "NetworkName"
74 #define OTBR_DBUS_PROPERTY_PANID "PanId"
75 #define OTBR_DBUS_PROPERTY_EXTPANID "ExtPanId"
76 #define OTBR_DBUS_PROPERTY_CHANNEL "Channel"
77 #define OTBR_DBUS_PROPERTY_NETWORK_KEY "NetworkKey"
78 #define OTBR_DBUS_PROPERTY_CCA_FAILURE_RATE "CcaFailureRate"
79 #define OTBR_DBUS_PROPERTY_LINK_COUNTERS "LinkCounters"
80 #define OTBR_DBUS_PROPERTY_IP6_COUNTERS "Ip6Counters"
81 #define OTBR_DBUS_PROPERTY_SUPPORTED_CHANNEL_MASK "LinkSupportedChannelMask"
82 #define OTBR_DBUS_PROPERTY_PREFERRED_CHANNEL_MASK "LinkPreferredChannelMask"
83 #define OTBR_DBUS_PROPERTY_RLOC16 "Rloc16"
84 #define OTBR_DBUS_PROPERTY_EXTENDED_ADDRESS "ExtendedAddress"
85 #define OTBR_DBUS_PROPERTY_ROUTER_ID "RouterID"
86 #define OTBR_DBUS_PROPERTY_LEADER_DATA "LeaderData"
87 #define OTBR_DBUS_PROPERTY_NETWORK_DATA_PRPOERTY "NetworkData"
88 #define OTBR_DBUS_PROPERTY_STABLE_NETWORK_DATA_PRPOERTY "StableNetworkData"
89 #define OTBR_DBUS_PROPERTY_LOCAL_LEADER_WEIGHT "LocalLeaderWeight"
90 #define OTBR_DBUS_PROPERTY_CHANNEL_MONITOR_SAMPLE_COUNT "ChannelMonitorSampleCount"
91 #define OTBR_DBUS_PROPERTY_CHANNEL_MONITOR_ALL_CHANNEL_QUALITIES "ChannelMonitorAllChannelQualities"
92 #define OTBR_DBUS_PROPERTY_CHILD_TABLE "ChildTable"
93 #define OTBR_DBUS_PROPERTY_NEIGHBOR_TABLE_PROEPRTY "NeighborTable"
94 #define OTBR_DBUS_PROPERTY_PARTITION_ID_PROEPRTY "PartitionID"
95 #define OTBR_DBUS_PROPERTY_INSTANT_RSSI "InstantRssi"
96 #define OTBR_DBUS_PROPERTY_RADIO_TX_POWER "RadioTxPower"
97 #define OTBR_DBUS_PROPERTY_EXTERNAL_ROUTES "ExternalRoutes"
98 #define OTBR_DBUS_PROPERTY_ON_MESH_PREFIXES "OnMeshPrefixes"
99 #define OTBR_DBUS_PROPERTY_ACTIVE_DATASET_TLVS "ActiveDatasetTlvs"
100 #define OTBR_DBUS_PROPERTY_PENDING_DATASET_TLVS "PendingDatasetTlvs"
101 #define OTBR_DBUS_PROPERTY_FEATURE_FLAG_LIST_DATA "FeatureFlagListData"
102 #define OTBR_DBUS_PROPERTY_RADIO_REGION "RadioRegion"
103 #define OTBR_DBUS_PROPERTY_SRP_SERVER_INFO "SrpServerInfo"
104 #define OTBR_DBUS_PROPERTY_TREL_INFO "TrelInfo"
105 #define OTBR_DBUS_PROPERTY_DNSSD_COUNTERS "DnssdCounters"
106 #define OTBR_DBUS_PROPERTY_OTBR_VERSION "OtbrVersion"
107 #define OTBR_DBUS_PROPERTY_OT_HOST_VERSION "OtHostVersion"
108 #define OTBR_DBUS_PROPERTY_OT_RCP_VERSION "OtRcpVersion"
109 #define OTBR_DBUS_PROPERTY_THREAD_VERSION "ThreadVersion"
110 #define OTBR_DBUS_PROPERTY_EUI64 "Eui64"
111 #define OTBR_DBUS_PROPERTY_MDNS_TELEMETRY_INFO "MdnsTelemetryInfo"
112 #define OTBR_DBUS_PROPERTY_RADIO_SPINEL_METRICS "RadioSpinelMetrics"
113 #define OTBR_DBUS_PROPERTY_RCP_INTERFACE_METRICS "RcpInterfaceMetrics"
114 #define OTBR_DBUS_PROPERTY_UPTIME "Uptime"
115 #define OTBR_DBUS_PROPERTY_RADIO_COEX_METRICS "RadioCoexMetrics"
116 #define OTBR_DBUS_PROPERTY_BORDER_ROUTING_COUNTERS "BorderRoutingCounters"
117 #define OTBR_DBUS_PROPERTY_NAT64_STATE "Nat64State"
118 #define OTBR_DBUS_PROPERTY_NAT64_CIDR "Nat64Cidr"
119 #define OTBR_DBUS_PROPERTY_NAT64_MAPPINGS "Nat64Mappings"
120 #define OTBR_DBUS_PROPERTY_NAT64_PROTOCOL_COUNTERS "Nat64ProtocolCounters"
121 #define OTBR_DBUS_PROPERTY_NAT64_ERROR_COUNTERS "Nat64ErrorCounters"
122 #define OTBR_DBUS_PROPERTY_EPHEMERAL_KEY_ENABLED "EphemeralKeyEnabled"
123 #define OTBR_DBUS_PROPERTY_INFRA_LINK_INFO "InfraLinkInfo"
124 #define OTBR_DBUS_PROPERTY_DNS_UPSTREAM_QUERY_STATE "DnsUpstreamQueryState"
125 #define OTBR_DBUS_PROPERTY_DHCP6_PD_STATE "Dhcp6PdState"
126 #define OTBR_DBUS_PROPERTY_TELEMETRY_DATA "TelemetryData"
127 #define OTBR_DBUS_PROPERTY_CAPABILITIES "Capabilities"
128 
129 #define OTBR_NAT64_STATE_NAME_DISABLED "disabled"
130 #define OTBR_NAT64_STATE_NAME_NOT_RUNNING "not_running"
131 #define OTBR_NAT64_STATE_NAME_IDLE "idle"
132 #define OTBR_NAT64_STATE_NAME_ACTIVE "active"
133 
134 #define OTBR_DBUS_SIGNAL_READY "Ready"
135 
136 #endif // OTBR_DBUS_CONSTANTS_HPP_
137