ARM: Add RTC device for ARM platforms.

This change implements a PL031 real time clock.

--HG--
rename : src/dev/arm/timer_sp804.cc => src/dev/arm/rtc_pl031.cc
rename : src/dev/arm/timer_sp804.hh => src/dev/arm/rtc_pl031.hh

6 files changed, 411 insertions, 18 deletions

diff --git a/src/base/time.cc b/src/base/time.cc
index 8ce2e2137..dd9e72a09 100644
--- a/src/base/time.cc
+++ b/src/base/time.cc
@@ -28,6 +28,8 @@
  * Authors: Nathan Binkert
  */
 
+#include <cstdlib>
+#include <ctime>
 #include <iostream>
 #include <sstream>
 
@@ -144,3 +146,22 @@ sleep(const Time &time)
     nanosleep(&ts, NULL);
 #endif
 }
+
+time_t
+mkutctime(struct tm *time)
+{
+    time_t ret;
+    char *tz;
+
+    tz = getenv("TZ");
+    setenv("TZ", "", 1);
+    tzset();
+    ret = mktime(time);
+    if (tz)
+        setenv("TZ", tz, 1);
+    else
+        unsetenv("TZ");
+    tzset();
+    return ret;
+}
+
diff --git a/src/base/time.hh b/src/base/time.hh
index f2107d78f..734a86fa9 100644
--- a/src/base/time.hh
+++ b/src/base/time.hh
@@ -268,4 +268,6 @@ operator<<(std::ostream &out, const Time &time)
     return out;
 }
 
+time_t mkutctime(struct tm *time);
+
 #endif // __BASE_TIME_HH__
diff --git a/src/dev/arm/SConscript b/src/dev/arm/SConscript
index deedcb49f..a6ead28be 100644
--- a/src/dev/arm/SConscript
+++ b/src/dev/arm/SConscript
@@ -52,6 +52,7 @@ if env['TARGET_ISA'] == 'arm':
     Source('timer_sp804.cc')
     Source('rv_ctrl.cc')
     Source('realview.cc')
+    Source('rtc_pl031.cc')
     Source('timer_cpulocal.cc')
 
     DebugFlag('AMBA')
