crys_kdf_error.h

00001 /**************************************************************************************
00002 * Copyright (c) 2016-2017, ARM Limited or its affiliates. All rights reserved         *
00003 *                                                                                     *
00004 * This file and the related binary are licensed under the following license:          *
00005 *                                                                                     *
00006 * ARM Object Code and Header Files License, v1.0 Redistribution.                      *
00007 *                                                                                     *
00008 * Redistribution and use of object code, header files, and documentation, without     *
00009 * modification, are permitted provided that the following conditions are met:         *
00010 *                                                                                     *
00011 * 1) Redistributions must reproduce the above copyright notice and the                *
00012 *    following disclaimer in the documentation and/or other materials                 *
00013 *    provided with the distribution.                                                  *
00014 *                                                                                     *
00015 * 2) Unless to the extent explicitly permitted by law, no reverse                     *
00016 *    engineering, decompilation, or disassembly of is permitted.                      *
00017 *                                                                                     *
00018 * 3) Redistribution and use is permitted solely for the purpose of                    *
00019 *    developing or executing applications that are targeted for use                   *
00020 *    on an ARM-based product.                                                         *
00021 *                                                                                     *
00022 * DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND                  *
00023 * CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT             *
00024 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT,        *
00025 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          *
00026 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,   *
00027 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED            *
00028 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR              *
00029 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF              *
00030 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING                *
00031 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS                  *
00032 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                        *
00033 **************************************************************************************/
00034 
00035 
00036 #ifndef CRYS_KDF_ERROR_H
00037 #define CRYS_KDF_ERROR_H
00038 
00039 #include "crys_error.h"
00040 
00041 
00042 #ifdef __cplusplus
00043 extern "C"
00044 {
00045 #endif
00046 
00047 /*!
00048 @file
00049 @brief This module contains the definitions of the CRYS KDF errors.
00050 @defgroup crys_kdf_error CryptoCell Key Derivation specific errors
00051 @{
00052 @ingroup crys_kdf
00053  */
00054 
00055 
00056 /************************ Defines *******************************/
00057 
00058 /*! The CRYS KDF module errors / base address - 0x00F01100*/
00059 /*! Illegal input pointer. */
00060 #define CRYS_KDF_INVALID_ARGUMENT_POINTER_ERROR         (CRYS_KDF_MODULE_ERROR_BASE + 0x0UL)
00061 /*! Illegal input size. */
00062 #define CRYS_KDF_INVALID_ARGUMENT_SIZE_ERROR            (CRYS_KDF_MODULE_ERROR_BASE + 0x1UL)
00063 /*! Illegal operation mode. */
00064 #define CRYS_KDF_INVALID_ARGUMENT_OPERATION_MODE_ERROR      (CRYS_KDF_MODULE_ERROR_BASE + 0x2UL)
00065 /*! Illegal hash mode. */
00066 #define CRYS_KDF_INVALID_ARGUMENT_HASH_MODE_ERROR       (CRYS_KDF_MODULE_ERROR_BASE + 0x3UL)
00067 /*! Illegal key derivation mode. */
00068 #define CRYS_KDF_INVALID_KEY_DERIVATION_MODE_ERROR              (CRYS_KDF_MODULE_ERROR_BASE + 0x4UL)
00069 /*! Illegal shared secret value size. */
00070 #define CRYS_KDF_INVALID_SHARED_SECRET_VALUE_SIZE_ERROR         (CRYS_KDF_MODULE_ERROR_BASE + 0x5UL)
00071 /*! Illegal otherInfo size. */
00072 #define CRYS_KDF_INVALID_OTHER_INFO_SIZE_ERROR                  (CRYS_KDF_MODULE_ERROR_BASE + 0x6UL)
00073 /*! Illegal key data size. */
00074 #define CRYS_KDF_INVALID_KEYING_DATA_SIZE_ERROR                 (CRYS_KDF_MODULE_ERROR_BASE + 0x7UL)
00075 /*! Illegal algorithm ID pointer. */
00076 #define CRYS_KDF_INVALID_ALGORITHM_ID_POINTER_ERROR             (CRYS_KDF_MODULE_ERROR_BASE + 0x8UL)
00077 /*! Illegal algorithm ID size. */
00078 #define CRYS_KDF_INVALID_ALGORITHM_ID_SIZE_ERROR                (CRYS_KDF_MODULE_ERROR_BASE + 0x9UL)
00079 /*! KDF is not supproted. */
00080 #define CRYS_KDF_IS_NOT_SUPPORTED                               (CRYS_KDF_MODULE_ERROR_BASE + 0xFFUL)
00081 
00082 /************************ Enums *********************************/
00083 
00084 /************************ Typedefs  *****************************/
00085 
00086 /************************ Structs  ******************************/
00087 
00088 /************************ Public Variables **********************/
00089 
00090 /************************ Public Functions **********************/
00091 
00092 
00093 
00094 
00095 #ifdef __cplusplus
00096 }
00097 #endif
00098 /**
00099 @}
00100  */
00101 #endif
00102 
00103 
00104 
00105