xref: /rk3399_ARM-atf/include/lib/utils.h (revision 53d9c9c85bc49845c4c40315e1ab29d627a1f8c3)
1 /*
2  * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __UTILS_H__
32 #define __UTILS_H__
33 
34 #if !ERROR_DEPRECATED
35 #include <utils_def.h>
36 #endif
37 
38 /*
39  * C code should be put in this part of the header to avoid breaking ASM files
40  * or linker scripts including it.
41  */
42 #if !(defined(__LINKER__) || defined(__ASSEMBLY__))
43 
44 #include <types.h>
45 
46 /*
47  * Fill a region of normal memory of size "length" in bytes with zero bytes.
48  *
49  * WARNING: This function can only operate on normal memory. This means that
50  *          the MMU must be enabled when using this function. Otherwise, use
51  *          zeromem.
52  */
53 void zero_normalmem(void *mem, u_register_t length);
54 
55 /*
56  * Fill a region of memory of size "length" in bytes with null bytes.
57  *
58  * Unlike zero_normalmem, this function has no restriction on the type of
59  * memory targeted and can be used for any device memory as well as normal
60  * memory. This function must be used instead of zero_normalmem when MMU is
61  * disabled.
62  *
63  * NOTE: When data cache and MMU are enabled, prefer zero_normalmem for faster
64  *       zeroing.
65  */
66 void zeromem(void *mem, u_register_t length);
67 #endif /* !(defined(__LINKER__) || defined(__ASSEMBLY__)) */
68 
69 #endif /* __UTILS_H__ */
70