ARM64Constant.h

Go to the documentation of this file.

/*
 * Copyright (C) 2025 Ivan Tan
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBARCH_ARM64_CONSTANT_H
#define __LIBARCH_ARM64_CONSTANT_H
 
#define L1_DIRSHIFT        30UL
#define L2_DIRSHIFT        21UL
#define L3_DIRSHIFT        12UL
#define DIR_MASK           0x1FFUL
 
#define PAGESIZE        4096
 
#define PAGEDIR_MAX     512
#define PAGEDIR_SIZE    (PAGEDIR_MAX * sizeof(u64))
 
#define PAGETAB_MAX     256
#define PAGETAB_SIZE    (PAGETAB_MAX * sizeof(u32))
#define PAGETAB_SPAN    (PAGETAB_MAX*PAGESIZE)
 
#define PAGEMASK        0x3FFFFFFFFF000UL 
 
#define L1_BLOCK_MASK     0x3FFFFC0000000UL
#define L1_BLOCK_SIZE     0x40000000UL
#define L1_BLOCK_RANGE    (L1_BLOCK_SIZE-1)
#define L2_BLOCK_MASK     0x3FFFFFFE00000UL
#define L2_BLOCK_SIZE     0x200000UL
#define L2_BLOCK_RANGE    (L2_BLOCK_SIZE-1)
 
#define L1_IDX(va) (((va) >> L1_DIRSHIFT) & DIR_MASK)
#define L2_IDX(va) (((va) >> L2_DIRSHIFT) & DIR_MASK)
#define L3_IDX(va) (((va) >> L3_DIRSHIFT) & DIR_MASK)
 
#define MEMALIGN        4
 
// descriptor types
#define PT_NONE         0
#define PT_PAGE         0b11        //page/table descriptor
#define PT_BLOCK        0b01        //block descriptor
#define PT_TYPE_MASK    0b11
#define GET_PT_TYPE(entry)          ((entry) & PT_TYPE_MASK)
#define IS_PT_PAGE_TBL(entry)       (GET_PT_TYPE(entry) == PT_PAGE)
#define IS_PT_BLOCK(entry)          (GET_PT_TYPE(entry) == PT_BLOCK)
 
// accessibility
#define PT_KERNEL       (0<<6)      // privileged, supervisor EL1 access only (default)
#define PT_USER         (1<<6)      // unprivileged, EL0 access allowed
#define PT_RW           (0<<7)      // read-write (default)
#define PT_RO           (1<<7)      // read-only
#define PT_AF           (1<<10)     // access flag
#define PT_NX           (1UL<<54)   // no execute
 
// shareability
#define PT_OSH          (2<<8)      // outter shareable
#define PT_ISH          (3<<8)      // inner shareable
 
// define in MAIR register
#define PT_MEM          (0<<2)      // normal memory
#define PT_DEV          (1<<2)      // device MMIO
#define PT_NC           (2<<2)      // non-cachable
 
#define TTBR_CNP        1
 
#define contain_flags(val, flags) (((val)&(flags))==(flags))
 
#endif /* __LIBARCH_ARM64_CONSTANT_H */