diff --git a/src/dev/arm/rtc_pl031.cc b/src/dev/arm/rtc_pl031.cc
new file mode 100644
index 000000000..4895b1d4f
--- /dev/null
+++ b/src/dev/arm/rtc_pl031.cc
@@ -0,0 +1,251 @@
+/*
+ * Copyright (c) 2010-2012 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: Ali Saidi
+ */
+
+#include "base/intmath.hh"
+#include "base/time.hh"
+#include "base/trace.hh"
+#include "debug/Checkpoint.hh"
+#include "debug/Timer.hh"
+#include "dev/arm/amba_device.hh"
+#include "dev/arm/rtc_pl031.hh"
+#include "dev/mc146818.hh"
+#include "mem/packet.hh"
+#include "mem/packet_access.hh"
+
+using namespace AmbaDev;
+
+PL031::PL031(Params *p)
+    : AmbaIntDevice(p), timeVal(mkutctime(&p->time)), lastWrittenTick(0),
+            loadVal(0), matchVal(0), rawInt(false), pendingInt(false),
+            matchEvent(this)
+{
+    pioSize = 0xfff;
+}
+
+
+Tick
+PL031::read(PacketPtr pkt)
+{
+    assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize);
+    assert(pkt->getSize() == 4);
+    Addr daddr = pkt->getAddr() - pioAddr;
+    pkt->allocate();
+    uint32_t data;
+
+    DPRINTF(Timer, "Reading from RTC at offset: %#x\n", daddr);
+
+    switch (daddr) {
+      case DataReg:
+        data = timeVal + ((curTick() - lastWrittenTick) / SimClock::Int::s);
+        break;
+      case MatchReg:
+        data = matchVal;
+        break;
+      case LoadReg:
+        data = loadVal;
+        break;
+      case ControlReg:
+        data = 1; // Always enabled otherwise there is no point
+        break;
+      case IntMask:
+        data = maskInt;
+        break;
+      case RawISR:
+        data = rawInt;
+        break;
+      case MaskedISR:
+        data = pendingInt;
+        break;
+      default:
+        if (AmbaDev::readId(pkt, ambaId, pioAddr)) {
+            // Hack for variable sized access
+            data = pkt->get<uint32_t>();
+            break;
+        }
+        panic("Tried to read PL031 at offset %#x that doesn't exist\n", daddr);
+        break;
+    }
+
+    switch(pkt->getSize()) {
+      case 1:
+        pkt->set<uint8_t>(data);
+        break;
+      case 2:
+        pkt->set<uint16_t>(data);
+        break;
+      case 4:
+        pkt->set<uint32_t>(data);
+        break;
+      default:
+        panic("Uart read size too big?\n");
+        break;
+    }
+
+
+    pkt->makeAtomicResponse();
+    return pioDelay;
+}
+
+Tick
+PL031::write(PacketPtr pkt)
+{
+    assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize);
+    assert(pkt->getSize() == 4);
+    Addr daddr = pkt->getAddr() - pioAddr;
+    pkt->allocate();
+    DPRINTF(Timer, "Writing to RTC at offset: %#x\n", daddr);
+
+    switch (daddr) {
+      case DataReg:
+        break;
+      case MatchReg:
+        matchVal = pkt->get<uint32_t>();
+        resyncMatch();
+        break;
+      case LoadReg:
+        lastWrittenTick = curTick();
+        timeVal = pkt->get<uint32_t>();
+        loadVal = timeVal;
+        resyncMatch();
+        break;
+      case ControlReg:
+        break; // Can't stop when started
+      case IntMask:
+        maskInt = pkt->get<uint32_t>();
+        break;
+      case IntClear:
+        if (pkt->get<uint32_t>()) {
+            rawInt = false;
+            pendingInt = false;
+        }
+        break;
+      default:
+        if (AmbaDev::readId(pkt, ambaId, pioAddr))
+            break;
+        panic("Tried to read PL031 at offset %#x that doesn't exist\n", daddr);
+        break;
+    }
+
+    pkt->makeAtomicResponse();
+    return pioDelay;
+}
+
+void
+PL031::resyncMatch()
+{
+    DPRINTF(Timer, "Setting up new match event match=%d time=%d\n", matchVal,
+            timeVal);
+
+    uint32_t seconds_until = matchVal - timeVal;
+    Tick ticks_until = SimClock::Int::s * seconds_until;
+
+    if (matchEvent.scheduled()) {
+        DPRINTF(Timer, "-- Event was already schedule, de-scheduling\n");
+        deschedule(matchEvent);
+    }
+    schedule(matchEvent, curTick() + ticks_until);
+    DPRINTF(Timer, "-- Scheduling new event for: %d\n", curTick() + ticks_until);
+}
+
+void
+PL031::counterMatch()
+{
+    DPRINTF(Timer, "Counter reached zero\n");
+
+    rawInt = true;
+    bool old_pending = pendingInt;
+    pendingInt = maskInt & rawInt;
+    if (pendingInt && ~old_pending) {
+        DPRINTF(Timer, "-- Causing interrupt\n");
+        gic->sendInt(intNum);
+    }
+}
+
+void
+PL031::serialize(std::ostream &os)
+{
+    DPRINTF(Checkpoint, "Serializing Arm PL031\n");
+    SERIALIZE_SCALAR(timeVal);
+    SERIALIZE_SCALAR(lastWrittenTick);
+    SERIALIZE_SCALAR(loadVal);
+    SERIALIZE_SCALAR(matchVal);
+    SERIALIZE_SCALAR(rawInt);
+    SERIALIZE_SCALAR(maskInt);
+    SERIALIZE_SCALAR(pendingInt);
+
+    bool is_in_event = matchEvent.scheduled();
+    SERIALIZE_SCALAR(is_in_event);
+
+    Tick event_time;
+    if (is_in_event){
+        event_time = matchEvent.when();
+        SERIALIZE_SCALAR(event_time);
+    }
+}
+
+void
+PL031::unserialize(Checkpoint *cp, const std::string &section)
+{
+    DPRINTF(Checkpoint, "Unserializing Arm PL031\n");
+
+    UNSERIALIZE_SCALAR(timeVal);
+    UNSERIALIZE_SCALAR(lastWrittenTick);
+    UNSERIALIZE_SCALAR(loadVal);
+    UNSERIALIZE_SCALAR(matchVal);
+    UNSERIALIZE_SCALAR(rawInt);
+    UNSERIALIZE_SCALAR(maskInt);
+    UNSERIALIZE_SCALAR(pendingInt);
+
+    bool is_in_event;
+    UNSERIALIZE_SCALAR(is_in_event);
+
+    Tick event_time;
+    if (is_in_event){
+        UNSERIALIZE_SCALAR(event_time);
+        schedule(matchEvent, event_time);
+    }
+}
+
+
+
+PL031 *
+PL031Params::create()
+{
+    return new PL031(this);
+}
diff --git a/src/dev/arm/rtc_pl031.hh b/src/dev/arm/rtc_pl031.hh
new file mode 100644
index 000000000..f5615dd55
--- /dev/null
+++ b/src/dev/arm/rtc_pl031.hh
@@ -0,0 +1,136 @@
+/*
+ * Copyright (c) 2010-2012 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: Ali Saidi
+ */
+
+#ifndef __DEV_ARM_RTC_PL310_HH__
+#define __DEV_ARM_RTC_PL310_HH__
+
+#include "base/range.hh"
+#include "dev/arm/amba_device.hh"
+#include "params/PL031.hh"
+
+/** @file
+ * This implements the ARM Primecell 031 RTC
+ */
+
+class PL031 : public AmbaIntDevice
+{
+  protected:
+    enum {
+        DataReg    = 0x00,
+        MatchReg   = 0x04,
+        LoadReg    = 0x08,
+        ControlReg = 0x0C,
+        IntMask    = 0x10,
+        RawISR     = 0x14,
+        MaskedISR  = 0x18,
+        IntClear   = 0x1C,
+    };
+
+    /* Seconds since epoch that correspond to time simulation was started at the
+     * begining of simulation and is then updated if ever written. */
+    uint32_t timeVal;
+
+    /* Time when the timeVal register was written */
+    Tick lastWrittenTick;
+
+    /* Previous load value */
+    uint32_t loadVal;
+
+    /* RTC Match Value
+     * Cause an interrupt when this value hits counter
+     */
+    uint32_t matchVal;
+
+    /** If timer has caused an interrupt. This is irrespective of
+     * interrupt enable */
+    bool rawInt;
+
+    /** If the timer interrupt mask that is anded with the raw interrupt to
+     * generate a pending interrupt
+     */
+    bool maskInt;
+
+    /** If an interrupt is currently pending. Logical and of CTRL.intEnable
+     * and rawInt */
+    bool pendingInt;
+
+    /** Called when the counter reaches matches */
+    void counterMatch();
+    EventWrapper<PL031, &PL031::counterMatch> matchEvent;
+
+    /** Called to update the matchEvent when the load Value or match value are
+     * written.
+     */
+    void resyncMatch();
+
+  public:
+    typedef PL031Params Params;
+    const Params *
+    params() const
+    {
+        return dynamic_cast<const Params *>(_params);
+    }
+    /**
+      * The constructor for RealView just registers itself with the MMU.
+      * @param p params structure
+      */
+    PL031(Params *p);
+
+    /**
+     * Handle a read to the device
+     * @param pkt The memory request.
+     * @param data Where to put the data.
+     */
+    virtual Tick read(PacketPtr pkt);
+
+    /**
+     * Handle writes to the device
+     * @param pkt The memory request.
+     * @param data the data
+     */
+    virtual Tick write(PacketPtr pkt);
+
+
+    virtual void serialize(std::ostream &os);
+    virtual void unserialize(Checkpoint *cp, const std::string &section);
+};
+
+
+#endif // __DEV_ARM_RTC_PL031_HH__
+
diff --git a/src/dev/mc146818.cc b/src/dev/mc146818.cc
index b0aaf6e64..b3b0136f0 100644
--- a/src/dev/mc146818.cc
+++ b/src/dev/mc146818.cc
@@ -176,24 +176,6 @@ MC146818::readData(uint8_t addr)
     }
 }
 
-static time_t
-mkutctime(struct tm *time)
-{
-    time_t ret;
-    char *tz;
-
-    tz = getenv("TZ");
-    setenv("TZ", "", 1);
-    tzset();
-    ret = mktime(time);
-    if (tz)
-        setenv("TZ", tz, 1);
-    else
-        unsetenv("TZ");
-    tzset();
-    return ret;
-}
-
 void
 MC146818::tickClock()
 {