Rtc.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_X86_COMMON_RTC_H
#define KERNEL_MACHINE_X86_COMMON_RTC_H

#include "pedigree/kernel/Spinlock.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/IrqHandler.h"
#include "pedigree/kernel/machine/Timer.h"
#include "pedigree/kernel/machine/types.h"
#include "pedigree/kernel/processor/IoPort.h"
#include "pedigree/kernel/processor/state_forward.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/List.h"
#include "pedigree/kernel/utilities/new"

class TimerHandler;

#define MAX_TIMER_HANDLERS 32

class Rtc : public Timer, private IrqHandler
{
  public:
    inline static Rtc &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 initialise1() INITIALISATION_ONLY;
    bool initialise2() INITIALISATION_ONLY;
    virtual void synchronise(bool tohw = false);
    void uninitialise();

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

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

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

    void setIndex(uint8_t index);
    void waitForUpdateCompletion(uint8_t index);
    void enableRtcUpdates(bool enable);
    uint8_t read(uint8_t index);
    void write(uint8_t index, uint8_t value);

    IoPort m_IoPort;

    irq_id_t m_IrqId;

    size_t m_PeriodicIrqInfoIndex;

    bool m_bBCD;

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

    uint64_t m_TickCount;

    struct periodicIrqInfo_t
    {
        size_t Hz;
        uint8_t rateBits;
        uint64_t ns[2];
    };

    static periodicIrqInfo_t periodicIrqInfo[12];

    static Rtc 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;
    Spinlock m_Lock;

    uint64_t m_TscTicksPerNanosecond;

    uint64_t m_Tsc0;
};

#endif