Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbedtls/mbedtls/error.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbedAustin 11:cada08fc8a70 1 /**
mbedAustin 11:cada08fc8a70 2 * \file error.h
mbedAustin 11:cada08fc8a70 3 *
mbedAustin 11:cada08fc8a70 4 * \brief Error to string translation
mbedAustin 11:cada08fc8a70 5 *
mbedAustin 11:cada08fc8a70 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
mbedAustin 11:cada08fc8a70 7 * SPDX-License-Identifier: Apache-2.0
mbedAustin 11:cada08fc8a70 8 *
mbedAustin 11:cada08fc8a70 9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
mbedAustin 11:cada08fc8a70 10 * not use this file except in compliance with the License.
mbedAustin 11:cada08fc8a70 11 * You may obtain a copy of the License at
mbedAustin 11:cada08fc8a70 12 *
mbedAustin 11:cada08fc8a70 13 * http://www.apache.org/licenses/LICENSE-2.0
mbedAustin 11:cada08fc8a70 14 *
mbedAustin 11:cada08fc8a70 15 * Unless required by applicable law or agreed to in writing, software
mbedAustin 11:cada08fc8a70 16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
mbedAustin 11:cada08fc8a70 17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbedAustin 11:cada08fc8a70 18 * See the License for the specific language governing permissions and
mbedAustin 11:cada08fc8a70 19 * limitations under the License.
mbedAustin 11:cada08fc8a70 20 *
mbedAustin 11:cada08fc8a70 21 * This file is part of mbed TLS (https://tls.mbed.org)
mbedAustin 11:cada08fc8a70 22 */
mbedAustin 11:cada08fc8a70 23 #ifndef MBEDTLS_ERROR_H
mbedAustin 11:cada08fc8a70 24 #define MBEDTLS_ERROR_H
mbedAustin 11:cada08fc8a70 25
mbedAustin 11:cada08fc8a70 26 #include <stddef.h>
mbedAustin 11:cada08fc8a70 27
mbedAustin 11:cada08fc8a70 28 /**
mbedAustin 11:cada08fc8a70 29 * Error code layout.
mbedAustin 11:cada08fc8a70 30 *
mbedAustin 11:cada08fc8a70 31 * Currently we try to keep all error codes within the negative space of 16
mbedAustin 11:cada08fc8a70 32 * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In
mbedAustin 11:cada08fc8a70 33 * addition we'd like to give two layers of information on the error if
mbedAustin 11:cada08fc8a70 34 * possible.
mbedAustin 11:cada08fc8a70 35 *
mbedAustin 11:cada08fc8a70 36 * For that purpose the error codes are segmented in the following manner:
mbedAustin 11:cada08fc8a70 37 *
mbedAustin 11:cada08fc8a70 38 * 16 bit error code bit-segmentation
mbedAustin 11:cada08fc8a70 39 *
mbedAustin 11:cada08fc8a70 40 * 1 bit - Unused (sign bit)
mbedAustin 11:cada08fc8a70 41 * 3 bits - High level module ID
mbedAustin 11:cada08fc8a70 42 * 5 bits - Module-dependent error code
mbedAustin 11:cada08fc8a70 43 * 7 bits - Low level module errors
mbedAustin 11:cada08fc8a70 44 *
mbedAustin 11:cada08fc8a70 45 * For historical reasons, low-level error codes are divided in even and odd,
mbedAustin 11:cada08fc8a70 46 * even codes were assigned first, and -1 is reserved for other errors.
mbedAustin 11:cada08fc8a70 47 *
mbedAustin 11:cada08fc8a70 48 * Low-level module errors (0x0002-0x007E, 0x0003-0x007F)
mbedAustin 11:cada08fc8a70 49 *
mbedAustin 11:cada08fc8a70 50 * Module Nr Codes assigned
mbedAustin 11:cada08fc8a70 51 * MPI 7 0x0002-0x0010
mbedAustin 11:cada08fc8a70 52 * GCM 2 0x0012-0x0014
mbedAustin 11:cada08fc8a70 53 * BLOWFISH 2 0x0016-0x0018
mbedAustin 11:cada08fc8a70 54 * THREADING 3 0x001A-0x001E
mbedAustin 11:cada08fc8a70 55 * AES 2 0x0020-0x0022
mbedAustin 11:cada08fc8a70 56 * CAMELLIA 2 0x0024-0x0026
mbedAustin 11:cada08fc8a70 57 * XTEA 1 0x0028-0x0028
mbedAustin 11:cada08fc8a70 58 * BASE64 2 0x002A-0x002C
mbedAustin 11:cada08fc8a70 59 * OID 1 0x002E-0x002E 0x000B-0x000B
mbedAustin 11:cada08fc8a70 60 * PADLOCK 1 0x0030-0x0030
mbedAustin 11:cada08fc8a70 61 * DES 1 0x0032-0x0032
mbedAustin 11:cada08fc8a70 62 * CTR_DBRG 4 0x0034-0x003A
mbedAustin 11:cada08fc8a70 63 * ENTROPY 3 0x003C-0x0040 0x003D-0x003F
mbedAustin 11:cada08fc8a70 64 * NET 11 0x0042-0x0052 0x0043-0x0045
mbedAustin 11:cada08fc8a70 65 * ASN1 7 0x0060-0x006C
mbedAustin 11:cada08fc8a70 66 * PBKDF2 1 0x007C-0x007C
mbedAustin 11:cada08fc8a70 67 * HMAC_DRBG 4 0x0003-0x0009
mbedAustin 11:cada08fc8a70 68 * CCM 2 0x000D-0x000F
mbedAustin 11:cada08fc8a70 69 *
mbedAustin 11:cada08fc8a70 70 * High-level module nr (3 bits - 0x0...-0x7...)
mbedAustin 11:cada08fc8a70 71 * Name ID Nr of Errors
mbedAustin 11:cada08fc8a70 72 * PEM 1 9
mbedAustin 11:cada08fc8a70 73 * PKCS#12 1 4 (Started from top)
mbedAustin 11:cada08fc8a70 74 * X509 2 19
mbedAustin 11:cada08fc8a70 75 * PKCS5 2 4 (Started from top)
mbedAustin 11:cada08fc8a70 76 * DHM 3 9
mbedAustin 11:cada08fc8a70 77 * PK 3 14 (Started from top)
mbedAustin 11:cada08fc8a70 78 * RSA 4 9
mbedAustin 11:cada08fc8a70 79 * ECP 4 8 (Started from top)
mbedAustin 11:cada08fc8a70 80 * MD 5 4
mbedAustin 11:cada08fc8a70 81 * CIPHER 6 6
mbedAustin 11:cada08fc8a70 82 * SSL 6 16 (Started from top)
mbedAustin 11:cada08fc8a70 83 * SSL 7 31
mbedAustin 11:cada08fc8a70 84 *
mbedAustin 11:cada08fc8a70 85 * Module dependent error code (5 bits 0x.00.-0x.F8.)
mbedAustin 11:cada08fc8a70 86 */
mbedAustin 11:cada08fc8a70 87
mbedAustin 11:cada08fc8a70 88 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 89 extern "C" {
mbedAustin 11:cada08fc8a70 90 #endif
mbedAustin 11:cada08fc8a70 91
mbedAustin 11:cada08fc8a70 92 /**
mbedAustin 11:cada08fc8a70 93 * \brief Translate a mbed TLS error code into a string representation,
mbedAustin 11:cada08fc8a70 94 * Result is truncated if necessary and always includes a terminating
mbedAustin 11:cada08fc8a70 95 * null byte.
mbedAustin 11:cada08fc8a70 96 *
mbedAustin 11:cada08fc8a70 97 * \param errnum error code
mbedAustin 11:cada08fc8a70 98 * \param buffer buffer to place representation in
mbedAustin 11:cada08fc8a70 99 * \param buflen length of the buffer
mbedAustin 11:cada08fc8a70 100 */
mbedAustin 11:cada08fc8a70 101 void mbedtls_strerror( int errnum, char *buffer, size_t buflen );
mbedAustin 11:cada08fc8a70 102
mbedAustin 11:cada08fc8a70 103 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 104 }
mbedAustin 11:cada08fc8a70 105 #endif
mbedAustin 11:cada08fc8a70 106
mbedAustin 11:cada08fc8a70 107 #endif /* error.h */