1 /* 2 * Copyright (c) 2023, 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 has helper functions to convert internal state representations 32 * to string (useful for APIs). 33 */ 34 #ifndef OTBR_COMMON_API_STRINGS_HPP_ 35 #define OTBR_COMMON_API_STRINGS_HPP_ 36 37 #include "openthread-br/config.h" 38 39 #include <string> 40 41 #include <openthread/border_routing.h> 42 #include <openthread/thread.h> 43 44 #define OTBR_ROLE_NAME_DISABLED "disabled" 45 #define OTBR_ROLE_NAME_DETACHED "detached" 46 #define OTBR_ROLE_NAME_CHILD "child" 47 #define OTBR_ROLE_NAME_ROUTER "router" 48 #define OTBR_ROLE_NAME_LEADER "leader" 49 50 #if OTBR_ENABLE_DHCP6_PD 51 #define OTBR_DHCP6_PD_STATE_NAME_DISABLED "disabled" 52 #define OTBR_DHCP6_PD_STATE_NAME_STOPPED "stopped" 53 #define OTBR_DHCP6_PD_STATE_NAME_RUNNING "running" 54 #endif 55 56 std::string GetDeviceRoleName(otDeviceRole aRole); 57 58 #if OTBR_ENABLE_DHCP6_PD 59 std::string GetDhcp6PdStateName(otBorderRoutingDhcp6PdState aDhcp6PdState); 60 #endif // OTBR_ENABLE_DHCP6_PD 61 62 #endif // OTBR_COMMON_API_STRINGS_HPP_ 63