Mercurial > louis > kiibohd-controller
changeset 47:0ee2207c5919
Initial commit of the Burroughs Ergonomic Terminal Keyboard module (BETKB)
- Doesn't work yet
| author | Jacob Alexander <triplehaata@gmail.com> |
|---|---|
| date | Mon, 26 Mar 2012 19:02:46 -0400 |
| parents | 4427da7db226 |
| children | 8eee22f99cae |
| files | Keymap/betkb.h Keymap/keymap.h Scan/BETKB/scan_loop.c Scan/BETKB/scan_loop.h Scan/BETKB/setup.cmake setup.cmake |
| diffstat | 6 files changed, 672 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Keymap/betkb.h Mon Mar 26 19:02:46 2012 -0400 @@ -0,0 +1,296 @@ +/* Copyright (C) 2012 by Jacob Alexander + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#ifndef __BETKB_H +#define __BETKB_H + +// This file contains various key layouts for the Burroughs Ergonomic Terminal Keyboard (Kokusai) + + +// ----- Variables ----- +static uint8_t betkb_ModifierMask[] = { 0x48, 0x49, 0x4C, 0x4D, 0x45, 0x14 }; + +static uint8_t betkb_DefaultMap[] = { + KEY_TILDE, // 0x00 + KEY_UP, // 0x01 + 0, // 0x02 + 0, // 0x03 + KEY_PRINTSCREEN, // 0x04 + KEY_PAGE_DOWN, // 0x05 + KEY_LEFT_BRACE, // 0x06 + KEY_F11, // 0x07 + KEY_BACKSPACE, // 0x08 + KEY_TAB, // 0x09 + KEY_ENTER, // 0x0A + KEY_DOWN, // 0x0B + KEY_PAGE_UP, // 0x0C + KEYPAD_ENTER, // 0x0D + KEY_LEFT, // 0x0E + KEY_RIGHT, // 0x0F + 0, // 0x10 + KEY_PAGE_UP, // 0x11 + KEY_F12, // 0x12 + KEY_PAGE_DOWN, // 0x13 + KEY_GUI, // 0x14 + KEY_F1, // 0x15 + KEY_F2, // 0x16 + KEY_F3, // 0x17 + KEY_F4, // 0x18 + KEY_F5, // 0x19 + KEY_F6, // 0x1A + KEY_ESC, // 0x1B + KEY_F7, // 0x1C + KEY_F8, // 0x1D + KEY_F9, // 0x1E + KEY_F10, // 0x1F + KEY_SPACE, // 0x20 + KEYPAD_9, // 0x21 + 0, // 0x22 + 0, // 0x23 + 0, // 0x24 + 0, // 0x25 + 0, // 0x26 + KEY_QUOTE, // 0x27 + 0, // 0x28 + 0, // 0x29 + 0, // 0x2A + KEY_EQUAL, // 0x2B + KEY_COMMA, // 0x2C + KEY_MINUS, // 0x2D + KEY_PERIOD, // 0x2E + KEY_SLASH, // 0x2F + KEY_0, // 0x30 + KEY_1, // 0x31 + KEY_2, // 0x32 + KEY_3, // 0x33 + KEY_4, // 0x34 + KEY_5, // 0x35 + KEY_6, // 0x36 + KEY_7, // 0x37 + KEY_8, // 0x38 + KEY_9, // 0x39 + 0, // 0x3A + KEY_SEMICOLON, // 0x3B + 0, // 0x3C + KEY_EQUAL, // 0x3D + 0, // 0x3E + 0, // 0x3F + 0, // 0x40 + KEYPAD_6, // 0x41 + KEYPAD_MINUS, // 0x42 + KEY_PAUSE, // 0x43 + KEY_INSERT, // 0x44 + KEY_CTRL, // 0x45 + KEYPAD_2, // 0x46 + KEYPAD_3, // 0x47 + KEY_LEFT_SHIFT, // 0x48 + KEY_RIGHT_SHIFT, // 0x49 + KEYPAD_0, // 0x4A + KEYPAD_PERIOD, // 0x4B + KEY_LEFT_ALT, // 0x4C + KEY_RIGHT_ALT, // 0x4D + 0, // 0x4E + 0, // 0x4F + 0, // 0x50 + 0, // 0x51 + 0, // 0x52 + 0, // 0x53 + 0, // 0x54 + 0, // 0x55 + 0, // 0x56 + 0, // 0x57 + 0, // 0x58 + 0, // 0x59 + 0, // 0x5A + KEY_RIGHT_BRACE, // 0x5B + KEYPAD_7, // 0x5C + KEY_BACKSLASH, // 0x5D + KEY_ESC, // 0x5E + 0, // 0x5F + KEYPAD_1, // 0x60 + KEY_A, // 0x61 + KEY_B, // 0x62 + KEY_C, // 0x63 + KEY_D, // 0x64 + KEY_E, // 0x65 + KEY_F, // 0x66 + KEY_G, // 0x67 + KEY_H, // 0x68 + KEY_I, // 0x69 + KEY_J, // 0x6A + KEY_K, // 0x6B + KEY_L, // 0x6C + KEY_M, // 0x6D + KEY_N, // 0x6E + KEY_O, // 0x6F + KEY_P, // 0x70 + KEY_Q, // 0x71 + KEY_R, // 0x72 + KEY_S, // 0x73 + KEY_T, // 0x74 + KEY_U, // 0x75 + KEY_V, // 0x76 + KEY_W, // 0x77 + KEY_X, // 0x78 + KEY_Y, // 0x79 + KEY_Z, // 0x7A + KEYPAD_4, // 0x7B + KEYPAD_8, // 0x7C + KEYPAD_5, // 0x7D + 0, // 0x7E + KEY_DELETE, // 0x7F +}; + +static uint8_t betkb_ColemakMap[] = { + KEY_TILDE, // 0x00 + KEY_UP, // 0x01 + 0, // 0x02 + 0, // 0x03 + KEY_PRINTSCREEN, // 0x04 + KEY_PAGE_DOWN, // 0x05 + KEY_LEFT_BRACE, // 0x06 + KEY_F11, // 0x07 + KEY_BACKSPACE, // 0x08 + KEY_TAB, // 0x09 + KEY_ENTER, // 0x0A + KEY_DOWN, // 0x0B + KEY_PAGE_UP, // 0x0C + KEYPAD_ENTER, // 0x0D + KEY_LEFT, // 0x0E + KEY_RIGHT, // 0x0F + 0, // 0x10 + KEY_PAGE_UP, // 0x11 + KEY_F12, // 0x12 + KEY_PAGE_DOWN, // 0x13 + KEY_GUI, // 0x14 + KEY_F1, // 0x15 + KEY_F2, // 0x16 + KEY_F3, // 0x17 + KEY_F4, // 0x18 + KEY_F5, // 0x19 + KEY_F6, // 0x1A + KEY_ESC, // 0x1B + KEY_F7, // 0x1C + KEY_F8, // 0x1D + KEY_F9, // 0x1E + KEY_F10, // 0x1F + KEY_SPACE, // 0x20 + KEYPAD_9, // 0x21 + 0, // 0x22 + 0, // 0x23 + 0, // 0x24 + 0, // 0x25 + 0, // 0x26 + KEY_QUOTE, // 0x27 + 0, // 0x28 + 0, // 0x29 + 0, // 0x2A + KEY_EQUAL, // 0x2B + KEY_COMMA, // 0x2C + KEY_MINUS, // 0x2D + KEY_PERIOD, // 0x2E + KEY_SLASH, // 0x2F + KEY_0, // 0x30 + KEY_1, // 0x31 + KEY_2, // 0x32 + KEY_3, // 0x33 + KEY_4, // 0x34 + KEY_5, // 0x35 + KEY_6, // 0x36 + KEY_7, // 0x37 + KEY_8, // 0x38 + KEY_9, // 0x39 + 0, // 0x3A + KEY_O, // 0x3B + 0, // 0x3C + KEY_EQUAL, // 0x3D + 0, // 0x3E + 0, // 0x3F + 0, // 0x40 + KEYPAD_6, // 0x41 + KEYPAD_MINUS, // 0x42 + KEY_PAUSE, // 0x43 + KEY_INSERT, // 0x44 + KEY_CTRL, // 0x45 + KEYPAD_2, // 0x46 + KEYPAD_3, // 0x47 + KEY_LEFT_SHIFT, // 0x48 + KEY_RIGHT_SHIFT, // 0x49 + KEYPAD_0, // 0x4A + KEYPAD_PERIOD, // 0x4B + KEY_LEFT_ALT, // 0x4C + KEY_RIGHT_ALT, // 0x4D + 0, // 0x4E + 0, // 0x4F + 0, // 0x50 + 0, // 0x51 + 0, // 0x52 + 0, // 0x53 + 0, // 0x54 + 0, // 0x55 + 0, // 0x56 + 0, // 0x57 + 0, // 0x58 + 0, // 0x59 + 0, // 0x5A + KEY_RIGHT_BRACE, // 0x5B + KEYPAD_7, // 0x5C + KEY_BACKSLASH, // 0x5D + KEY_ESC, // 0x5E + 0, // 0x5F + KEYPAD_1, // 0x60 + KEY_A, // 0x61 + KEY_B, // 0x62 + KEY_C, // 0x63 + KEY_S, // 0x64 + KEY_F, // 0x65 + KEY_T, // 0x66 + KEY_D, // 0x67 + KEY_H, // 0x68 + KEY_U, // 0x69 + KEY_N, // 0x6A + KEY_E, // 0x6B + KEY_I, // 0x6C + KEY_M, // 0x6D + KEY_K, // 0x6E + KEY_Y, // 0x6F + KEY_SEMICOLON, // 0x70 + KEY_Q, // 0x71 + KEY_P, // 0x72 + KEY_R, // 0x73 + KEY_G, // 0x74 + KEY_L, // 0x75 + KEY_V, // 0x76 + KEY_W, // 0x77 + KEY_X, // 0x78 + KEY_J, // 0x79 + KEY_Z, // 0x7A + KEYPAD_4, // 0x7B + KEYPAD_8, // 0x7C + KEYPAD_5, // 0x7D + 0, // 0x7E + KEY_DELETE, // 0x7F +}; + + + +#endif +
--- a/Keymap/keymap.h Mon Mar 26 18:07:56 2012 -0400 +++ b/Keymap/keymap.h Mon Mar 26 19:02:46 2012 -0400 @@ -41,6 +41,7 @@ // See files for full layout descriptions +#include "betkb.h" #include "budkeypad.h" #include "epsonqx10.h" #include "heathzenith.h"
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Scan/BETKB/scan_loop.c Mon Mar 26 19:02:46 2012 -0400 @@ -0,0 +1,260 @@ +/* Copyright (C) 2012 by Jacob Alexander + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +// ----- Includes ----- + +// AVR Includes +#include <avr/interrupt.h> +#include <avr/io.h> +#include <util/delay.h> + +// Project Includes +#include <led.h> +#include <print.h> + +// Local Includes +#include "scan_loop.h" + + + +// ----- Defines ----- + +// Pinout Defines +#define RESET_PORT PORTB +#define RESET_DDR DDRD +#define RESET_PIN 0 + + +// ----- Macros ----- + +// Make sure we haven't overflowed the buffer +#define bufferAdd(byte) \ + if ( KeyIndex_BufferUsed < KEYBOARD_BUFFER ) \ + KeyIndex_Buffer[KeyIndex_BufferUsed++] = byte + + + +// ----- Variables ----- + +// Buffer used to inform the macro processing module which keys have been detected as pressed +volatile uint8_t KeyIndex_Buffer[KEYBOARD_BUFFER]; +volatile uint8_t KeyIndex_BufferUsed; + + +// Buffer Signals +volatile uint8_t BufferReadyToClear; + + + +// ----- Function Declarations ----- + +void processKeyValue( uint8_t keyValue ); + + + +// ----- Interrupt Functions ----- + +// USART Receive Buffer Full Interrupt +ISR(USART1_RX_vect) +{ + cli(); // Disable Interrupts + + uint8_t keyValue = 0x00; + + // The interrupt is always for the first item of the packet set, reset the buffer + KeyIndex_BufferUsed = 0; + + // Only the first 7 bits have scancode data + // The last packet of the packet set has the 8th bit high, all the others are low + // + // Interrupts are too slow for the rest of the packet set, poll for the rest + while ( 1 ) + { + // Read the raw packet from the USART + keyValue = UDR1; + + // Debug + char tmpStr[6]; + hexToStr( keyValue, tmpStr ); + dPrintStrs( tmpStr, " " ); + + // Process the scancode + processKeyValue( keyValue ); + + // Last packet of the set + if ( keyValue & 0x80 ) + { + dPrintStrs( "**" ); + break; + } + + // Delay enough so we don't run into the same packet (or the previous buffered packet) + _delay_us(10000); + } + + sei(); // Re-enable Interrupts +} + + + +// ----- Functions ----- + +// Setup +inline void scan_setup() +{ + // Setup the the USART interface for keyboard data input + // NOTE: The input data signal needs to be inverted for the Teensy USART to properly work + + // Setup baud rate + // 16 MHz / ( 16 * Baud ) = UBRR + // Baud <- 0.823284 ms per bit, thus 1000 / 0.823284 = 1214.65004 -> 823.2824 + // Thus baud setting = 823 + uint16_t baud = 823; // Max setting of 4095 + UBRR1H = (uint8_t)(baud >> 8); + UBRR1L = (uint8_t)baud; + + // Enable the receiver, transitter, and RX Complete Interrupt as well as 9 bit data + UCSR1B = 0x9C; + + // Set frame format: 9 data, 1 stop bit, no parity + // Asynchrounous USART mode + UCSR1C = 0x06; + + // Initially buffer doesn't need to be cleared (it's empty...) + BufferReadyToClear = 0; + + // Reset the keyboard before scanning, we might be in a wierd state + scan_resetKeyboard(); +} + + +// Main Detection Loop +// Not needed for the BETKB, this is just a busy loop +inline uint8_t scan_loop() +{ + return 0; +} + +// TODO +void processKeyValue( uint8_t keyValue ) +{ + // Finalize output buffer + // Mask 8th bit + keyValue &= 0x7F; + + // Interpret scan code + switch ( keyValue ) + { + case 0x40: // Clear buffer command + info_print("CLEAR!"); + + BufferReadyToClear = 1; + break; + case 0x7F: + scan_lockKeyboard(); + _delay_ms(3000); + scan_unlockKeyboard(); + + default: + // Make sure the key isn't already in the buffer + for ( uint8_t c = 0; c < KeyIndex_BufferUsed + 1; c++ ) + { + // Key isn't in the buffer yet + if ( c == KeyIndex_BufferUsed ) + { + bufferAdd( keyValue ); + break; + } + + // Key already in the buffer + if ( KeyIndex_Buffer[c] == keyValue ) + break; + } + break; + } +} + +// Send data +uint8_t scan_sendData( uint8_t dataPayload ) +{ + UDR1 = dataPayload; + return 0; +} + +// Signal KeyIndex_Buffer that it has been properly read +// TODO +void scan_finishedWithBuffer( void ) +{ + return; +} + +// Signal that the keys have been properly sent over USB +// TODO +void scan_finishedWithUSBBuffer( void ) +{ + /* + uint8_t foundModifiers = 0; + + // Look for all of the modifiers present, there is a max of 8 (but only keys for 5 on the HASCI version) + for ( uint8_t c = 0; c < KeyIndex_BufferUsed; c++ ) + { + // The modifier range is from 0x80 to 0x8F (well, the last bit is the ON/OFF signal, but whatever...) + if ( KeyIndex_Buffer[c] <= 0x8F && KeyIndex_Buffer[c] >= 0x80 ) + { + // Add the modifier back into the the Key Buffer + KeyIndex_Buffer[foundModifiers] = KeyIndex_Buffer[c]; + foundModifiers++; + } + } + + // Adjust the size of the new Key Buffer + KeyIndex_BufferUsed = foundModifiers; + */ +} + +// Reset/Hold keyboard +// NOTE: Does nothing with the BETKB +void scan_lockKeyboard( void ) +{ +} + +// NOTE: Does nothing with the BETKB +void scan_unlockKeyboard( void ) +{ +} + +// Reset Keyboard +// TODO? +// - Holds the input read line high to flush the buffer +// - This does not actually reset the keyboard, but always seems brings it to a sane state +// - Won't work fully if keys are being pressed done at the same time +void scan_resetKeyboard( void ) +{ + // Initiate data request line, but don't read the incoming data + //REQUEST_DATA(); TODO + + // Not a calculated valued... + _delay_ms( 50 ); + + // Stop request line + //STOP_DATA(); TODO +} +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Scan/BETKB/scan_loop.h Mon Mar 26 19:02:46 2012 -0400 @@ -0,0 +1,66 @@ +/* Copyright (C) 2012 by Jacob Alexander + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#ifndef __SCAN_LOOP_H +#define __SCAN_LOOP_H + +// ----- Includes ----- + +// Compiler Includes +#include <stdint.h> + +// Local Includes + + + +// ----- Defines ----- + +#define KEYBOARD_SIZE 0x100 // 255 - Size of the array space for the keyboard(max index) +#define KEYBOARD_BUFFER 24 // Max number of key signals to buffer + + + +// ----- Variables ----- + +extern volatile uint8_t KeyIndex_Buffer[KEYBOARD_BUFFER]; +extern volatile uint8_t KeyIndex_BufferUsed; + + + +// ----- Functions ----- + +// Functions used by main.c +void scan_setup( void ); +uint8_t scan_loop( void ); + + +// Functions available to macro.c +uint8_t scan_sendData( uint8_t dataPayload ); + +void scan_finishedWithBuffer( void ); +void scan_finishedWithUSBBuffer( void ); +void scan_lockKeyboard( void ); +void scan_unlockKeyboard( void ); +void scan_resetKeyboard( void ); + + +#endif // __SCAN_LOOP_H +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Scan/BETKB/setup.cmake Mon Mar 26 19:02:46 2012 -0400 @@ -0,0 +1,48 @@ +###| CMake Kiibohd Controller Scan Module |### +# +# Written by Jacob Alexander in 2011 for the Kiibohd Controller +# +# Released into the Public Domain +# +# For the Burroughs/Kokusai BETKB (Burroughs Ergonomic Terminal Keyboard) +# +### + + +### +# Module C files +# + +set( SCAN_SRCS + scan_loop.c +) + + +### +# Module H files +# +set( SCAN_HDRS + scan_loop.h +) + + +### +# File Dependency Setup +# +ADD_FILE_DEPENDENCIES( scan_loop.c ${SCAN_HDRS} ) +#add_file_dependencies( scan_loop.c ${SCAN_HDRS} ) +#add_file_dependencies( macro.c keymap.h microswitch8304.h ) + + +### +# Module Specific Options +# +add_definitions( -I${HEAD_DIR}/Keymap ) + +#| Keymap Settings +add_definitions( + -DMODIFIER_MASK=betkb_ModifierMask + -DKEYINDEX_MASK=betkb_ColemakMap + #-DKEYINDEX_MASK=betkb_DefaultMap +) +
--- a/setup.cmake Mon Mar 26 18:07:56 2012 -0400 +++ b/setup.cmake Mon Mar 26 19:02:46 2012 -0400 @@ -20,7 +20,7 @@ #| Please the {Scan,Macro,USB,Debug}/module.txt for information on the modules and how to create new ones ##| Deals with acquiring the keypress information and turning it into a key index -set( ScanModule "UnivacF3W9" ) +set( ScanModule "BETKB" ) ##| Uses the key index and potentially applies special conditions to it, mapping it to a usb key code set( MacroModule "buffer" )