Scan/matrix/scan_loop.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 // ----- Includes -----
  23
  24 // AVR Includes
  25 #include <avr/interrupt.h>
  26
  27 // Project Includes
  28 #include <led.h>
  29 #include <print.h>
  30
  31 // Local Includes
  32 #include "scan_loop.h"
  33 #include "matrix_scan.h"
  34
  35
  36
  37 // ----- Defines -----
  38
  39 // Debouncing Defines
  40 #define SAMPLE_THRESHOLD 110
  41 #define MAX_SAMPLES      127 // Max is 127, reaching 128 is very bad
  42
  43
  44
  45 // ----- Macros -----
  46
  47 // Make sure we haven't overflowed the buffer
  48 #define bufferAdd(byte) \
  49                 if ( KeyIndex_BufferUsed < KEYBOARD_BUFFER ) \
  50                         KeyIndex_Buffer[KeyIndex_BufferUsed++] = byte
  51
  52
  53
  54 // ----- Variables -----
  55
  56 // Buffer used to inform the macro processing module which keys have been detected as pressed
  57 volatile uint8_t KeyIndex_Buffer[KEYBOARD_BUFFER];
  58 volatile uint8_t KeyIndex_BufferUsed;
  59
  60
  61 // Keeps track of the number of scans, so we only do a debounce assess when it would be valid (as it throws away data)
  62 uint8_t scan_count = 0;
  63
  64 // This is where the matrix scan data is held, as well as debouncing is evaluated to, which (depending on the read value) is handled
  65 //  by the macro module
  66 uint8_t KeyIndex_Array[KEYBOARD_SIZE + 1];
  67
  68
  69
  70 // ----- Functions -----
  71
  72 // Setup
  73 inline void scan_setup()
  74 {
  75         matrix_pinSetup( (uint8_t*)matrix_pinout, scanMode );
  76 }
  77
  78 // Main Detection Loop
  79 inline uint8_t scan_loop()
  80 {
  81         // Check count to see if the sample threshold may have been reached, otherwise collect more data
  82         if ( scan_count < MAX_SAMPLES )
  83         {
  84                 matrix_scan( (uint8_t*)matrix_pinout, KeyIndex_Array );
  85
  86                 // scanDual requires 2 passes, and thus needs more memory per matrix_scan pass
  87 #if scanMode == scanDual
  88                 scan_count += 2;
  89 #else
  90                 scan_count++;
  91 #endif
  92
  93                 // Signal Main Detection Loop to continue scanning
  94                 return 0;
  95         }
  96
  97         // Reset Sample Counter
  98         scan_count = 0;
  99
 100         // Assess debouncing sample table
 101         // Loop over all of the sampled keys of the given array
 102         // If the number of samples is higher than the sample threshold, flag the high bit, clear otherwise
 103         // This should be resetting VERY quickly, cutting off a potentially valid keypress is not an issue
 104         for ( uint8_t key = 1; key < KeyIndex_Size + 1; key++ ) if ( ( KeyIndex_Array[key] & ~(1 << 7) ) > SAMPLE_THRESHOLD )
 105         {
 106                 // Debug output (keypress detected)
 107                 char tmpStr[6];
 108                 hexToStr( key, tmpStr );
 109                 dPrintStrs( tmpStr, " " );
 110
 111                 // Add the key to the buffer, if it isn't already in the current Key Buffer
 112                 for ( uint8_t c = 0; c < KeyIndex_BufferUsed + 1; c++ )
 113                 {
 114                         // Key isn't in the buffer yet
 115                         if ( c == KeyIndex_BufferUsed )
 116                         {
 117                                 bufferAdd( key );
 118                                 break;
 119                         }
 120
 121                         // Key already in the buffer
 122                         if ( KeyIndex_Buffer[c] == key )
 123                                 break;
 124                 }
 125
 126                 KeyIndex_Array[key] = (1 << 7);
 127         }
 128         else
 129         {
 130                 // Remove the key from the buffer only if it was previously known to be pressed
 131                 if ( KeyIndex_Array[key] & (1 << 7 ) )
 132                 {
 133                         // Check for the released key, and shift the other keys lower on the buffer
 134                         for ( uint8_t c = 0; c < KeyIndex_BufferUsed; c++ )
 135                         {
 136                                 // Key to release found
 137                                 if ( KeyIndex_Buffer[c] == key )
 138                                 {
 139                                         // Shift keys from c position
 140                                         for ( uint8_t k = c; k < KeyIndex_BufferUsed - 1; k++ )
 141                                                 KeyIndex_Buffer[k] = KeyIndex_Buffer[k + 1];
 142
 143                                         // Decrement Buffer
 144                                         KeyIndex_BufferUsed--;
 145
 146                                         break;
 147                                 }
 148                         }
 149                 }
 150
 151                 KeyIndex_Array[key] = 0x00;
 152         }
 153
 154         // Ready to allow for USB send
 155         return 1;
 156 }
 157
 158
 159 // Signal that the keys have been properly sent over USB
 160 inline void scan_finishedWithUSBBuffer( void )
 161 {
 162         return;
 163 }
 164
 165
 166 // Signal KeyIndex_Buffer that it has been fully scanned using the macro module
 167 inline void scan_finishedWithBuffer( void )
 168 {
 169         return;
 170 }
 171