blob: 674845404467b2e1df6823d0e07e2af483a83e00 [file] [log] [blame]
Sandrine Bailleux7659a262016-07-05 09:55:03 +01001/*
Roberto Vargas550eb082018-01-05 16:00:05 +00002 * Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved.
Sandrine Bailleux7659a262016-07-05 09:55:03 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Sandrine Bailleux7659a262016-07-05 09:55:03 +01005 */
6
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +00007#ifndef UTILS_H
8#define UTILS_H
Sandrine Bailleux7659a262016-07-05 09:55:03 +01009
Douglas Raillard21362a92016-12-02 13:51:54 +000010/*
11 * C code should be put in this part of the header to avoid breaking ASM files
12 * or linker scripts including it.
13 */
14#if !(defined(__LINKER__) || defined(__ASSEMBLY__))
15
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000016#include <stddef.h>
Antonio Nino Diaz4b32e622018-08-16 16:52:57 +010017#include <stdint.h>
Douglas Raillard21362a92016-12-02 13:51:54 +000018
Masahiro Yamadaff3ecb62018-01-16 23:15:38 +090019typedef struct mem_region {
Roberto Vargasc5907702017-08-03 08:56:38 +010020 uintptr_t base;
21 size_t nbytes;
22} mem_region_t;
23
24/*
25 * zero_normalmem all the regions defined in tbl.
26 */
27void clear_mem_regions(mem_region_t *tbl, size_t nregions);
28
Roberto Vargas550eb082018-01-05 16:00:05 +000029/*
30 * zero_normalmem all the regions defined in region. It dynamically
31 * maps chunks of 'chunk_size' in 'va' virtual address and clears them.
32 * For this reason memory regions must be multiple of chunk_size and
33 * must be aligned to it as well. chunk_size and va can be selected
34 * in a way that they minimize the number of entries used in the
35 * translation tables.
36 */
Roberto Vargas85664f52018-02-12 12:36:17 +000037void clear_map_dyn_mem_regions(struct mem_region *regions,
Roberto Vargas550eb082018-01-05 16:00:05 +000038 size_t nregions,
39 uintptr_t va,
Roberto Vargas85664f52018-02-12 12:36:17 +000040 size_t chunk);
Roberto Vargasc5907702017-08-03 08:56:38 +010041
42/*
43 * checks that a region (addr + nbytes-1) of memory is totally covered by
44 * one of the regions defined in tbl. Caller must ensure that (addr+nbytes-1)
45 * doesn't overflow.
46 */
47int mem_region_in_array_chk(mem_region_t *tbl, size_t nregions,
48 uintptr_t addr, size_t nbytes);
49
Douglas Raillard21362a92016-12-02 13:51:54 +000050/*
51 * Fill a region of normal memory of size "length" in bytes with zero bytes.
52 *
53 * WARNING: This function can only operate on normal memory. This means that
54 * the MMU must be enabled when using this function. Otherwise, use
55 * zeromem.
56 */
57void zero_normalmem(void *mem, u_register_t length);
58
59/*
60 * Fill a region of memory of size "length" in bytes with null bytes.
61 *
62 * Unlike zero_normalmem, this function has no restriction on the type of
63 * memory targeted and can be used for any device memory as well as normal
64 * memory. This function must be used instead of zero_normalmem when MMU is
65 * disabled.
66 *
67 * NOTE: When data cache and MMU are enabled, prefer zero_normalmem for faster
68 * zeroing.
69 */
70void zeromem(void *mem, u_register_t length);
Soby Mathew12cdcd22018-10-12 16:26:20 +010071
72/*
73 * Utility function to return the address of a symbol. By default, the
74 * compiler generates adr/adrp instruction pair to return the reference
75 * to the symbol and this utility is used to override this compiler
76 * generated to code to use `ldr` instruction.
77 *
78 * This helps when Position Independent Executable needs to reference a symbol
79 * which is constant and does not depend on the execute address of the binary.
80 */
81#define DEFINE_LOAD_SYM_ADDR(_name) \
82static inline u_register_t load_addr_## _name(void) \
83{ \
84 u_register_t v; \
85 /* Create a void reference to silence compiler */ \
86 (void) _name; \
87 __asm__ volatile ("ldr %0, =" #_name : "=r" (v)); \
88 return v; \
89}
90
91/* Helper to invoke the function defined by DEFINE_LOAD_SYM_ADDR() */
92#define LOAD_ADDR_OF(_name) (typeof(_name) *) load_addr_## _name()
93
Douglas Raillard21362a92016-12-02 13:51:54 +000094#endif /* !(defined(__LINKER__) || defined(__ASSEMBLY__)) */
95
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +000096#endif /* UTILS_H */