Daiki Kato / mbed-os-lychee

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

features/mbedtls/inc/mbedtls/error.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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