xref: /optee_os/core/include/kernel/tee_misc.h (revision 9403c583381528e7fb391e3769644cc9653cfbb6)
1 /*
2  * Copyright (c) 2014, STMicroelectronics International N.V.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 #ifndef TEE_MISC_H
28 #define TEE_MISC_H
29 
30 #include <kernel/tee_common_unpg.h>
31 #include <types_ext.h>
32 
33 /*
34  * Macro to derive hex string buffer size from binary buffer size & the
35  * reverse
36  */
37 #define TEE_B2HS_HSBUF_SIZE(x) ((x) * 2 + 1)
38 #define TEE_HS2B_BBUF_SIZE(x) ((x + 1) >> 1)
39 
40 /*
41  * binary to hex string buffer
42  * Returns the number of data bytes written to the hex string
43  */
44 uint32_t tee_b2hs(uint8_t *b, uint8_t *hs, uint32_t blen, uint32_t hslen);
45 
46 /*
47  * hex string to binary buffer
48  * Returns the number of data bytes written to the bin buffer
49  */
50 uint32_t tee_hs2b(uint8_t *hs, uint8_t *b, uint32_t hslen, uint32_t blen);
51 
52 /*
53  * Is buffer 'b' inside/outside/overlapping area 'a'?
54  *
55  * core_is_buffer_inside() - return true if buffer is inside memory area
56  * core_is_buffer_outside() - return true if buffer is outside area
57  * core_is_buffer_intersect() - return true if buffer overlaps area
58  *
59  * Warning: core_is_buffer_inside(x,x,x,x)==false does NOT mean
60  * core_is_buffer_outside(x,x,x,x)==true.
61  *
62  * Arguments use by each of these routines:
63  * @b - buffer start address (handled has an unsigned offset)
64  * @bl - length (in bytes) of the target buffer
65  * @a - memory area start address (handled has an unsigned offset)
66  * @al - memory area length (in byte)
67  */
68 #define core_is_buffer_inside(b, bl, a, al) \
69 	_core_is_buffer_inside((vaddr_t)(b), (size_t)(bl), \
70 				(vaddr_t)(a), (size_t)(al))
71 
72 #define core_is_buffer_outside(b, bl, a, al) \
73 	_core_is_buffer_outside((vaddr_t)(b), (size_t)(bl), \
74 				(vaddr_t)(a), (size_t)(al))
75 
76 #define core_is_buffer_intersect(b, bl, a, al) \
77 	_core_is_buffer_intersect((vaddr_t)(b), (size_t)(bl), \
78 				(vaddr_t)(a), (size_t)(al))
79 
80 bool _core_is_buffer_inside(vaddr_t b, size_t bl, vaddr_t a, size_t al);
81 bool _core_is_buffer_outside(vaddr_t b, size_t bl, vaddr_t a, size_t al);
82 bool _core_is_buffer_intersect(vaddr_t b, size_t bl, vaddr_t a, size_t al);
83 
84 #endif /* TEE_MISC_H */
85