GPTimer.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include "pedigree/kernel/machine/SchedulerTimer.h"
#include "pedigree/kernel/machine/Timer.h"
#include "pedigree/kernel/processor/InterruptManager.h"
#include "pedigree/kernel/processor/MemoryRegion.h"
#include "pedigree/kernel/utilities/List.h"

#define MAX_TIMER_HANDLERS 32

class SyncTimer
{
  public:
    SyncTimer() : m_MmioBase("SyncTimer")
    {
    }
    virtual ~SyncTimer()
    {
    }

    void initialise(uintptr_t base);

    uint32_t getTickCount();

  private:
    MemoryRegion m_MmioBase;
};

class GPTimer : public Timer, public SchedulerTimer, public InterruptHandler
{
  public:
    inline GPTimer()
        : m_MmioBase("GPTimer"), m_bIrqInstalled(false), m_Irq(0), m_Handlers(),
          m_Alarms(), m_TickCount(0)
    {
        for (int i = 0; i < MAX_TIMER_HANDLERS; i++)
            m_Handlers[i] = 0;
    }
    inline virtual ~GPTimer()
    {
    }

    void initialise(size_t timer, uintptr_t base);

    virtual size_t getYear()
    {
        return 0;
    }
    virtual uint8_t getMonth()
    {
        return 0;
    }
    virtual uint8_t getDayOfMonth()
    {
        return 0;
    }
    virtual uint8_t getDayOfWeek()
    {
        return 0;
    }
    virtual uint8_t getHour()
    {
        return 0;
    }
    virtual uint8_t getMinute()
    {
        return 0;
    }
    virtual uint8_t getSecond()
    {
        return 0;
    }
    virtual uint64_t getNanosecond()
    {
        return 0;
    }

    virtual uint64_t getTickCount()
    {
        extern SyncTimer g_SyncTimer;
        return g_SyncTimer.getTickCount();
    }

    virtual bool registerHandler(TimerHandler *handler);
    virtual bool unregisterHandler(TimerHandler *handler);

    virtual void
    addAlarm(class Event *pEvent, size_t alarmSecs, size_t alarmUsecs = 0);
    virtual void removeAlarm(class Event *pEvent);
    virtual size_t removeAlarm(class Event *pEvent, bool bRetZero);

  private:
    GPTimer(const Timer &);
    GPTimer &operator=(const Timer &);

    virtual void interrupt(size_t nInterruptnumber, InterruptState &state);

    MemoryRegion m_MmioBase;

    bool m_bIrqInstalled;

    size_t m_Irq;

    TimerHandler *m_Handlers[MAX_TIMER_HANDLERS];

    class Alarm
    {
      public:
        Alarm(class Event *pEvent, size_t time, class Thread *pThread)
            : m_pEvent(pEvent), m_Time(time), m_pThread(pThread)
        {
        }
        class Event *m_pEvent;
        size_t m_Time;
        class Thread *m_pThread;

      private:
        Alarm(const Alarm &);
        Alarm &operator=(const Alarm &);
    };

    List<Alarm *> m_Alarms;

    uint64_t m_TickCount;

    enum Registers
    {
        TIDR = 0x00 / 4,       // R
        TIOCP_CFG = 0x10 / 4,  // RW
        TISTAT = 0x14 / 4,     // R
        TISR = 0x18 / 4,       // RW
        TIER = 0x1C / 4,       // RW
        TWER = 0x20 / 4,       // RW
        TCLR = 0x24 / 4,       // RW
        TCRR = 0x28 / 4,       // RW
        TLDR = 0x2C / 4,       // RW
        TTGR = 0x30 / 4,       // RW
        TWPS = 0x34 / 4,       // R
        TMAR = 0x38 / 4,       // RW
        TCAR1 = 0x3C / 4,      // R
        TSICR = 0x40 / 4,      // RW
        TCAR2 = 0x44 / 4,      // R
        TPIR = 0x48 / 4,       // RW
        TNIR = 0x4C / 4,       // RW
        TCVR = 0x50 / 4,       // RW
        TOCR = 0x54 / 4,       // RW
        TOWR = 0x58 / 4,       // RW
    };
};