include/pedigree/kernel/machine/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_TIMER_H
#define KERNEL_MACHINE_TIMER_H

#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/time/Time.h"

class TimerHandler;

class Timer
{
  public:
    virtual size_t getYear() = 0;
    virtual uint8_t getMonth() = 0;
    virtual uint8_t getDayOfMonth() = 0;
    virtual uint8_t getDayOfWeek() = 0;
    virtual uint8_t getHour() = 0;
    virtual uint8_t getMinute() = 0;
    virtual uint8_t getSecond() = 0;
    virtual uint64_t getNanosecond() = 0;

    virtual uint64_t getTickCount() = 0;
    virtual uint64_t getTickCountNano()
    {
        return getTickCount() * 1000U;
    }

    virtual Time::Timestamp getUnixTimestamp();

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

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

    virtual void synchronise(bool tohw = false)
    {
    }

  protected:
    inline Timer()
    {
    }
    inline virtual ~Timer()
    {
    }

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

#endif