/* PS2Keyboard.cpp - PS2Keyboard library Copyright (c) 2007 Free Software Foundation. All right reserved. Written by Christian Weichel ** Mostly rewritten Paul Stoffregen 2010, 2011 ** Modified for use beginning with Arduino 13 by L. Abraham Smith, * ** Modified for easy interrup pin assignement on method begin(datapin,irq_pin). Cuningan ** for more information you can read the original wiki in arduino.cc at http://www.arduino.cc/playground/Main/PS2Keyboard or http://www.pjrc.com/teensy/td_libs_PS2Keyboard.html Version 2.1 (May 2011) - timeout to recover from misaligned input - compatibility with Arduino "new-extension" branch - TODO: send function, proposed by Scott Penrose, scooterda at me dot com Version 2.0 (June 2010) - Buffering added, many scan codes can be captured without data loss if your sketch is busy doing other work - Shift keys supported, completely rewritten scan code to ascii - Slow linear search replaced with fast indexed table lookups - Support for Teensy, Arduino Mega, and Sanguino added This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include #include #if defined(ARDUINO) && ARDUINO >= 100 #include "Arduino.h" // for attachInterrupt, FALLING #else #include "WProgram.h" #endif #include "PS2Keyboard.h" #define BUFFER_SIZE 45 static volatile uint8_t buffer[BUFFER_SIZE]; static volatile uint8_t head, tail; static uint8_t ps2Keyboard_DataPin; static char ps2Keyboard_CharBuffer=0; // The ISR for the external interrupt void ps2interrupt(void) { static uint8_t bitcount=0; static uint8_t incoming=0; static uint32_t prev_ms=0; uint32_t now_ms; uint8_t n, val; val = digitalRead(ps2Keyboard_DataPin); now_ms = millis(); if (now_ms - prev_ms > 250) { bitcount = 0; incoming = 0; } prev_ms = now_ms; n = bitcount - 1; if (n <= 7) { incoming |= (val << n); } bitcount++; if (bitcount == 11) { uint8_t i = head + 1; if (i >= BUFFER_SIZE) i = 0; if (i != tail) { buffer[i] = incoming; head = i; } bitcount = 0; incoming = 0; } } static inline uint8_t get_scan_code(void) { uint8_t c, i; i = tail; if (i == head) return 0; i++; if (i >= BUFFER_SIZE) i = 0; c = buffer[i]; tail = i; return c; } // http://www.quadibloc.com/comp/scan.htm // http://www.computer-engineering.org/ps2keyboard/scancodes2.html #define BREAK 0x01 #define MODIFIER 0x02 #define SHIFT_L 0x04 #define SHIFT_R 0x08 // These arrays provide a simple key map, to turn scan codes into ASCII // output. If a non-US keyboard is used, these may need to be modified // for the desired output. // static PROGMEM unsigned char scan2ascii_noshift[] = { 0, PS2_F9, 0, PS2_F5, PS2_F3, PS2_F1, PS2_F2, PS2_F12, 0, PS2_F10, PS2_F8, PS2_F6, PS2_F4, PS2_TAB, '`', 0, 0, 0 /*Lalt*/, 0 /*Lshift*/, 0, 0 /*Lctrl*/, 'q', '1', 0, 0, 0, 'z', 's', 'a', 'w', '2', 0, 0, 'c', 'x', 'd', 'e', '4', '3', 0, 0, ' ', 'v', 'f', 't', 'r', '5', 0, 0, 'n', 'b', 'h', 'g', 'y', '6', 0, 0, 0, 'm', 'j', 'u', '7', '8', 0, 0, ',', 'k', 'i', 'o', '0', '9', 0, 0, '.', '/', 'l', ';', 'p', '-', 0, 0, 0, '\'', 0, '[', '=', 0, 0, 0 /*CapsLock*/, 0 /*Rshift*/, PS2_ENTER /*Enter*/, ']', 0, '\\', 0, 0, 0, 0, 0, 0, 0, 0, PS2_BACKSPACE, 0, 0, '1', 0, '4', '7', 0, 0, 0, '0', '.', '2', '5', '6', '8', PS2_ESC, 0 /*NumLock*/, PS2_F11, '+', '3', '-', '*', '9', PS2_SCROLL, 0, 0, 0, 0, PS2_F7 }; static PROGMEM unsigned char scan2ascii_shift[] = { 0, PS2_F9, 0, PS2_F5, PS2_F3, PS2_F1, PS2_F2, PS2_F12, 0, PS2_F10, PS2_F8, PS2_F6, PS2_F4, PS2_TAB, '~', 0, 0, 0 /*Lalt*/, 0 /*Lshift*/, 0, 0 /*Lctrl*/, 'Q', '!', 0, 0, 0, 'Z', 'S', 'A', 'W', '@', 0, 0, 'C', 'X', 'D', 'E', '$', '#', 0, 0, ' ', 'V', 'F', 'T', 'R', '%', 0, 0, 'N', 'B', 'H', 'G', 'Y', '^', 0, 0, 0, 'M', 'J', 'U', '&', '*', 0, 0, '<', 'K', 'I', 'O', ')', '(', 0, 0, '>', '?', 'L', ':', 'P', '_', 0, 0, 0, '"', 0, '{', '+', 0, 0, 0 /*CapsLock*/, 0 /*Rshift*/, PS2_ENTER /*Enter*/, '}', 0, '|', 0, 0, 0, 0, 0, 0, 0, 0, PS2_BACKSPACE, 0, 0, '1', 0, '4', '7', 0, 0, 0, '0', '.', '2', '5', '6', '8', PS2_ESC, 0 /*NumLock*/, PS2_F11, '+', '3', '-', '*', '9', PS2_SCROLL, 0, 0, 0, 0, PS2_F7 }; static char get_ascii_code(void) { static uint8_t state=0; uint8_t s; char c; while (1) { s = get_scan_code(); if (!s) return 0; if (s == 0xF0) { state |= BREAK; } else if (s == 0xE0) { state |= MODIFIER; } else { if (state & BREAK) { if (s == 0x12) { state &= ~SHIFT_L; } else if (s == 0x59) { state &= ~SHIFT_R; } // CTRL, ALT & WIN keys could be added // but is that really worth the overhead? state &= ~(BREAK | MODIFIER); continue; } if (s == 0x12) { state |= SHIFT_L; continue; } else if (s == 0x59) { state |= SHIFT_R; continue; } c = 0; if (state & MODIFIER) { switch (s) { case 0x70: c = PS2_INSERT; break; case 0x6C: c = PS2_HOME; break; case 0x7D: c = PS2_PAGEUP; break; case 0x71: c = PS2_DELETE; break; case 0x69: c = PS2_END; break; case 0x7A: c = PS2_PAGEDOWN; break; case 0x75: c = PS2_UPARROW; break; case 0x6B: c = PS2_LEFTARROW; break; case 0x72: c = PS2_DOWNARROW; break; case 0x74: c = PS2_RIGHTARROW; break; case 0x4A: c = '/'; break; case 0x5A: c = PS2_ENTER; break; default: break; } } else if (state & (SHIFT_L | SHIFT_R)) { if (s < sizeof(scan2ascii_shift)) c = pgm_read_byte(scan2ascii_shift + s); } else { if (s < sizeof(scan2ascii_noshift)) c = pgm_read_byte(scan2ascii_noshift + s); } state &= ~(BREAK | MODIFIER); if (c) return c; } } } bool PS2Keyboard::available() { if (ps2Keyboard_CharBuffer) return true; ps2Keyboard_CharBuffer = get_ascii_code(); if (ps2Keyboard_CharBuffer) return true; return false; } int PS2Keyboard::read() { char result; result = ps2Keyboard_CharBuffer; if (result) { ps2Keyboard_CharBuffer = 0; } else { result = get_ascii_code(); } if (!result) return -1; return result; } PS2Keyboard::PS2Keyboard() { // nothing to do here, begin() does it all } void PS2Keyboard::begin(uint8_t dataPin, uint8_t irq_pin) { uint8_t irq_num=0; ps2Keyboard_DataPin = dataPin; // initialize the pins #ifdef INPUT_PULLUP pinMode(irq_pin, INPUT_PULLUP); pinMode(dataPin, INPUT_PULLUP); #else pinMode(irq_pin, INPUT); digitalWrite(irq_pin, HIGH); pinMode(dataPin, INPUT); digitalWrite(dataPin, HIGH); #endif switch(irq_pin) { #ifdef CORE_INT0_PIN case CORE_INT0_PIN: irq_num = 0; break; #endif #ifdef CORE_INT1_PIN case CORE_INT1_PIN: irq_num = 1; break; #endif #ifdef CORE_INT2_PIN case CORE_INT2_PIN: irq_num = 2; break; #endif #ifdef CORE_INT3_PIN case CORE_INT3_PIN: irq_num = 3; break; #endif #ifdef CORE_INT4_PIN case CORE_INT4_PIN: irq_num = 4; break; #endif #ifdef CORE_INT5_PIN case CORE_INT5_PIN: irq_num = 5; break; #endif #ifdef CORE_INT6_PIN case CORE_INT6_PIN: irq_num = 6; break; #endif #ifdef CORE_INT7_PIN case CORE_INT7_PIN: irq_num = 7; break; #endif default: irq_num = 0; break; } head = 0; tail = 0; attachInterrupt(irq_num, ps2interrupt, FALLING); }