Scan/matrix/scan_loop.c

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