Eric Tsai / mbedtls

Modified mbed TLS headers for AES functionality only to reduce build size

Dependents:   BLE_Gateway_Linker_fix BLE_Gateway

Fork of mbedtls by sandbox

mbedtls/error.h@5:f09f5ed830ca, 2017-07-10 (annotated)

Committer:
electronichamsters
Date:
Mon Jul 10 04:00:25 2017 +0000
Revision:
5:f09f5ed830ca
Parent:
1:24750b9ad5ef 
working gateway

Who changed what in which revision?

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