main.c

   1 /* Copyright (C) 2011 by Jacob Alexander
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  * THE SOFTWARE.
  20  */
  21
  22 #include <avr/io.h>
  23 #include <avr/pgmspace.h>
  24 #include <avr/interrupt.h>
  25 #include <util/delay.h>
  26 #include "usb_keys.h"
  27 #include "layouts.h"
  28 //#include "usb_keyboard.h"
  29
  30 // TEMP INCLUDES
  31 #include "usb_keyboard_debug.h"
  32 #include <print.h>
  33
  34 #define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n))
  35
  36 // Number of keys
  37 #define KEYBOARD_SIZE 63
  38 #define KEYPAD_SIZE 16
  39
  40
  41 // Debouncing Defines
  42 #define SAMPLE_THRESHOLD 110
  43 #define MAX_SAMPLES 127 // Max is 127, reaching 128 is very bad
  44
  45
  46 // Verified Keypress Defines
  47 #define USB_TRANSFER_DIVIDER 10 // 1024 == 1 Send of keypresses per second, 1 == 1 Send of keypresses per ~1 millisecond
  48
  49
  50 // Drive Pin Defines
  51 #define DRIVE_reg_1 PORTD
  52 #define DRIVE_reg_2 PORTD
  53 #define DRIVE_reg_3 PORTD
  54 #define DRIVE_reg_4 PORTD
  55 #define DRIVE_reg_5 PORTD
  56 #define DRIVE_reg_6 PORTD
  57 #define DRIVE_reg_7 PORTE
  58 #define DRIVE_reg_8 PORTE
  59 #define DRIVE_reg_9 PORTE
  60 #define DRIVE_reg_10 <blank>
  61 #define DRIVE_reg_11 <blank>
  62 #define DRIVE_reg_12 <blank>
  63
  64 #define DRIVE_pin_1 2
  65 #define DRIVE_pin_2 3
  66 #define DRIVE_pin_3 4
  67 #define DRIVE_pin_4 5
  68 #define DRIVE_pin_5 6
  69 #define DRIVE_pin_6 7
  70 #define DRIVE_pin_7 0
  71 #define DRIVE_pin_8 1
  72 #define DRIVE_pin_9 6
  73 #define DRIVE_pin_10 <blank>
  74 #define DRIVE_pin_11 <blank>
  75 #define DRIVE_pin_12 <blank>
  76
  77 // Detect Pin/Group Defines
  78 #define DETECT_group_1 1
  79 #define DETECT_group_2 2
  80 #define DETECT_group_3 3
  81 #define DETECT_group_4 4
  82 #define DETECT_group_5 5
  83 #define DETECT_group_6 6
  84 #define DETECT_group_7 7
  85 #define DETECT_group_8 8
  86 #define DETECT_group_9 9
  87 #define DETECT_group_10 <blank>
  88 #define DETECT_group_11 <blank>
  89 #define DETECT_group_12 <blank>
  90
  91 #define DETECT_group_size_1 7
  92 #define DETECT_group_size_2 7
  93 #define DETECT_group_size_3 6
  94 #define DETECT_group_size_4 8
  95 #define DETECT_group_size_5 7
  96 #define DETECT_group_size_6 7
  97 #define DETECT_group_size_7 8
  98 #define DETECT_group_size_8 8
  99 #define DETECT_group_size_9 4
 100 #define DETECT_group_size_10 <blank>
 101 #define DETECT_group_size_11 <blank>
 102 #define DETECT_group_size_12 <blank>
 103
 104 // Switch Codes
 105 #define DETECT_group_array_1 {55,22,6 ,40,43,27,11}
 106 #define DETECT_group_array_2 {56,23,7 ,41,58,26,10}
 107 #define DETECT_group_array_3 {57,24,8 ,42,25,9}
 108 #define DETECT_group_array_4 {54,21,5 ,39,44,28,12,59}
 109 #define DETECT_group_array_5 {53,20,4 ,38,45,29,13}
 110 #define DETECT_group_array_6 {52,19,3 ,37,46,30,14}
 111 #define DETECT_group_array_7 {51,18,2 ,36,61,31,15,63}
 112 #define DETECT_group_array_8 {50,17,1 ,35,47,32,16,62}
 113 #define DETECT_group_array_9 {48,49,33,34} // 49/60 are the same line
 114 #define DETECT_group_array_10 <blank>
 115 #define DETECT_group_array_11 <blank>
 116 #define DETECT_group_array_12 <blank>
 117
 118
 119
 120 // Drive Macros (Generally don't need to be changed), except for maybe DRIVE_DETECT
 121 #define DRIVE_DETECT(reg,pin,group) \
 122                         reg &= ~(1 << pin); \
 123                         detection(group); \
 124                         reg |= (1 << pin);
 125
 126 #define DD_CASE(number) \
 127                         case number:\
 128                                 DRIVE_DETECT(DRIVE_reg_##number, DRIVE_pin_##number, DETECT_group_##number)
 129
 130 #define DD_CASE_ORD(number) \
 131                         DD_CASE(number) \
 132                         break;
 133
 134 #define DD_CASE_END(number,var) \
 135                         DD_CASE(number) \
 136                         var = -1; \
 137                         break;
 138
 139
 140 // Updates the current detection sample and last sample bit
 141 // Detection Macros (Probably don't need to be changed, but depending the matrix, may have to be)
 142 // Determine if key is either normal or a modifier
 143 #define DET_GROUP_CHECK(index,test) \
 144                         if ( test ) { \
 145                                 keyDetectArray[groupArray[index]]++; \
 146                         }
 147
 148
 149 // XXX - Detection Groups
 150 // Checks each of the specified pins, and then if press detected, determine if the key is normal or a modifier
 151 // Inverse logic applies for the PINs
 152
 153 // Used for 1 detection group (Special group)
 154 #define DET_GROUP_1 \
 155                         DET_GROUP_CHECK(0,!( PINB & (1 << 7) )) \
 156                         DET_GROUP_CHECK(1,!( PINC & (1 << 0) )) \
 157                         DET_GROUP_CHECK(2,!( PIND & (1 << 0) )) \
 158                         DET_GROUP_CHECK(3,!( PIND & (1 << 1) )) \
 159
 160 // Used for 4 detection groups (Skips J1 P9)
 161 #define DET_GROUP_2 \
 162                         DET_GROUP_CHECK(0,!( PINE & (1 << 7) )) \
 163                         DET_GROUP_CHECK(1,!( PINB & (1 << 0) )) \
 164                         DET_GROUP_CHECK(2,!( PINB & (1 << 1) )) \
 165                         DET_GROUP_CHECK(3,!( PINB & (1 << 2) )) \
 166                         DET_GROUP_CHECK(4,!( PINB & (1 << 3) )) \
 167                         DET_GROUP_CHECK(5,!( PINB & (1 << 4) )) \
 168                         DET_GROUP_CHECK(6,!( PINB & (1 << 5) )) \
 169
 170 // Used for 1 detection group (Skips J1 P6 and J1 P9)
 171 #define DET_GROUP_3 \
 172                         DET_GROUP_CHECK(0,!( PINE & (1 << 7) )) \
 173                         DET_GROUP_CHECK(1,!( PINB & (1 << 0) )) \
 174                         DET_GROUP_CHECK(2,!( PINB & (1 << 1) )) \
 175                         DET_GROUP_CHECK(3,!( PINB & (1 << 2) )) \
 176                         DET_GROUP_CHECK(4,!( PINB & (1 << 4) )) \
 177                         DET_GROUP_CHECK(5,!( PINB & (1 << 5) )) \
 178
 179 // Used for 3 detection groups (No skips, except special group 1)
 180 #define DET_GROUP_4 \
 181                         DET_GROUP_CHECK(0,!( PINE & (1 << 7) )) \
 182                         DET_GROUP_CHECK(1,!( PINB & (1 << 0) )) \
 183                         DET_GROUP_CHECK(2,!( PINB & (1 << 1) )) \
 184                         DET_GROUP_CHECK(3,!( PINB & (1 << 2) )) \
 185                         DET_GROUP_CHECK(4,!( PINB & (1 << 3) )) \
 186                         DET_GROUP_CHECK(5,!( PINB & (1 << 4) )) \
 187                         DET_GROUP_CHECK(6,!( PINB & (1 << 5) )) \
 188                         DET_GROUP_CHECK(7,!( PINB & (1 << 6) )) \
 189
 190 // Combines the DET_GROUP_Xs above for the given groupArray
 191 #define DET_GROUP(group,det_group) \
 192                         case group: \
 193                                 { \
 194                                         uint8_t groupArray[DETECT_group_size_##group] = DETECT_group_array_##group; \
 195                                         _delay_us(1); \
 196                                         DET_GROUP_##det_group \
 197                                 } \
 198                                 break;
 199
 200
 201 // Loop over all of the sampled keys of the given array
 202 // If the number of samples is higher than the sample threshold, flag the high bit, clear otherwise
 203 // This should be resetting VERY quickly, cutting off a potentially valid keypress is not an issue
 204 #define DEBOUNCE_ASSESS(table,size) \
 205                         for ( uint8_t key = 1; key < size + 1; key++ ) {\
 206                                 table[key] = ( table[key] & ~(1 << 7) ) > SAMPLE_THRESHOLD ? (1 << 7) : 0x00; \
 207                         } \
 208
 209
 210 // Keypad detection
 211 // Each switch has it's own detection line, inverse logic
 212 #define KEYPAD_DETECT(test,switch_code) \
 213                         if ( !(test) ) { \
 214                                 keypadDetectArray[switch_code]++; \
 215                         } \
 216
 217
 218 // NOTE: Highest Bit: Valid keypress (0x80 is valid keypress)
 219 //        Other Bits: Pressed state sample counter
 220 uint8_t keyDetectArray[KEYBOARD_SIZE + 1];
 221 uint8_t keypadDetectArray[KEYPAD_SIZE + 1];
 222
 223 // Interrupt Variables
 224 uint16_t sendKeypressCounter = 0;
 225 volatile uint8_t sendKeypresses = 0;
 226
 227
 228 void detection( int group )
 229 {
 230         // XXX Modify for different detection groups <-> groupArray mappings
 231         switch ( group ) {
 232                 DET_GROUP(1,2)
 233                 DET_GROUP(2,2)
 234                 DET_GROUP(3,3)
 235                 DET_GROUP(4,4)
 236                 DET_GROUP(5,2)
 237                 DET_GROUP(6,2)
 238                 DET_GROUP(7,4)
 239                 DET_GROUP(8,4)
 240                 DET_GROUP(9,1)
 241         }
 242 }
 243
 244
 245
 246 // XXX This part is configurable
 247 inline void pinSetup(void)
 248 {
 249         // For each pin, 0=input, 1=output
 250         DDRA = 0x00;
 251         DDRB = 0x00;
 252         DDRC = 0x00;
 253         DDRD = 0xFC;
 254         DDRE = 0x43;
 255         DDRF = 0x00;
 256
 257
 258         // Setting pins to either high or pull-up resistor
 259         PORTA = 0xFF;
 260         PORTB = 0xFF;
 261         PORTC = 0x01;
 262         PORTD = 0xFF;
 263         PORTE = 0xC3;
 264         PORTF = 0xFF;
 265 }
 266
 267 // Given a sampling array, and the current number of detected keypress
 268 // Add as many keypresses from the sampling array to the USB key send array as possible.
 269 void keyPressDetection( uint8_t *keys, uint8_t *validKeys, uint8_t numberOfKeys, uint8_t *modifiers, uint8_t numberOfModifiers, uint8_t *map ) {
 270         for ( uint8_t key = 0; key < numberOfKeys + 1; key++ ) {
 271                 if ( keys[key] & (1 << 7) ) {
 272                         pint8( key );
 273                         print(" ");
 274                         uint8_t modFound = 0;
 275
 276                         // Determine if the key is a modifier
 277                         for ( uint8_t mod = 0; mod < numberOfModifiers; mod++ ) {
 278                                 // Modifier found
 279                                 if ( modifiers[mod] == key ) {
 280                                         keyboard_modifier_keys |= map[key];
 281                                         modFound = 1;
 282                                         break;
 283                                 }
 284                         }
 285                         if ( modFound )
 286                                 continue;
 287
 288                         // Too many keys
 289                         if ( *validKeys == 6 )
 290                                 break;
 291
 292                         // Allow ignoring keys with 0's
 293                         if ( map[key] != 0 )
 294                                 keyboard_keys[(*validKeys)++] = map[key];
 295                 }
 296         }
 297 }
 298
 299 int main( void )
 300 {
 301         // Setup with 16 MHz clock
 302         CPU_PRESCALE( 0 );
 303
 304         // Configuring Pins
 305         pinSetup();
 306
 307         // Initialize the USB, and then wait for the host to set configuration.
 308         // If the Teensy is powered without a PC connected to the USB port,
 309         // this will wait forever.
 310         usb_init();
 311         while ( !usb_configured() ) /* wait */ ;
 312
 313         // Wait an extra second for the PC's operating system to load drivers
 314         // and do whatever it does to actually be ready for input
 315         _delay_ms(1000);
 316
 317         // Setup ISR Timer for flagging a kepress send to USB
 318         // Set to 256 * 1024 (8 bit timer with Clock/1024 prescalar) timer
 319         TCCR0A = 0x00;
 320         TCCR0B = 0x03;
 321         TIMSK0 = (1 << TOIE0);
 322
 323         // Main Detection Loop
 324         int8_t group = 1;
 325         uint8_t count = 0;
 326         for ( ;;group++ ) {
 327                 // XXX Change number of ORDs if number of lines (RowsxColumns) differ
 328                 // Determine which keys are being pressed
 329                 switch ( group ) {
 330                         DD_CASE_ORD(1)
 331                         DD_CASE_ORD(2)
 332                         DD_CASE_ORD(3)
 333                         DD_CASE_ORD(4)
 334                         DD_CASE_ORD(5)
 335                         DD_CASE_ORD(6)
 336                         DD_CASE_ORD(7)
 337                         DD_CASE_ORD(8)
 338                         DD_CASE_END(9,group)
 339                 }
 340
 341                 // Check all Keyboard keys first
 342                 if ( group != -1 )
 343                         continue;
 344
 345                 // Check Keypad keys
 346                 KEYPAD_DETECT(PINA & (1 << 0),11)
 347                 KEYPAD_DETECT(PINA & (1 << 1),3)
 348                 KEYPAD_DETECT(PINA & (1 << 2),7)
 349                 KEYPAD_DETECT(PINA & (1 << 3),4)
 350                 KEYPAD_DETECT(PINA & (1 << 4),15)
 351                 KEYPAD_DETECT(PINA & (1 << 5),6)
 352                 KEYPAD_DETECT(PINA & (1 << 6),2)
 353                 KEYPAD_DETECT(PINA & (1 << 7),10)
 354                 KEYPAD_DETECT(PINF & (1 << 0),8)
 355                 KEYPAD_DETECT(PINF & (1 << 1),12)
 356                 KEYPAD_DETECT(PINF & (1 << 2),16)
 357                 KEYPAD_DETECT(PINF & (1 << 3),13)
 358                 KEYPAD_DETECT(PINF & (1 << 4),1)
 359                 KEYPAD_DETECT(PINF & (1 << 5),5)
 360                 KEYPAD_DETECT(PINF & (1 << 6),9)
 361                 KEYPAD_DETECT(PINF & (1 << 7),14)
 362
 363                 // Check count to see if the sample threshold may have been reached, otherwise collect more data
 364                 count++;
 365                 if ( count < MAX_SAMPLES )
 366                         continue;
 367
 368                 // Reset Sample Counter
 369                 count = 0;
 370
 371                 // Assess debouncing sample table
 372                 DEBOUNCE_ASSESS(keyDetectArray,KEYBOARD_SIZE)
 373                 DEBOUNCE_ASSESS(keypadDetectArray,KEYPAD_SIZE)
 374
 375                 // Send keypresses over USB if the ISR has signalled that it's time
 376                 if ( !sendKeypresses )
 377                         continue;
 378
 379
 380                 // XXX TODO HACK REMOVEME KILL_WITH_FIRE
 381                 // Too lazy to find (electrical?) issue, so I'm adding a software fix (case is impossible anyways without moar diodes)
 382                 if ( keyDetectArray[20] & (1 << 7) && keyDetectArray[21] & (1 << 7) && keyDetectArray[38] & (1 << 7) ) {
 383                         keyDetectArray[20] &= ~(1 << 7);
 384                         print("HACK!! - Fixme sometime");
 385                 }
 386
 387                 // Detect Valid Keypresses - TODO
 388                 uint8_t validKeys = 0;
 389
 390                 uint8_t *keyboard_MODMASK = keyboard_modifierMask;
 391                 uint8_t  keyboard_NUMMODS = MODIFIERS_KEYBOARD;
 392                 uint8_t *keyboard_MAP     = defaultMap;
 393                 uint8_t *keypad_MODMASK   = keypad_modifierMask;
 394                 uint8_t  keypad_NUMMODS   = MODIFIERS_KEYPAD;
 395                 uint8_t *keypad_MAP       = keypadDefaultMap;
 396
 397                 // Map selection - CapsLock FN
 398                 if ( keyDetectArray[34] & (1 << 7) ) { // CapsLock FN Modifier
 399                                 keyboard_MAP     = colemakMap;
 400                                 keyboard_MODMASK = alternate_modifierMask;
 401                                 keyboard_NUMMODS = 5;
 402
 403                         // Function Key
 404                         if ( keyDetectArray[61] & (1 << 7) ) {
 405                                 keyboard_MAP     = navigationMap;
 406                         }
 407                 }
 408
 409                 keyPressDetection( keyDetectArray, &validKeys, KEYBOARD_SIZE, keyboard_MODMASK, keyboard_NUMMODS, keyboard_MAP );
 410                 keyPressDetection( keypadDetectArray, &validKeys, KEYPAD_SIZE, keypad_MODMASK, keypad_NUMMODS, keypad_MAP );
 411                 print(":\n");
 412
 413                 // TODO undo potentially old keys
 414                 for ( uint8_t c = validKeys; c < 6; c++ )
 415                         keyboard_keys[c] = 0;
 416
 417                 // Send keypresses
 418                 usb_keyboard_send();
 419
 420                 // Clear sendKeypresses Flag
 421                 sendKeypresses = 0;
 422
 423                 // Clear modifiers
 424                 keyboard_modifier_keys = 0;
 425         }
 426
 427         return 0;
 428 }
 429
 430 // Timer Interrupt for flagging a send of the sampled key detection data to the USB host
 431 ISR( TIMER0_OVF_vect )
 432 {
 433         sendKeypressCounter++;
 434         if ( sendKeypressCounter > USB_TRANSFER_DIVIDER ) {
 435                 sendKeypressCounter = 0;
 436                 sendKeypresses = 1;
 437         }
 438 }
 439