include/pedigree/kernel/machine/Machine.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 MACHINE_MACHINE_H
#define MACHINE_MACHINE_H
 
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/processor/types.h"
 
class IrqManager;
class Keyboard;
class SchedulerTimer;
class Serial;
class Timer;
class Vga;
 
class EXPORTED_PUBLIC Machine {
  friend void system_reset();
 
 public:
  enum class ShutdownType { Restart, Halt, PowerOff };
  enum class ShutdownPhase {
    NotStarted,
    Requested,
    Userspace,
    Syscalls,
    Filesystems,
    Modules,
    Firmware,
    Destructors,
    Input,
    Caches,
    Timers,
    Devices,
    Processors,
    ProcessorCleanup,
    FinalAction,
  };
 
  static void setShutdownPhase(ShutdownPhase phase, const char* detail = nullptr);
  static void setShutdownDetail(const char* detail);
  static const char* shutdownPhaseName();
 
  static Machine& instance();
 
  virtual bool supportsPowerOff() const {
    return false;
  }
  virtual bool prepareShutdown(ShutdownType type) {
    return true;
  }
  virtual const char* finalShutdown(ShutdownType type);
 
  void displayShutdownMessage(const char* message);
 
  virtual void initialise() = 0;
  virtual void initialise2() {}
  virtual void initialise3() {}
  virtual void deinitialise() {
    m_bInitialised = false;
  }
  inline bool isInitialised() {
    return m_bInitialised;
  }
 
  virtual void initialiseDeviceTree() {}
 
  virtual Serial* getSerial(size_t n) = 0;
 
  virtual size_t getNumSerial() = 0;
 
  virtual Vga* getVga(size_t n) = 0;
 
  virtual size_t getNumVga() = 0;
 
  virtual IrqManager* getIrqManager() = 0;
  virtual SchedulerTimer* getSchedulerTimer() = 0;
 
  virtual Timer* getTimer() = 0;
 
  virtual Keyboard* getKeyboard() = 0;
 
  virtual void setKeyboard(Keyboard* kb) = 0;
 
  MUST_USE_RESULT virtual bool quiesceAllOtherProcessors();
 
  MUST_USE_RESULT virtual bool resumeAllOtherProcessors();
 
  MUST_USE_RESULT virtual bool stopAllOtherProcessors();
 
 protected:
  inline Machine() : m_bInitialised(false) {}
  virtual ~Machine();
 
  bool m_bInitialised;
 
 private:
  Machine(const Machine&);
  Machine& operator=(const Machine&);
};
 
#endif