page_allocator_exports.h

00001 /*
00002  * Copyright (c) 2016, ARM Limited, All Rights Reserved
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License"); you may
00006  * not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  * http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00013  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 #ifndef __UVISOR_API_PAGE_ALLOCATOR_EXPORTS_H__
00018 #define __UVISOR_API_PAGE_ALLOCATOR_EXPORTS_H__
00019 
00020 #include "api/inc/halt_exports.h"
00021 #include <stdint.h>
00022 #include <stddef.h>
00023 
00024 
00025 #define UVISOR_ERROR_PAGE_OK                    (0)
00026 #define UVISOR_ERROR_PAGE_OUT_OF_MEMORY         (UVISOR_ERROR_CLASS_PAGE + 1)
00027 #define UVISOR_ERROR_PAGE_INVALID_PAGE_TABLE    (UVISOR_ERROR_CLASS_PAGE + 2)
00028 #define UVISOR_ERROR_PAGE_INVALID_PAGE_SIZE     (UVISOR_ERROR_CLASS_PAGE + 3)
00029 #define UVISOR_ERROR_PAGE_INVALID_PAGE_ORIGIN   (UVISOR_ERROR_CLASS_PAGE + 4)
00030 #define UVISOR_ERROR_PAGE_INVALID_PAGE_OWNER    (UVISOR_ERROR_CLASS_PAGE + 5)
00031 #define UVISOR_ERROR_PAGE_INVALID_PAGE_COUNT    (UVISOR_ERROR_CLASS_PAGE + 6)
00032 
00033 /* Contains the uVisor page size.
00034  * @warning Do not read directly, instead use `uvisor_get_page_size()` accessor! */
00035 UVISOR_EXTERN const uint32_t __uvisor_page_size;
00036 
00037 typedef struct {
00038     uint32_t page_size;     /* The page size in bytes. Must be multiple of `UVISOR_PAGE_SIZE`! */
00039     uint32_t page_count;    /* The number of pages in the page table. */
00040     void * page_origins[1]; /* Table of pointers to the origin of each page. */
00041 } UvisorPageTable;
00042 
00043 #endif /* __UVISOR_API_PAGE_ALLOCATOR_EXPORTS_H__ */