xref: /optee_os/lib/libutee/include/tee_arith_internal.h (revision 1bb929836182ecb96d2d9d268daa807c67596396)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2014, STMicroelectronics International N.V.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef GUARD_TEE_MATHAPI_H
29 #define GUARD_TEE_MATHAPI_H
30 
31 #include <stddef.h>		/* for size_t */
32 #include <stdint.h>		/* for uint32_t and friends */
33 #include <stdbool.h>		/* for bool (!) */
34 
35 /*************************************************************
36  *
37  *  MACRO DEFINITIONS
38  *
39  *************************************************************/
40 
41 /*------------------------------------------------------------
42  *
43  *  How functions are exported
44  *
45  */
46 #define TEE_MATHAPI_EXPORT
47 
48 /*
49  * The modes for String Conversion
50  */
51 #define TEE_STRING_MODE_HEX_UC MPA_STRING_MODE_HEX_UC
52 #define TEE_STRING_MODE_HEX_LC MPA_STRING_MODE_HEX_UC
53 
54 /*------------------------------------------------------------
55  *
56  *  Define IN, OUT, INBUF and OUTBUF to keep format from the spec.
57  *
58  */
59 #define IN const
60 #define OUT
61 #define INOUT
62 #define INBUF const
63 #define OUTBUF
64 
65 /*************************************************************
66  *
67  *  MEMORY ALLOCATION AND SIZE
68  *
69  *************************************************************/
70 
71 /*
72  * THIS IS THE MAXIMUM NUMBER OF BITS THAT THE LIBRARY SUPPORTS.
73  * It defines the size of the scratch memory pool for the underlying
74  * mpa library.
75  */
76 #define TEE_MAX_NUMBER_OF_SUPPORTED_BITS 2048
77 
78 /*************************************************************
79  *
80  * INITIALIZATION FUNCTIONS
81  *
82  *************************************************************/
83 
84 /*
85  * !!! This function must be called before you do anything else !!!
86  *  NOTE: Not part of the spec
87  */
88 TEE_MATHAPI_EXPORT void _TEE_MathAPI_Init(void);
89 
90 /* this function generate a syscall to teecore for random number
91  * generation, this is supplied to libmpa. Thus libmpa linked with user
92  * TA can use this function to get random number.
93  */
94 TEE_Result get_rng_array(void *buf, size_t blen);
95 
96 #endif
97