include/pedigree/kernel/machine/Keyboard.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_KEYBOARD_H
#define MACHINE_KEYBOARD_H
 
class Keyboard {
 public:
  enum KeyFlags {
    Special = 1ULL << 63,
    Ctrl = 1ULL << 62,
    Shift = 1ULL << 61,
    Alt = 1ULL << 60,
    AltGr = 1ULL << 59
  };
 
  enum KeyboardLeds {
    ScrollLock = 1 << 0,
 
    NumLock = 1 << 1,
 
    CapsLock = 1 << 2,
 
    Led1 = 1 << 3,
    Led2 = 1 << 4,
    Led3 = 1 << 5,
    Led4 = 1 << 6,
    Led5 = 1 << 7,
  };
 
  Keyboard();
  virtual ~Keyboard();
 
  virtual void initialise() = 0;
 
  virtual void setDebugState(bool enableDebugState) = 0;
  virtual bool getDebugState() = 0;
 
  virtual char getChar() = 0;
 
  virtual char getCharNonBlock() = 0;
 
  virtual char getLedState();
 
  virtual void setLedState(char state);
};
 
#endif