1 /* Copyright (C) 2011 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
23 #include <avr/pgmspace.h>
24 #include <avr/interrupt.h>
25 #include <util/delay.h>
28 //#include "usb_keyboard.h"
31 #include "usb_keyboard_debug.h"
34 #define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n))
37 #define KEYBOARD_SIZE 63
38 #define KEYPAD_SIZE 16
42 #define SAMPLE_THRESHOLD 100
43 #define MAX_SAMPLES 127 // Max is 127, reaching 128 is very bad
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
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>
73 #define DRIVE_pin_10 <blank>
74 #define DRIVE_pin_11 <blank>
75 #define DRIVE_pin_12 <blank>
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>
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>
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>
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); \
126 #define DD_CASE(number) \
128 DRIVE_DETECT(DRIVE_reg_##number, DRIVE_pin_##number, DETECT_group_##number)
130 #define DD_CASE_ORD(number) \
134 #define DD_CASE_END(number,var) \
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) \
145 keyDetectArray[groupArray[index]]++; \
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
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) )) \
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) )) \
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) )) \
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) )) \
190 // Combines the DET_GROUP_Xs above for the given groupArray
191 #define DET_GROUP(group,det_group) \
194 uint8_t groupArray[DETECT_group_size_##group] = DETECT_group_array_##group; \
196 DET_GROUP_##det_group \
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; \
211 // Each switch has it's own detection line, inverse logic
212 #define KEYPAD_DETECT(test,switch_code) \
214 keypadDetectArray[switch_code]++; \
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];
223 // Interrupt Variables
224 uint16_t sendKeypressCounter = 0;
225 volatile uint8_t sendKeypresses = 0;
228 void detection( int group )
230 // XXX Modify for different detection groups <-> groupArray mappings
246 // XXX This part is configurable
247 inline void pinSetup(void)
249 // For each pin, 0=input, 1=output
258 // Setting pins to either high or pull-up resistor
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) ) {
274 uint8_t modFound = 0;
276 // Determine if the key is a modifier
277 for ( uint8_t mod = 0; mod < numberOfModifiers; mod++ ) {
279 if ( modifiers[mod] == key ) {
280 keyboard_modifier_keys |= map[key];
289 if ( *validKeys == 6 )
291 keyboard_keys[(*validKeys)++] = map[key];
298 // Setup with 16 MHz clock
304 // Initialize the USB, and then wait for the host to set configuration.
305 // If the Teensy is powered without a PC connected to the USB port,
306 // this will wait forever.
308 while ( !usb_configured() ) /* wait */ ;
310 // Wait an extra second for the PC's operating system to load drivers
311 // and do whatever it does to actually be ready for input
314 // Setup ISR Timer for flagging a kepress send to USB
315 // Set to 256 * 1024 (8 bit timer with Clock/1024 prescalar) timer
318 TIMSK0 = (1 << TOIE0);
320 // Main Detection Loop
324 // XXX Change number of ORDs if number of lines (RowsxColumns) differ
325 // Determine which keys are being pressed
338 // Check all Keyboard keys first
343 KEYPAD_DETECT(PINA & (1 << 0),11)
344 KEYPAD_DETECT(PINA & (1 << 1),3)
345 KEYPAD_DETECT(PINA & (1 << 2),7)
346 KEYPAD_DETECT(PINA & (1 << 3),4)
347 KEYPAD_DETECT(PINA & (1 << 4),15)
348 KEYPAD_DETECT(PINA & (1 << 5),6)
349 KEYPAD_DETECT(PINA & (1 << 6),2)
350 KEYPAD_DETECT(PINA & (1 << 7),10)
351 KEYPAD_DETECT(PINF & (1 << 0),8)
352 KEYPAD_DETECT(PINF & (1 << 1),12)
353 KEYPAD_DETECT(PINF & (1 << 2),16)
354 KEYPAD_DETECT(PINF & (1 << 3),13)
355 KEYPAD_DETECT(PINF & (1 << 4),1)
356 KEYPAD_DETECT(PINF & (1 << 5),5)
357 KEYPAD_DETECT(PINF & (1 << 6),9)
358 KEYPAD_DETECT(PINF & (1 << 7),14)
360 // Check count to see if the sample threshold may have been reached, otherwise collect more data
362 if ( count < MAX_SAMPLES )
365 // Reset Sample Counter
368 // Assess debouncing sample table
369 DEBOUNCE_ASSESS(keyDetectArray,KEYBOARD_SIZE)
370 DEBOUNCE_ASSESS(keypadDetectArray,KEYPAD_SIZE)
372 // Send keypresses over USB if the ISR has signalled that it's time
373 if ( !sendKeypresses )
377 // Detect Valid Keypresses - TODO
378 uint8_t validKeys = 0;
381 if ( keyDetectArray[34] & (1 << 7) ) { // CapsLock FN Modifier
382 keyPressDetection( keyDetectArray, &validKeys, KEYBOARD_SIZE, keyboard_modifierMask, MODIFIERS_KEYBOARD, colemakMap );
383 keyPressDetection( keypadDetectArray, &validKeys, KEYPAD_SIZE, keypad_modifierMask, MODIFIERS_KEYPAD, keypadDefaultMap );
386 keyPressDetection( keyDetectArray, &validKeys, KEYBOARD_SIZE, keyboard_modifierMask, MODIFIERS_KEYBOARD, defaultMap );
387 keyPressDetection( keypadDetectArray, &validKeys, KEYPAD_SIZE, keypad_modifierMask, MODIFIERS_KEYPAD, keypadDefaultMap );
392 // TODO undo potentially old keys
393 for ( uint8_t c = validKeys; c < 6; c++ )
394 keyboard_keys[c] = 0;
399 // Clear sendKeypresses Flag
403 keyboard_modifier_keys = 0;
409 // Timer Interrupt for flagging a send of the sampled key detection data to the USB host
410 ISR( TIMER0_OVF_vect )
412 sendKeypressCounter++;
413 if ( sendKeypressCounter > USB_TRANSFER_DIVIDER ) {
414 sendKeypressCounter = 0;