crys_srp_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_SRP_ERROR_H
00037 #define CRYS_SRP_ERROR_H
00038 
00039 
00040 #include "crys_error.h"
00041 
00042 #ifdef __cplusplus
00043 extern "C"
00044 {
00045 #endif
00046 
00047 /*!
00048 @file
00049 @brief This module contains the definitions of the CRYS SRP errors.
00050 @defgroup crys_srp_error CryptoCell SRP specific errors
00051 @{
00052 @ingroup crys_srp
00053 */
00054 
00055 
00056 
00057 /************************ Defines ******************************/
00058 
00059 /*! The CRYS SRP module errors base address - 0x00F02600. */
00060 /*! Illegal parameter. */
00061 #define CRYS_SRP_PARAM_INVALID_ERROR               (CRYS_SRP_MODULE_ERROR_BASE + 0x01UL)
00062 /*! Illegal modulus size . */
00063 #define CRYS_SRP_MOD_SIZE_INVALID_ERROR            (CRYS_SRP_MODULE_ERROR_BASE + 0x02UL)
00064 /*! Illegal state (uninitialized) . */
00065 #define CRYS_SRP_STATE_UNINITIALIZED_ERROR         (CRYS_SRP_MODULE_ERROR_BASE + 0x03UL)
00066 /*! Result validation error. */
00067 #define CRYS_SRP_RESULT_ERROR                  (CRYS_SRP_MODULE_ERROR_BASE + 0x04UL)
00068 /*! Invalid parameter. */
00069 #define CRYS_SRP_PARAM_ERROR                   (CRYS_SRP_MODULE_ERROR_BASE + 0x05UL)
00070 /*! Internal PKI error */
00071 #define CRYS_SRP_PKI_INTERNAL_ERROR                (CRYS_SRP_MODULE_ERROR_BASE + 0x06UL)
00072 
00073 /************************ Enums ********************************/
00074 
00075 /************************ Typedefs  ****************************/
00076 
00077 /************************ Structs  *****************************/
00078 
00079 /************************ Public Variables *********************/
00080 
00081 /************************ Public Functions *********************/
00082 
00083 #ifdef __cplusplus
00084 }
00085 #endif
00086 /**
00087 @}
00088  */
00089 #endif
00090 
00091