1/*
2 * Copyright (c) 2014, 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 __XLAT_TABLES_H__
32#define __XLAT_TABLES_H__
33
34
35/*
36 * Flags to override default values used to program system registers while
37 * enabling the MMU.
38 */
39#define DISABLE_DCACHE		(1 << 0)
40
41#ifndef __ASSEMBLY__
42#include <stdint.h>
43
44/* Helper macro to define entries for mmap_region_t. It creates
45 * identity mappings for each region.
46 */
47#define MAP_REGION_FLAT(adr, sz, attr) MAP_REGION(adr, adr, sz, attr)
48
49/* Helper macro to define entries for mmap_region_t. It allows to
50 * re-map address mappings from 'pa' to 'va' for each region.
51 */
52#define MAP_REGION(pa, va, sz, attr) {(pa), (va), (sz), (attr)}
53
54/*
55 * Flags for building up memory mapping attributes.
56 * These are organised so that a clear bit gives a more restrictive  mapping
57 * that a set bit, that way a bitwise-and two sets of attributes will never give
58 * an attribute which has greater access rights that any of the original
59 * attributes.
60 */
61typedef enum  {
62	MT_DEVICE	= 0 << 0,
63	MT_MEMORY	= 1 << 0,
64
65	MT_RO		= 0 << 1,
66	MT_RW		= 1 << 1,
67
68	MT_SECURE	= 0 << 2,
69	MT_NS		= 1 << 2
70} mmap_attr_t;
71
72/*
73 * Structure for specifying a single region of memory.
74 */
75typedef struct mmap_region {
76	unsigned long	base_pa;
77	unsigned long	base_va;
78	unsigned long	size;
79	mmap_attr_t	attr;
80} mmap_region_t;
81
82void mmap_add_region(unsigned long base_pa, unsigned long base_va,
83				unsigned long size, unsigned attr);
84void mmap_add(const mmap_region_t *mm);
85
86void init_xlat_tables(void);
87
88void enable_mmu_el1(uint32_t flags);
89void enable_mmu_el3(uint32_t flags);
90
91#endif /*__ASSEMBLY__*/
92#endif /* __XLAT_TABLES_H__ */
93