1
/*
2
 * $Id$
3
 *
4
 * Copyright (C) 2003-2009 JNode.org
5
 *
6
 * This library is free software; you can redistribute it and/or modify it
7
 * under the terms of the GNU Lesser General Public License as published
8
 * by the Free Software Foundation; either version 2.1 of the License, or
9
 * (at your option) any later version.
10
 *
11
 * This library is distributed in the hope that it will be useful, but 
12
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
14
 * License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public License
17
 * along with this library; If not, write to the Free Software Foundation, Inc., 
18
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
 */
20
 
21
package org.jnode.vm;
22
23
import org.vmmagic.unboxed.Address;
24
import org.vmmagic.unboxed.Extent;
25
26
/**
27
 * Class used to describe memory map elements.
28
 *
29
 * @author Ewout Prangsma (epr@users.sourceforge.net)
30
 */
31
public abstract class MemoryMapEntry {
32
33
    /**
34
     * Gets the start of this entry.
35
     *
36
     * @return the entry's start address.
37
     */
38
    public abstract Address getStart();
39
40
    /**
41
     * Gets the size of this entry.
42
     *
43
     * @return the entries size
44
     */
45
    public abstract Extent getSize();
46
47
    /**
48
     * Test if a memory region is available to the OS.
49
     *
50
     * @return {@code true} if the region is available, otherwise {@code false}.
51
     */
52
    public abstract boolean isAvailable();
53
54
    /**
55
     * Is this a memory region containing reclaimable ACPI data.
56
     *
57
     * @return {@code true} if the region contains reclaimable ACPI data, otherwise {@code false}.
58
     */
59
    public abstract boolean isAcpi();
60
61
    /**
62
     * Is this a memory region containing ACPI NVS data.
63
     *
64
     * @return {@code true} if the region contains ACPI NVS data, otherwise {@code false}.
65
     */
66
    public abstract boolean isAcpiNVS();
67
}