ACPI.py revision 5825:da5f7e97958c 
1# Copyright (c) 2008 The Hewlett-Packard Development Company
2# All rights reserved.
3#
4# Redistribution and use of this software in source and binary forms,
5# with or without modification, are permitted provided that the
6# following conditions are met:
7#
8# The software must be used only for Non-Commercial Use which means any
9# use which is NOT directed to receiving any direct monetary
10# compensation for, or commercial advantage from such use.  Illustrative
11# examples of non-commercial use are academic research, personal study,
12# teaching, education and corporate research & development.
13# Illustrative examples of commercial use are distributing products for
14# commercial advantage and providing services using the software for
15# commercial advantage.
16#
17# If you wish to use this software or functionality therein that may be
18# covered by patents for commercial use, please contact:
19#     Director of Intellectual Property Licensing
20#     Office of Strategy and Technology
21#     Hewlett-Packard Company
22#     1501 Page Mill Road
23#     Palo Alto, California  94304
24#
25# Redistributions of source code must retain the above copyright notice,
26# this list of conditions and the following disclaimer.  Redistributions
27# in binary form must reproduce the above copyright notice, this list of
28# conditions and the following disclaimer in the documentation and/or
29# other materials provided with the distribution.  Neither the name of
30# the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
31# contributors may be used to endorse or promote products derived from
32# this software without specific prior written permission.  No right of
33# sublicense is granted herewith.  Derivatives of the software and
34# output created using the software may be prepared, but only for
35# Non-Commercial Uses.  Derivatives of the software may be shared with
36# others provided: (i) the others agree to abide by the list of
37# conditions herein which includes the Non-Commercial Use restrictions;
38# and (ii) such Derivatives of the software include the above copyright
39# notice to acknowledge the contribution from this software where
40# applicable, this list of conditions and the disclaimer below.
41#
42# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53#
54# Authors: Gabe Black
55
56from m5.params import *
57from m5.SimObject import SimObject
58
59# ACPI description table header. Subclasses contain and handle the actual
60# contents as appropriate for that type of table.
61class X86ACPISysDescTable(SimObject):
62    type = 'X86ACPISysDescTable'
63    cxx_class = 'X86ISA::ACPI::SysDescTable'
64    abstract = True
65
66    oem_id = Param.String('', 'string identifying the oem')
67    oem_table_id = Param.String('', 'oem table ID')
68    oem_revision = Param.UInt32(0, 'oem revision number for the table')
69
70    creator_id = Param.String('',
71            'string identifying the generator of the table')
72    creator_revision = Param.UInt32(0,
73            'revision number for the creator of the table')
74
75class X86ACPIRSDT(X86ACPISysDescTable):
76    type = 'X86ACPIRSDT'
77    cxx_class = 'X86ISA::ACPI::RSDT'
78
79    entries = VectorParam.X86ACPISysDescTable([], 'system description tables')
80
81class X86ACPIXSDT(X86ACPISysDescTable):
82    type = 'X86ACPIXSDT'
83    cxx_class = 'X86ISA::ACPI::XSDT'
84
85    entries = VectorParam.X86ACPISysDescTable([], 'system description tables')
86
87# Root System Description Pointer Structure
88class X86ACPIRSDP(SimObject):
89    type = 'X86ACPIRSDP'
90    cxx_class = 'X86ISA::ACPI::RSDP'
91
92    oem_id = Param.String('', 'string identifying the oem')
93    # Because 0 encodes ACPI 1.0, 2 encodes ACPI 3.0, the version implemented
94    # here.
95    revision = Param.UInt8(2, 'revision of ACPI being used, zero indexed')
96
97    rsdt = Param.X86ACPIRSDT(NULL, 'root system description table')
98    xsdt = Param.X86ACPIXSDT(X86ACPIXSDT(),
99            'extended system description table')
100