kernel/machine/hosted/Timer.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.
 */

#ifndef KERNEL_MACHINE_HOSTED_COMMON_TIMER_H
#define KERNEL_MACHINE_HOSTED_COMMON_TIMER_H

#include "pedigree/kernel/machine/IrqManager.h"
#include "pedigree/kernel/machine/SchedulerTimer.h"
#include "pedigree/kernel/machine/Timer.h"

namespace __pedigree_hosted
{
#include <signal.h>
#include <time.h>
}  // namespace __pedigree_hosted

#define MAX_TIMER_HANDLERS 32

class HostedTimer : public Timer, private IrqHandler
{
  public:
    inline static HostedTimer &instance()
    {
        return m_Instance;
    }

    //
    // Timer interface
    //
    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);
    virtual size_t getYear();
    virtual uint8_t getMonth();
    virtual uint8_t getDayOfMonth();
    virtual uint8_t getDayOfWeek();
    virtual uint8_t getHour();
    virtual uint8_t getMinute();
    virtual uint8_t getSecond();
    virtual uint64_t getNanosecond();
    virtual uint64_t getTickCount();
    virtual uint64_t getTickCountNano();

    bool initialise() INITIALISATION_ONLY;
    virtual void synchronise(bool tohw = false);
    void uninitialise();

  protected:
    HostedTimer() INITIALISATION_ONLY;
    inline virtual ~HostedTimer()
    {
    }

  private:
    HostedTimer(const HostedTimer &);
    HostedTimer &operator=(const HostedTimer &);

    //
    // IrqHandler interface
    //
    virtual bool irq(irq_id_t number, InterruptState &state);

    size_t m_Year;
    uint8_t m_Month;
    uint8_t m_DayOfMonth;
    uint8_t m_DayOfWeek;
    uint8_t m_Hour;
    uint8_t m_Minute;
    uint8_t m_Second;
    uint64_t m_Nanosecond;

    __pedigree_hosted::timer_t m_Timer;

    irq_id_t m_IrqId;

    static HostedTimer m_Instance;

    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;
};

#endif