mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

targets/cmsis/TARGET_Atmel/TARGET_SAM21/utils/status_codes.h@579:53297373a894, 2015-07-01 (annotated)

Committer:
mbed_official
Date:
Wed Jul 01 09:45:11 2015 +0100
Revision:
579:53297373a894
Child:
592:a274ee790e56
Synchronized with git revision d5b4d2ab9c47edb4dc5776e7177b0c2263459081



Full URL: https://github.com/mbedmicro/mbed/commit/d5b4d2ab9c47edb4dc5776e7177b0c2263459081/



Initial version of drivers for SAMR21

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 579:53297373a894 1 /**
mbed_official 579:53297373a894 2 * \file
mbed_official 579:53297373a894 3 *
mbed_official 579:53297373a894 4 * \brief Status code definitions.
mbed_official 579:53297373a894 5 *
mbed_official 579:53297373a894 6 * This file defines various status codes returned by functions,
mbed_official 579:53297373a894 7 * indicating success or failure as well as what kind of failure.
mbed_official 579:53297373a894 8 *
mbed_official 579:53297373a894 9 * Copyright (C) 2012-2014 Atmel Corporation. All rights reserved.
mbed_official 579:53297373a894 10 *
mbed_official 579:53297373a894 11 * \asf_license_start
mbed_official 579:53297373a894 12 *
mbed_official 579:53297373a894 13 * \page License
mbed_official 579:53297373a894 14 *
mbed_official 579:53297373a894 15 * Redistribution and use in source and binary forms, with or without
mbed_official 579:53297373a894 16 * modification, are permitted provided that the following conditions are met:
mbed_official 579:53297373a894 17 *
mbed_official 579:53297373a894 18 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 579:53297373a894 19 * this list of conditions and the following disclaimer.
mbed_official 579:53297373a894 20 *
mbed_official 579:53297373a894 21 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 579:53297373a894 22 * this list of conditions and the following disclaimer in the documentation
mbed_official 579:53297373a894 23 * and/or other materials provided with the distribution.
mbed_official 579:53297373a894 24 *
mbed_official 579:53297373a894 25 * 3. The name of Atmel may not be used to endorse or promote products derived
mbed_official 579:53297373a894 26 * from this software without specific prior written permission.
mbed_official 579:53297373a894 27 *
mbed_official 579:53297373a894 28 * 4. This software may only be redistributed and used in connection with an
mbed_official 579:53297373a894 29 * Atmel microcontroller product.
mbed_official 579:53297373a894 30 *
mbed_official 579:53297373a894 31 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
mbed_official 579:53297373a894 32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
mbed_official 579:53297373a894 33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
mbed_official 579:53297373a894 34 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
mbed_official 579:53297373a894 35 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 579:53297373a894 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
mbed_official 579:53297373a894 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
mbed_official 579:53297373a894 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
mbed_official 579:53297373a894 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
mbed_official 579:53297373a894 40 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
mbed_official 579:53297373a894 41 * POSSIBILITY OF SUCH DAMAGE.
mbed_official 579:53297373a894 42 *
mbed_official 579:53297373a894 43 * \asf_license_stop
mbed_official 579:53297373a894 44 *
mbed_official 579:53297373a894 45 */
mbed_official 579:53297373a894 46 /**
mbed_official 579:53297373a894 47 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
mbed_official 579:53297373a894 48 */
mbed_official 579:53297373a894 49
mbed_official 579:53297373a894 50 #ifndef STATUS_CODES_H_INCLUDED
mbed_official 579:53297373a894 51 #define STATUS_CODES_H_INCLUDED
mbed_official 579:53297373a894 52
mbed_official 579:53297373a894 53 #include <stdint.h>
mbed_official 579:53297373a894 54
mbed_official 579:53297373a894 55 /**
mbed_official 579:53297373a894 56 * \defgroup group_sam0_utils_status_codes Status Codes
mbed_official 579:53297373a894 57 *
mbed_official 579:53297373a894 58 * \ingroup group_sam0_utils
mbed_official 579:53297373a894 59 *
mbed_official 579:53297373a894 60 * @{
mbed_official 579:53297373a894 61 */
mbed_official 579:53297373a894 62
mbed_official 579:53297373a894 63 /** Mask to retrieve the error category of a status code. */
mbed_official 579:53297373a894 64 #define STATUS_CATEGORY_MASK 0xF0
mbed_official 579:53297373a894 65
mbed_official 579:53297373a894 66 /** Mask to retrieve the error code within the category of a status code. */
mbed_official 579:53297373a894 67 #define STATUS_ERROR_MASK 0x0F
mbed_official 579:53297373a894 68
mbed_official 579:53297373a894 69 /** Status code error categories. */
mbed_official 579:53297373a894 70 enum status_categories {
mbed_official 579:53297373a894 71 STATUS_CATEGORY_OK = 0x00,
mbed_official 579:53297373a894 72 STATUS_CATEGORY_COMMON = 0x10,
mbed_official 579:53297373a894 73 STATUS_CATEGORY_ANALOG = 0x30,
mbed_official 579:53297373a894 74 STATUS_CATEGORY_COM = 0x40,
mbed_official 579:53297373a894 75 STATUS_CATEGORY_IO = 0x50,
mbed_official 579:53297373a894 76 };
mbed_official 579:53297373a894 77
mbed_official 579:53297373a894 78 /**
mbed_official 579:53297373a894 79 * Status code that may be returned by shell commands and protocol
mbed_official 579:53297373a894 80 * implementations.
mbed_official 579:53297373a894 81 *
mbed_official 579:53297373a894 82 * \note Any change to these status codes and the corresponding
mbed_official 579:53297373a894 83 * message strings is strictly forbidden. New codes can be added,
mbed_official 579:53297373a894 84 * however, but make sure that any message string tables are updated
mbed_official 579:53297373a894 85 * at the same time.
mbed_official 579:53297373a894 86 */
mbed_official 579:53297373a894 87 enum status_code {
mbed_official 579:53297373a894 88 STATUS_OK = STATUS_CATEGORY_OK | 0x00,
mbed_official 579:53297373a894 89 STATUS_VALID_DATA = STATUS_CATEGORY_OK | 0x01,
mbed_official 579:53297373a894 90 STATUS_NO_CHANGE = STATUS_CATEGORY_OK | 0x02,
mbed_official 579:53297373a894 91 STATUS_ABORTED = STATUS_CATEGORY_OK | 0x04,
mbed_official 579:53297373a894 92 STATUS_BUSY = STATUS_CATEGORY_OK | 0x05,
mbed_official 579:53297373a894 93 STATUS_SUSPEND = STATUS_CATEGORY_OK | 0x06,
mbed_official 579:53297373a894 94
mbed_official 579:53297373a894 95 STATUS_ERR_IO = STATUS_CATEGORY_COMMON | 0x00,
mbed_official 579:53297373a894 96 STATUS_ERR_REQ_FLUSHED = STATUS_CATEGORY_COMMON | 0x01,
mbed_official 579:53297373a894 97 STATUS_ERR_TIMEOUT = STATUS_CATEGORY_COMMON | 0x02,
mbed_official 579:53297373a894 98 STATUS_ERR_BAD_DATA = STATUS_CATEGORY_COMMON | 0x03,
mbed_official 579:53297373a894 99 STATUS_ERR_NOT_FOUND = STATUS_CATEGORY_COMMON | 0x04,
mbed_official 579:53297373a894 100 STATUS_ERR_UNSUPPORTED_DEV = STATUS_CATEGORY_COMMON | 0x05,
mbed_official 579:53297373a894 101 STATUS_ERR_NO_MEMORY = STATUS_CATEGORY_COMMON | 0x06,
mbed_official 579:53297373a894 102 STATUS_ERR_INVALID_ARG = STATUS_CATEGORY_COMMON | 0x07,
mbed_official 579:53297373a894 103 STATUS_ERR_BAD_ADDRESS = STATUS_CATEGORY_COMMON | 0x08,
mbed_official 579:53297373a894 104 STATUS_ERR_BAD_FORMAT = STATUS_CATEGORY_COMMON | 0x0A,
mbed_official 579:53297373a894 105 STATUS_ERR_BAD_FRQ = STATUS_CATEGORY_COMMON | 0x0B,
mbed_official 579:53297373a894 106 STATUS_ERR_DENIED = STATUS_CATEGORY_COMMON | 0x0c,
mbed_official 579:53297373a894 107 STATUS_ERR_ALREADY_INITIALIZED = STATUS_CATEGORY_COMMON | 0x0d,
mbed_official 579:53297373a894 108 STATUS_ERR_OVERFLOW = STATUS_CATEGORY_COMMON | 0x0e,
mbed_official 579:53297373a894 109 STATUS_ERR_NOT_INITIALIZED = STATUS_CATEGORY_COMMON | 0x0f,
mbed_official 579:53297373a894 110
mbed_official 579:53297373a894 111 STATUS_ERR_SAMPLERATE_UNAVAILABLE = STATUS_CATEGORY_ANALOG | 0x00,
mbed_official 579:53297373a894 112 STATUS_ERR_RESOLUTION_UNAVAILABLE = STATUS_CATEGORY_ANALOG | 0x01,
mbed_official 579:53297373a894 113
mbed_official 579:53297373a894 114 STATUS_ERR_BAUDRATE_UNAVAILABLE = STATUS_CATEGORY_COM | 0x00,
mbed_official 579:53297373a894 115 STATUS_ERR_PACKET_COLLISION = STATUS_CATEGORY_COM | 0x01,
mbed_official 579:53297373a894 116 STATUS_ERR_PROTOCOL = STATUS_CATEGORY_COM | 0x02,
mbed_official 579:53297373a894 117
mbed_official 579:53297373a894 118 STATUS_ERR_PIN_MUX_INVALID = STATUS_CATEGORY_IO | 0x00,
mbed_official 579:53297373a894 119 };
mbed_official 579:53297373a894 120 typedef enum status_code status_code_genare_t;
mbed_official 579:53297373a894 121
mbed_official 579:53297373a894 122 /**
mbed_official 579:53297373a894 123 Status codes used by MAC stack.
mbed_official 579:53297373a894 124 */
mbed_official 579:53297373a894 125 enum status_code_wireless {
mbed_official 579:53297373a894 126 //STATUS_OK = 0, //!< Success
mbed_official 579:53297373a894 127 ERR_IO_ERROR = -1, //!< I/O error
mbed_official 579:53297373a894 128 ERR_FLUSHED = -2, //!< Request flushed from queue
mbed_official 579:53297373a894 129 ERR_TIMEOUT = -3, //!< Operation timed out
mbed_official 579:53297373a894 130 ERR_BAD_DATA = -4, //!< Data integrity check failed
mbed_official 579:53297373a894 131 ERR_PROTOCOL = -5, //!< Protocol error
mbed_official 579:53297373a894 132 ERR_UNSUPPORTED_DEV = -6, //!< Unsupported device
mbed_official 579:53297373a894 133 ERR_NO_MEMORY = -7, //!< Insufficient memory
mbed_official 579:53297373a894 134 ERR_INVALID_ARG = -8, //!< Invalid argument
mbed_official 579:53297373a894 135 ERR_BAD_ADDRESS = -9, //!< Bad address
mbed_official 579:53297373a894 136 ERR_BUSY = -10, //!< Resource is busy
mbed_official 579:53297373a894 137 ERR_BAD_FORMAT = -11, //!< Data format not recognized
mbed_official 579:53297373a894 138 ERR_NO_TIMER = -12, //!< No timer available
mbed_official 579:53297373a894 139 ERR_TIMER_ALREADY_RUNNING = -13, //!< Timer already running
mbed_official 579:53297373a894 140 ERR_TIMER_NOT_RUNNING = -14, //!< Timer not running
mbed_official 579:53297373a894 141
mbed_official 579:53297373a894 142 /**
mbed_official 579:53297373a894 143 * \brief Operation in progress
mbed_official 579:53297373a894 144 *
mbed_official 579:53297373a894 145 * This status code is for driver-internal use when an operation
mbed_official 579:53297373a894 146 * is currently being performed.
mbed_official 579:53297373a894 147 *
mbed_official 579:53297373a894 148 * \note Drivers should never return this status code to any
mbed_official 579:53297373a894 149 * callers. It is strictly for internal use.
mbed_official 579:53297373a894 150 */
mbed_official 579:53297373a894 151 OPERATION_IN_PROGRESS = -128,
mbed_official 579:53297373a894 152 };
mbed_official 579:53297373a894 153
mbed_official 579:53297373a894 154 typedef enum status_code_wireless status_code_t;
mbed_official 579:53297373a894 155
mbed_official 579:53297373a894 156 /** @} */
mbed_official 579:53297373a894 157
mbed_official 579:53297373a894 158 #endif /* STATUS_CODES_H_INCLUDED */