Pc.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_PC_H
#define KERNEL_MACHINE_X86_COMMON_PC_H
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/Bus.h"
#include "pedigree/kernel/machine/Controller.h"
#include "pedigree/kernel/machine/Device.h"
#include "pedigree/kernel/machine/Machine.h"
#include "pedigree/kernel/processor/types.h"
 
#include <config.h>
 
#include "Keyboard.h"
#include "LocalApic.h"
#include "PcSchedulerTimerSelection.h"
#include "Ps2Controller.h"
#include "Serial.h"
#include "Vga.h"
 
class IrqManager;
class Keyboard;
class SchedulerTimer;
class Serial;
class Timer;
class Vga;
 
class Pc : public Machine {
 public:
  inline static Pc& instance() {
    return m_Instance;
  }
 
  virtual void initialise() INITIALISATION_ONLY;
  virtual void initialise3();
  virtual void deinitialise();
  bool supportsPowerOff() const override;
  bool prepareShutdown(ShutdownType type) override;
  void finalShutdown(ShutdownType type) override;
 
#if MULTIPROCESSOR
  void initialiseProcessor() INITIALISATION_ONLY;
#endif
 
  virtual void initialiseDeviceTree();
 
  virtual Serial* getSerial(size_t n);
  virtual size_t getNumSerial();
  virtual Vga* getVga(size_t n);
  virtual size_t getNumVga();
  virtual IrqManager* getIrqManager();
  virtual SchedulerTimer* getSchedulerTimer();
  virtual Timer* getTimer();
  virtual Keyboard* getKeyboard();
  virtual void setKeyboard(Keyboard* kb);
 
  inline bool localApicAvailable() const {
    return m_SchedulerTimerSelection.usesLocalApic();
  }
 
#if MULTIPROCESSOR
  inline LocalApic& getLocalApic() {
    return *m_LocalApic;
  }
#endif
 
#if MULTIPROCESSOR
  MUST_USE_RESULT bool quiesceAllOtherProcessors() override;
  MUST_USE_RESULT bool resumeAllOtherProcessors() override;
  MUST_USE_RESULT bool stopAllOtherProcessors() override;
#endif
 
 private:
  Pc() INITIALISATION_ONLY;
  Pc(const Pc&);
  Pc& operator=(const Pc&);
  virtual ~Pc();
 
  X86Serial* m_pSerial[4];
  X86Vga* m_Vga;
  Keyboard* m_pKeyboard;
 
#if MULTIPROCESSOR
  LocalApic* m_LocalApic;
#endif
 
  PcSchedulerTimerSelection m_SchedulerTimerSelection;
 
  static Pc m_Instance;
 
  // Hardware devices.
  X86Keyboard* m_Keyboard;
  Bus* m_IsaBus;
  Controller* m_AtaMaster;
  Controller* m_AtaSlave;
  Ps2Controller* m_Ps2Controller;
  Device* m_Watchdog;
};
 
#endif