1 /* 2 * Copyright (c) 2024, 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 This file includes definitions for spinel helper methods. 31 */ 32 33 #ifndef SPINEL_HELPER_HPP_ 34 #define SPINEL_HELPER_HPP_ 35 36 #include <openthread/error.h> 37 38 #include "lib/spinel/spinel.h" 39 40 namespace ot { 41 namespace Spinel { 42 43 /** 44 * Convert the Spinel status code to OpenThread error code. 45 * 46 * @param[in] aStatus The Spinel status code. 47 * 48 * @retval OT_ERROR_NONE The operation has completed successfully. 49 * @retval OT_ERROR_DROP The packet was dropped. 50 * @retval OT_ERROR_NO_BUFS The operation has been prevented due to memory pressure. 51 * @retval OT_ERROR_BUSY The device is currently performing a mutuallyexclusive operation. 52 * @retval OT_ERROR_PARSE An error has occurred while parsing the command. 53 * @retval OT_ERROR_INVALID_ARGS An argument to the given operation is invalid. 54 * @retval OT_ERROR_NOT_IMPLEMENTED The given operation has not been implemented. 55 * @retval OT_ERROR_INVALID_STATE The given operation is invalid for the current state of the device. 56 * @retval OT_ERROR_NO_ACK The packet was not acknowledged. 57 * @retval OT_ERROR_NOT_FOUND The given property is not recognized. 58 * @retval OT_ERROR_FAILED The given operation has failed for some undefined reason. 59 * @retval OT_ERROR_CHANNEL_ACCESS_FAILURE The packet was not sent due to a CCA failure. 60 * @retval OT_ERROR_ALREADY The operation is already in progress or the property was already set 61 * to the given value. 62 */ 63 otError SpinelStatusToOtError(spinel_status_t aStatus); 64 65 } // namespace Spinel 66 } // namespace ot 67 68 #endif // SPINEL_HELPER_HPP_ 69
