git.mutantstargoat.com Git - bootcensus/blob - src/keyb.h

   1 /*
   2 pcboot - bootable PC demo/game kernel
   3 Copyright (C) 2018  John Tsiombikas <nuclear@member.fsf.org>
   4
   5 This program is free software: you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation, either version 3 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY, without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17 */
  18 #ifndef KEYB_H_
  19 #define KEYB_H_
  20
  21 #define KB_ANY          (-1)
  22 #define KB_ALT          (-2)
  23 #define KB_CTRL         (-3)
  24 #define KB_SHIFT        (-4)
  25
  26 /* special keys */
  27 enum {
  28         KB_ESC = 27,
  29         KB_INSERT, KB_DEL, KB_HOME, KB_END, KB_PGUP, KB_PGDN,
  30         KB_LEFT, KB_RIGHT, KB_UP, KB_DOWN,
  31         KB_NUM_DOT, KB_NUM_ENTER, KB_NUM_PLUS, KB_NUM_MINUS, KB_NUM_MUL, KB_NUM_DIV,
  32         KB_NUM_0, KB_NUM_1, KB_NUM_2, KB_NUM_3, KB_NUM_4,
  33         KB_NUM_5, KB_NUM_6, KB_NUM_7, KB_NUM_8, KB_NUM_9,
  34         KB_BACKSP = 127,
  35
  36         KB_LALT, KB_RALT,
  37         KB_LCTRL, KB_RCTRL,
  38         KB_LSHIFT, KB_RSHIFT,
  39         KB_F1, KB_F2, KB_F3, KB_F4, KB_F5, KB_F6,
  40         KB_F7, KB_F8, KB_F9, KB_F10, KB_F11, KB_F12,
  41         KB_CAPSLK, KB_NUMLK, KB_SCRLK, KB_SYSRQ
  42 };
  43
  44 void kb_init(void);
  45
  46 /* Boolean predicate for testing the current state of a particular key.
  47  * You may also pass KB_ANY to test if any key is held down.
  48  */
  49 int kb_isdown(int key);
  50
  51 /* waits for any keypress */
  52 void kb_wait(void);
  53
  54 /* removes and returns a single key from the input buffer. */
  55 int kb_getkey(void);
  56
  57 void kb_putback(int key);
  58
  59 /* returns 1 if the keyboard controller is ready to read/write
  60  * returns 0 if the wait times out
  61  */
  62 int kb_wait_write(void);
  63 int kb_wait_read(void);
  64
  65 void kb_send_cmd(unsigned char cmd);
  66 void kb_send_data(unsigned char data);
  67 unsigned char kb_read_data(void);
  68
  69 #endif  /* KEYB_H_ */