jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/StringView.h>
30#include <Kernel/VM/MemoryManager.h>
31
32namespace Kernel {
33
34template<typename T>
35struct TypedMapping {
36 const T* ptr() const { return reinterpret_cast<const T*>(region->vaddr().offset(offset).as_ptr()); }
37 T* ptr() { return reinterpret_cast<T*>(region->vaddr().offset(offset).as_ptr()); }
38 const T* operator->() const { return ptr(); }
39 const T& operator*() const { return *ptr(); }
40 T& operator*() { return *ptr(); }
41 OwnPtr<Region> region;
42 size_t offset { 0 };
43};
44
45template<typename T>
46static TypedMapping<T> map_typed(PhysicalAddress paddr, size_t length, u8 access = Region::Access::Read)
47{
48 TypedMapping<T> table;
49 table.region = MM.allocate_kernel_region(paddr.page_base(), PAGE_ROUND_UP(length), {}, access);
50 table.offset = paddr.offset_in_page();
51 return table;
52}
53
54template<typename T>
55static TypedMapping<T> map_typed(PhysicalAddress paddr)
56{
57 return map_typed<T>(paddr, sizeof(T));
58}
59
60template<typename T>
61static TypedMapping<T> map_typed_writable(PhysicalAddress paddr)
62{
63 return map_typed<T>(paddr, sizeof(T), Region::Access::Read | Region::Access::Write);
64}
65
66}