1 //***************************************************************************** 2 // 3 //! @file am_hal_status.h 4 //! 5 //! @brief Global status return codes for HAL interface. 6 //! 7 //! @addtogroup status3_4p Status - Global Status Return Codes. 8 //! @ingroup apollo4p_hal 9 //! @{ 10 // 11 //***************************************************************************** 12 13 //***************************************************************************** 14 // 15 // Copyright (c) 2023, Ambiq Micro, Inc. 16 // All rights reserved. 17 // 18 // Redistribution and use in source and binary forms, with or without 19 // modification, are permitted provided that the following conditions are met: 20 // 21 // 1. Redistributions of source code must retain the above copyright notice, 22 // this list of conditions and the following disclaimer. 23 // 24 // 2. Redistributions in binary form must reproduce the above copyright 25 // notice, this list of conditions and the following disclaimer in the 26 // documentation and/or other materials provided with the distribution. 27 // 28 // 3. Neither the name of the copyright holder nor the names of its 29 // contributors may be used to endorse or promote products derived from this 30 // software without specific prior written permission. 31 // 32 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 33 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 34 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 35 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 36 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 37 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 38 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 39 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 40 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 41 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 42 // POSSIBILITY OF SUCH DAMAGE. 43 // 44 // This is part of revision release_sdk_4_4_0-3c5977e664 of the AmbiqSuite Development Package. 45 // 46 //***************************************************************************** 47 #ifndef AM_HAL_STATUS_H 48 #define AM_HAL_STATUS_H 49 50 #ifdef __cplusplus 51 extern "C" 52 { 53 #endif 54 55 // 56 //! Global Status Returns 57 // 58 typedef enum 59 { 60 AM_HAL_STATUS_SUCCESS, 61 AM_HAL_STATUS_FAIL, 62 AM_HAL_STATUS_INVALID_HANDLE, 63 AM_HAL_STATUS_IN_USE, 64 AM_HAL_STATUS_TIMEOUT, 65 AM_HAL_STATUS_OUT_OF_RANGE, 66 AM_HAL_STATUS_INVALID_ARG, 67 AM_HAL_STATUS_INVALID_OPERATION, 68 AM_HAL_STATUS_MEM_ERR, 69 AM_HAL_STATUS_HW_ERR, 70 AM_HAL_STATUS_MODULE_SPECIFIC_START = 0x08000000, 71 } am_hal_status_e; 72 73 #ifdef __cplusplus 74 } 75 #endif 76 77 #endif // AM_HAL_STATUS_H 78 79 //***************************************************************************** 80 // 81 // End Doxygen group. 82 //! @} 83 // 84 //***************************************************************************** 85 86
