annotate Scan/WhiteFox/scan_loop.c @ 362:e4be15c39cce

Adding initial WhiteFox support. - Includes fix for over-range ScanCodes (would cause hard faults) - Updated some documentation - Requires recent kll compiler for the layout
author Jacob Alexander <haata@kiibohd.com>
date Sun, 16 Aug 2015 12:27:12 -0700
parents
children 23a1868b4ac2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
362
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
1 /* Copyright (C) 2014-2015 by Jacob Alexander
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
2 *
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
4 * of this software and associated documentation files (the "Software"), to deal
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
5 * in the Software without restriction, including without limitation the rights
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
7 * copies of the Software, and to permit persons to whom the Software is
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
8 * furnished to do so, subject to the following conditions:
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
9 *
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
10 * The above copyright notice and this permission notice shall be included in
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
11 * all copies or substantial portions of the Software.
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
12 *
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
19 * THE SOFTWARE.
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
20 */
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
21
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
22 // ----- Includes -----
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
23
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
24 // Compiler Includes
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
25 #include <Lib/ScanLib.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
26
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
27 // Project Includes
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
28 #include <cli.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
29 #include <led.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
30 #include <led_scan.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
31 #include <print.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
32 #include <matrix_scan.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
33 #include <macro.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
34 #include <output_com.h>
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
35
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
36 // Local Includes
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
37 #include "scan_loop.h"
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
38
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
39
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
40
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
41 // ----- Function Declarations -----
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
42
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
43 // ----- Variables -----
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
44
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
45 // Number of scans since the last USB send
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
46 uint16_t Scan_scanCount = 0;
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
47
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
48
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
49
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
50 // ----- Functions -----
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
51
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
52 // Setup
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
53 inline void Scan_setup()
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
54 {
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
55 // Setup GPIO pins for matrix scanning
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
56 Matrix_setup();
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
57
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
58 // Setup ISSI chip to control the leds
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
59 LED_setup();
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
60
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
61 // Reset scan count
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
62 Scan_scanCount = 0;
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
63 }
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
64
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
65
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
66 // Main Detection Loop
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
67 inline uint8_t Scan_loop()
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
68 {
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
69 // Scan Matrix
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
70 Matrix_scan( Scan_scanCount++ );
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
71
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
72 // Process any LED events
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
73 LED_scan();
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
74
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
75 return 0;
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
76 }
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
77
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
78
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
79 // Signal from Macro Module that all keys have been processed (that it knows about)
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
80 inline void Scan_finishedWithMacro( uint8_t sentKeys )
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
81 {
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
82 }
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
83
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
84
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
85 // Signal from Output Module that all keys have been processed (that it knows about)
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
86 inline void Scan_finishedWithOutput( uint8_t sentKeys )
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
87 {
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
88 // Reset scan loop indicator (resets each key debounce state)
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
89 // TODO should this occur after USB send or Macro processing?
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
90 Scan_scanCount = 0;
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
91 }
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
92