Pit.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_PIT_H
#define KERNEL_MACHINE_X86_COMMON_PIT_H
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/SchedulerIrqHandler.h"
#include "pedigree/kernel/machine/SchedulerTimer.h"
#include "pedigree/kernel/machine/SchedulerTimerHandlerSlot.h"
#include "pedigree/kernel/machine/types.h"
#include "pedigree/kernel/processor/IoPort.h"
#include "pedigree/kernel/processor/state_forward.h"
 
#include <config.h>
 
class SchedulerTimerHandler;
 
class Pit : public SchedulerTimer, private SchedulerIrqHandler {
 public:
  inline static Pit& instance() {
    return m_Instance;
  }
 
  //
  // SchedulerTimer interface
  //
  virtual bool registerHandler(SchedulerTimerHandler* handler);
  uint64_t nominalQuantumNs() const override;
  virtual bool removeHandler(SchedulerTimerHandler* handler);
 
  bool initialise() INITIALISATION_ONLY;
  void uninitialise();
 
 protected:
  Pit() INITIALISATION_ONLY;
  inline virtual ~Pit() {}
 
 private:
  Pit(const Pit&);
  Pit& operator=(const Pit&);
 
  //
  // SchedulerIrqHandler interface
  //
  virtual void schedulerIrq(irq_id_t number, InterruptState& state);
 
  IoPort m_IoPort;
  irq_id_t m_IrqId;
  SchedulerTimerHandlerSlot m_Handler;
 
  static Pit m_Instance;
};
 
#endif