1 /* Copyright (C) 2011-2012,2014 by Jacob Alexander
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:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
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
22 // ----- Includes -----
25 #include <Lib/ScanLib.h>
33 #include "scan_loop.h"
34 #include "matrix_scan.h"
38 // ----- Defines -----
42 //#define SAMPLE_THRESHOLD 110
43 //#define MAX_SAMPLES 127 // Max is 127, reaching 128 is very bad
44 #define SAMPLE_THRESHOLD 6
45 #define MAX_SAMPLES 10 // Max is 127, reaching 128 is very bad
53 // ----- Variables -----
55 // Buffer used to inform the macro processing module which keys have been detected as pressed
56 volatile uint8_t KeyIndex_Buffer[KEYBOARD_BUFFER];
57 volatile uint8_t KeyIndex_BufferUsed;
58 volatile uint8_t KeyIndex_Add_InputSignal; // Used to pass the (click/input value) to the keyboard for the clicker
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;
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_KEYS + 1];
70 // ----- Functions -----
73 inline void Scan_setup()
75 matrix_pinSetup( (uint8_t*)matrix_pinout, scanMode );
78 // Main Detection Loop
79 inline uint8_t Scan_loop()
81 // Check count to see if the sample threshold may have been reached, otherwise collect more data
82 if ( Scan_count < MAX_SAMPLES )
84 matrix_scan( (uint8_t*)matrix_pinout, KeyIndex_Array );
86 // scanDual requires 2 passes, and thus needs more memory per matrix_scan pass
87 #if scanMode == scanDual
93 // Signal Main Detection Loop to continue scanning
97 // Reset Sample Counter
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 )
106 // Debug output (keypress detected)
110 // Add the key to the buffer, if it isn't already in the current Key Buffer
111 for ( uint8_t c = 0; c < KeyIndex_BufferUsed + 1; c++ )
113 // Key isn't in the buffer yet
114 if ( c == KeyIndex_BufferUsed )
116 Macro_bufferAdd( key );
120 // Key already in the buffer
121 if ( KeyIndex_Buffer[c] == key )
125 KeyIndex_Array[key] = (1 << 7);
129 // Remove the key from the buffer only if it was previously known to be pressed
130 if ( KeyIndex_Array[key] & (1 << 7 ) )
132 // Check for the released key, and shift the other keys lower on the buffer
133 for ( uint8_t c = 0; c < KeyIndex_BufferUsed; c++ )
135 // Key to release found
136 if ( KeyIndex_Buffer[c] == key )
138 // Shift keys from c position
139 for ( uint8_t k = c; k < KeyIndex_BufferUsed - 1; k++ )
140 KeyIndex_Buffer[k] = KeyIndex_Buffer[k + 1];
143 KeyIndex_BufferUsed--;
150 KeyIndex_Array[key] = 0x00;
153 // Ready to allow for USB send
158 // Signal that the USB keycodes have been properly sent through the Output Module
159 inline void Scan_finishedWithUSBBuffer( uint8_t sentKeys )
165 // Signal KeyIndex_Buffer that it has been fully processed using the macro module
166 inline void Scan_finishedWithBuffer( uint8_t sentKeys )