1 /* Copyright (C) 2011-2012 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 <avr/interrupt.h>
32 #include "scan_loop.h"
33 #include "matrix_scan.h"
37 // ----- Defines -----
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
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
57 // ----- Variables -----
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
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;
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_SIZE + 1];
74 // ----- Functions -----
77 inline void scan_setup()
79 matrix_pinSetup( (uint8_t*)matrix_pinout, scanMode );
82 // Main Detection Loop
83 inline uint8_t scan_loop()
85 // Check count to see if the sample threshold may have been reached, otherwise collect more data
86 if ( scan_count < MAX_SAMPLES )
88 matrix_scan( (uint8_t*)matrix_pinout, KeyIndex_Array );
90 // scanDual requires 2 passes, and thus needs more memory per matrix_scan pass
91 #if scanMode == scanDual
97 // Signal Main Detection Loop to continue scanning
101 // Reset Sample Counter
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 )
110 // Debug output (keypress detected)
112 hexToStr( key, tmpStr );
113 dPrintStrs( tmpStr, " " );
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++ )
118 // Key isn't in the buffer yet
119 if ( c == KeyIndex_BufferUsed )
125 // Key already in the buffer
126 if ( KeyIndex_Buffer[c] == key )
130 KeyIndex_Array[key] = (1 << 7);
134 // Remove the key from the buffer only if it was previously known to be pressed
135 if ( KeyIndex_Array[key] & (1 << 7 ) )
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++ )
140 // Key to release found
141 if ( KeyIndex_Buffer[c] == key )
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];
148 KeyIndex_BufferUsed--;
155 KeyIndex_Array[key] = 0x00;
158 // Ready to allow for USB send
163 // Signal that the keys have been properly sent over USB
164 inline void scan_finishedWithUSBBuffer( void )
170 // Signal KeyIndex_Buffer that it has been fully scanned using the macro module
171 inline void scan_finishedWithBuffer( void )
176 // Send data to keyboard
177 // Not used in this module
178 uint8_t scan_sendData( uint8_t dataPayload )