mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_MAX32630FTHR/TOOLCHAIN_ARM_STD/mxc_errors.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

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