ArmPMU.py revision 10461 
1# -*- mode:python -*-
2# Copyright (c) 2009-2014 ARM Limited
3# All rights reserved.
4#
5# The license below extends only to copyright in the software and shall
6# not be construed as granting a license to any other intellectual
7# property including but not limited to intellectual property relating
8# to a hardware implementation of the functionality of the software
9# licensed hereunder.  You may use the software subject to the license
10# terms below provided that you ensure that this notice is replicated
11# unmodified and in its entirety in all distributions of the software,
12# modified or unmodified, in source code or in binary form.
13#
14# Redistribution and use in source and binary forms, with or without
15# modification, are permitted provided that the following conditions are
16# met: redistributions of source code must retain the above copyright
17# notice, this list of conditions and the following disclaimer;
18# redistributions in binary form must reproduce the above copyright
19# notice, this list of conditions and the following disclaimer in the
20# documentation and/or other materials provided with the distribution;
21# neither the name of the copyright holders nor the names of its
22# contributors may be used to endorse or promote products derived from
23# this software without specific prior written permission.
24#
25# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36#
37# Authors: Matt Horsnell
38#          Andreas Sandberg
39
40from m5.defines import buildEnv
41from m5.SimObject import SimObject
42from m5.params import *
43from m5.params import isNullPointer
44from m5.proxy import *
45
46class ArmPMU(SimObject):
47    type = 'ArmPMU'
48    cxx_class = 'ArmISA::PMU'
49    cxx_header = 'arch/arm/pmu.hh'
50
51    @classmethod
52    def export_methods(cls, code):
53        code('''
54      void addEventProbe(unsigned int id,
55                        SimObject *obj, const char *name);
56''')
57
58    # To prevent cycles in the configuration hierarchy, we don't keep
59    # a list of supported events as a configuration param. Instead, we
60    # keep them in a local list and register them using the
61    # addEventProbe interface when other SimObjects register their
62    # probe listeners.
63    _deferred_event_types = []
64    # Override the normal SimObject::regProbeListeners method and
65    # register deferred event handlers.
66    def regProbeListeners(self):
67        for event_id, obj, name in self._deferred_event_types:
68            self.getCCObject().addEventProbe(event_id, obj.getCCObject(), name)
69
70        self.getCCObject().regProbeListeners()
71
72    def addEventProbe(self, event_id, obj, *args):
73        """Add a probe-based event to the PMU if obj is not None."""
74
75        if obj is None:
76            return
77
78        for name in args:
79            self._deferred_event_types.append((event_id, obj, name))
80
81    platform = Param.Platform(Parent.any, "Platform this device is part of.")
82    eventCounters = Param.Int(31, "Number of supported PMU counters")
83    pmuInterrupt = Param.Int(68, "PMU GIC interrupt number")
84