Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
crys_ecpki_domain.h
Go to the documentation of this file.
1 /**************************************************************************************
2 * Copyright (c) 2016-2017, ARM Limited or its affiliates. All rights reserved *
3 * *
4 * This file and the related binary are licensed under the following license: *
5 * *
6 * ARM Object Code and Header Files License, v1.0 Redistribution. *
7 * *
8 * Redistribution and use of object code, header files, and documentation, without *
9 * modification, are permitted provided that the following conditions are met: *
10 * *
11 * 1) Redistributions must reproduce the above copyright notice and the *
12 * following disclaimer in the documentation and/or other materials *
13 * provided with the distribution. *
14 * *
15 * 2) Unless to the extent explicitly permitted by law, no reverse *
16 * engineering, decompilation, or disassembly of is permitted. *
17 * *
18 * 3) Redistribution and use is permitted solely for the purpose of *
19 * developing or executing applications that are targeted for use *
20 * on an ARM-based product. *
21 * *
22 * DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND *
23 * CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT *
24 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, *
25 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE *
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, *
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED *
28 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
29 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
31 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
33 **************************************************************************************/
34 
35 
36 
37 #ifndef CRYS_ECPKI_DOMAIN_H
38 #define CRYS_ECPKI_DOMAIN_H
39 
40 
41 /*!
42 @file
43 @brief Defines the ecpki build domain API.
44 @defgroup crys_ecpki_domain CryptoCell ECC domain APIs
45 @{
46 @ingroup cryptocell_ecpki
47 */
48 
49 
50 #include "crys_error.h"
51 #include "crys_ecpki_types.h"
52 
53 #ifdef __cplusplus
54 extern "C"
55 {
56 #endif
57 
58 
59 
60 
61 /**********************************************************************************
62  * CRYS_ECPKI_GetEcDomain function *
63  **********************************************************************************/
64 
65 /*!
66  * @brief The function returns a pointer to an ECDSA saved domain (one of the supported domains).
67  *
68  * @return Domain pointer on success.
69  * @return NULL on failure.
70  */
71 
72 const CRYS_ECPKI_Domain_t *CRYS_ECPKI_GetEcDomain(CRYS_ECPKI_DomainID_t domainId /*!< [in] Index of one of the domain Id (must be one of the supported domains). */);
73 
74 #ifdef __cplusplus
75 }
76 #endif
77 /**
78 @}
79 */
80 #endif
CRYS_ECPKI_GetEcDomain
const CRYS_ECPKI_Domain_t * CRYS_ECPKI_GetEcDomain(CRYS_ECPKI_DomainID_t domainId)
The function returns a pointer to an ECDSA saved domain (one of the supported domains).
CRYS_ECPKI_DomainID_t
CRYS_ECPKI_DomainID_t
Definition: crys_ecpki_types.h:73
crys_ecpki_types.h
Contains all of the enums and definitions that are used for the CRYS ECPKI APIs.
CRYS_ECPKI_Domain_t
Definition: crys_ecpki_types.h:164
crys_error.h
This module defines the error return code types and the numbering spaces of the error codes for each ...
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.