UefiCpuPkg/CpuDxe: Add memory attribute setting.
[mirror_edk2.git] / UefiCpuPkg / CpuDxe / CpuPageTable.h
1 /** @file
2 Page table management header file.
3
4 Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef _PAGE_TABLE_LIB_H_
16 #define _PAGE_TABLE_LIB_H_
17
18 #include <IndustryStandard/PeImage.h>
19
20 #define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_PSE BIT0
21 #define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_PAE BIT1
22 #define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_PAGE_1G_SUPPORT BIT2
23 #define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_WP_ENABLE BIT30
24 #define PAGE_TABLE_LIB_PAGING_CONTEXT_IA32_X64_ATTRIBUTES_XD_ACTIVATED BIT31
25 // Other bits are reserved for future use
26 typedef struct {
27 UINT32 PageTableBase;
28 UINT32 Reserved;
29 UINT32 Attributes;
30 } PAGE_TABLE_LIB_PAGING_CONTEXT_IA32;
31
32 typedef struct {
33 UINT64 PageTableBase;
34 UINT32 Attributes;
35 } PAGE_TABLE_LIB_PAGING_CONTEXT_X64;
36
37 typedef union {
38 PAGE_TABLE_LIB_PAGING_CONTEXT_IA32 Ia32;
39 PAGE_TABLE_LIB_PAGING_CONTEXT_X64 X64;
40 } PAGE_TABLE_LIB_PAGING_CONTEXT_DATA;
41
42 typedef struct {
43 //
44 // PE32+ Machine type for EFI images
45 //
46 // #define IMAGE_FILE_MACHINE_I386 0x014c
47 // #define IMAGE_FILE_MACHINE_X64 0x8664
48 //
49 UINT16 MachineType;
50 PAGE_TABLE_LIB_PAGING_CONTEXT_DATA ContextData;
51 } PAGE_TABLE_LIB_PAGING_CONTEXT;
52
53 /**
54 Allocates one or more 4KB pages for page table.
55
56 @param Pages The number of 4 KB pages to allocate.
57
58 @return A pointer to the allocated buffer or NULL if allocation fails.
59
60 **/
61 typedef
62 VOID *
63 (EFIAPI *PAGE_TABLE_LIB_ALLOCATE_PAGES) (
64 IN UINTN Pages
65 );
66
67 /**
68 This function assigns the page attributes for the memory region specified by BaseAddress and
69 Length from their current attributes to the attributes specified by Attributes.
70
71 Caller should make sure BaseAddress and Length is at page boundary.
72
73 Caller need guarentee the TPL <= TPL_NOTIFY, if there is split page request.
74
75 @param PagingContext The paging context. NULL means get page table from current CPU context.
76 @param BaseAddress The physical address that is the start address of a memory region.
77 @param Length The size in bytes of the memory region.
78 @param Attributes The bit mask of attributes to set for the memory region.
79 @param AllocatePagesFunc If page split is needed, this function is used to allocate more pages.
80 NULL mean page split is unsupported.
81
82 @retval RETURN_SUCCESS The attributes were cleared for the memory region.
83 @retval RETURN_ACCESS_DENIED The attributes for the memory resource range specified by
84 BaseAddress and Length cannot be modified.
85 @retval RETURN_INVALID_PARAMETER Length is zero.
86 Attributes specified an illegal combination of attributes that
87 cannot be set together.
88 @retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
89 the memory resource range.
90 @retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the memory
91 resource range specified by BaseAddress and Length.
92 The bit mask of attributes is not support for the memory resource
93 range specified by BaseAddress and Length.
94 **/
95 RETURN_STATUS
96 EFIAPI
97 AssignMemoryPageAttributes (
98 IN PAGE_TABLE_LIB_PAGING_CONTEXT *PagingContext OPTIONAL,
99 IN PHYSICAL_ADDRESS BaseAddress,
100 IN UINT64 Length,
101 IN UINT64 Attributes,
102 IN PAGE_TABLE_LIB_ALLOCATE_PAGES AllocatePagesFunc OPTIONAL
103 );
104
105 /**
106 Initialize the Page Table lib.
107 **/
108 VOID
109 InitializePageTableLib (
110 VOID
111 );
112
113 #endif