1 /** 2 * @file 3 * @brief List of common error return codes for Maxim Integrated libraries. 4 */ 5 /* **************************************************************************** 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved. 7 * 8 * Permission is hereby granted, free of charge, to any person obtaining a 9 * copy of this software and associated documentation files (the "Software"), 10 * to deal in the Software without restriction, including without limitation 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 12 * and/or sell copies of the Software, and to permit persons to whom the 13 * Software is furnished to do so, subject to the following conditions: 14 * 15 * The above copyright notice and this permission notice shall be included 16 * in all copies or substantial portions of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 24 * OTHER DEALINGS IN THE SOFTWARE. 25 * 26 * Except as contained in this notice, the name of Maxim Integrated 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated 28 * Products, Inc. Branding Policy. 29 * 30 * The mere transfer of this software does not imply any licenses 31 * of trade secrets, proprietary technology, copyrights, patents, 32 * trademarks, maskwork rights, or any other form of intellectual 33 * property whatsoever. Maxim Integrated Products, Inc. retains all 34 * ownership rights. 35 * 36 * $Date: 2018-08-09 18:45:02 -0500 (Thu, 09 Aug 2018) $ 37 * $Revision: 36818 $ 38 * 39 *************************************************************************** */ 40 41 /* Define to prevent redundant inclusion */ 42 #ifndef _MXC_ERRORS_H_ 43 #define _MXC_ERRORS_H_ 44 45 /** 46 * @ingroup syscfg 47 * @defgroup MXC_Error_Codes Error Codes 48 * @brief A list of common error codes used by the API. 49 * @note A Negative Error Convention is used to avoid conflict with 50 * positive, Non-Error, returns. 51 * @{ 52 */ 53 54 /** No Error */ 55 #define E_NO_ERROR 0 56 /** No Error, success */ 57 #define E_SUCCESS 0 58 /** Pointer is NULL */ 59 #define E_NULL_PTR -1 60 /** No such device */ 61 #define E_NO_DEVICE -2 62 /** Parameter not acceptable */ 63 #define E_BAD_PARAM -3 64 /** Value not valid or allowed */ 65 #define E_INVALID -4 66 /** Module not initialized */ 67 #define E_UNINITIALIZED -5 68 /** Busy now, try again later */ 69 #define E_BUSY -6 70 /** Operation not allowed in current state */ 71 #define E_BAD_STATE -7 72 /** Generic error */ 73 #define E_UNKNOWN -8 74 /** General communications error */ 75 #define E_COMM_ERR -9 76 /** Operation timed out */ 77 #define E_TIME_OUT -10 78 /** Expected response did not occur */ 79 #define E_NO_RESPONSE -11 80 /** Operations resulted in unexpected overflow */ 81 #define E_OVERFLOW -12 82 /** Operations resulted in unexpected underflow */ 83 #define E_UNDERFLOW -13 84 /** Data or resource not available at this time */ 85 #define E_NONE_AVAIL -14 86 /** Event was shutdown */ 87 #define E_SHUTDOWN -15 88 /** Event was aborted */ 89 #define E_ABORT -16 90 /** The requested operation is not supported */ 91 #define E_NOT_SUPPORTED -17 92 /**@} end of MXC_Error_Codes group */ 93 94 #endif /* _MXC_ERRORS_H_ */ 95