summaryrefslogtreecommitdiff
path: root/src/dev/arm/generic_timer.hh
blob: bc43f8b3b61d6561f31a14c29610a155e4c5b538 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
 * Copyright (c) 2013 ARM Limited
 * All rights reserved.
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Giacomo Gabrielli
 */

#ifndef __DEV_ARM_GENERIC_TIMER_HH__
#define __DEV_ARM_GENERIC_TIMER_HH__

#include "base/bitunion.hh"
#include "params/GenericTimer.hh"
#include "sim/core.hh"
#include "sim/sim_object.hh"

/// @file
/// This module implements the global system counter and the local per-CPU
/// architected timers as specified by the ARM Generic Timer extension (ARM
/// ARM, Issue C, Chapter 17).

class Checkpoint;
class BaseGic;

/// Wrapper around the actual counters and timers of the Generic Timer
/// extension.
class GenericTimer : public SimObject
{
  public:

    /// Global system counter.  It is shared by the architected timers.
    /// @todo: implement memory-mapped controls
    class SystemCounter
    {
      protected:
        /// Counter frequency (as specified by CNTFRQ).
        uint64_t _freq;
        /// Cached copy of the counter period (inverse of the frequency).
        Tick _period;
        /// Tick when the counter was reset.
        Tick _resetTick;

      public:
        /// Ctor.
        SystemCounter()
            : _freq(0), _period(0), _resetTick(0)
        {
            setFreq(0x01800000);
        }

        /// Returns the current value of the physical counter.
        uint64_t value() const
        {
            if (_freq == 0)
                return 0;  // Counter is still off.
            return (curTick() - _resetTick) / _period;
        }

        /// Returns the counter frequency.
        uint64_t freq() const { return _freq; }
        /// Sets the counter frequency.
        /// @param freq frequency in Hz.
        void setFreq(uint32_t freq);

        /// Returns the counter period.
        Tick period() const { return _period; }

        void serialize(std::ostream &os);
        void unserialize(Checkpoint *cp, const std::string &section);
    };

    /// Per-CPU architected timer.
    class ArchTimer
    {
      protected:
        /// Control register.
        BitUnion32(ArchTimerCtrl)
            Bitfield<0> enable;
            Bitfield<1> imask;
            Bitfield<2> istatus;
        EndBitUnion(ArchTimerCtrl)

        /// Name of this timer.
        std::string _name;
        /// Pointer to parent class.
        GenericTimer *_parent;
        /// Pointer to the global system counter.
        SystemCounter *_counter;
        /// ID of the CPU this timer is attached to.
        int _cpuNum;
        /// ID of the interrupt to be triggered.
        int _intNum;
        /// Cached value of the control register ({CNTP/CNTHP/CNTV}_CTL).
        ArchTimerCtrl _control;
        /// Programmed limit value for the upcounter ({CNTP/CNTHP/CNTV}_CVAL).
        uint64_t _counterLimit;

        /// Called when the upcounter reaches the programmed value.
        void counterLimitReached();
        EventWrapper<ArchTimer, &ArchTimer::counterLimitReached>
            _counterLimitReachedEvent;

        /// Returns the value of the counter which this timer relies on.
        uint64_t counterValue() const { return _counter->value(); }

      public:
        /// Ctor.
        ArchTimer()
            : _control(0), _counterLimit(0), _counterLimitReachedEvent(this)
        {}

        /// Returns the timer name.
        std::string name() const { return _name; }

        /// Returns the CompareValue view of the timer.
        uint64_t compareValue() const { return _counterLimit; }
        /// Sets the CompareValue view of the timer.
        void setCompareValue(uint64_t val);

        /// Returns the TimerValue view of the timer.
        uint32_t timerValue() const { return _counterLimit - counterValue(); }
        /// Sets the TimerValue view of the timer.
        void setTimerValue(uint32_t val);

        /// Sets the control register.
        uint32_t control() const { return _control; }
        void setControl(uint32_t val);

        virtual void serialize(std::ostream &os);
        virtual void unserialize(Checkpoint *cp, const std::string &section);

        friend class GenericTimer;
    };

  protected:

    static const int CPU_MAX = 8;

    /// Pointer to the GIC, needed to trigger timer interrupts.
    BaseGic *_gic;
    /// System counter.
    SystemCounter _systemCounter;
    /// Per-CPU architected timers.
    // @todo: this would become a 2-dim. array with Security and Virt.
    ArchTimer _archTimers[CPU_MAX];

  public:
    typedef GenericTimerParams Params;
    const Params *
    params() const
    {
        return dynamic_cast<const Params *>(_params);
    }

    /// Ctor.
    GenericTimer(Params *p);

    /// Returns a pointer to the system counter.
    SystemCounter *getSystemCounter() { return &_systemCounter; }

    /// Returns a pointer to the architected timer for cpu_id.
    ArchTimer *getArchTimer(int cpu_id) { return &_archTimers[cpu_id]; }

    virtual void serialize(std::ostream &os);
    virtual void unserialize(Checkpoint *cp, const std::string &section);
};

#endif // __DEV_ARM_GENERIC_TIMER_HH__