annotate Scan/KType/scan_loop.c @ 378:890a18d98c47

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