annotate Scan/MD1_1/scan_loop.h @ 407:b7411ae25432

Initial code for MD1_1 - IC60 /w Single color LEDs - Requires a different matrix configuration so it's incompatible with the old IC60 layout
author Jacob Alexander <haata@kiibohd.com>
date Sat, 06 Feb 2016 18:06:37 -0800
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
407
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
1 /* Copyright (C) 2014-2015 by Jacob Alexander
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
2 *
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
4 * of this software and associated documentation files (the "Software"), to deal
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
5 * in the Software without restriction, including without limitation the rights
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
7 * copies of the Software, and to permit persons to whom the Software is
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
8 * furnished to do so, subject to the following conditions:
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
9 *
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
10 * The above copyright notice and this permission notice shall be included in
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
11 * all copies or substantial portions of the Software.
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
12 *
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
19 * THE SOFTWARE.
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
20 */
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
21
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
22 #pragma once
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
23
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
24 // ----- Includes -----
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
25
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
26 // Compiler Includes
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
27 #include <stdint.h>
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
28
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
29
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
30
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
31 // ----- Functions -----
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
32
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
33 // Functions to be called by main.c
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
34 void Scan_setup( void );
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
35 uint8_t Scan_loop( void );
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
36
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
37 // Call-backs
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
38 void Scan_finishedWithMacro( uint8_t sentKeys ); // Called by Macro Module
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
39 void Scan_finishedWithOutput( uint8_t sentKeys ); // Called by Output Module
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
40
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
41
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
42 // ----- Capabilities -----
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
43
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
44 // Example capabilities
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
45 void CustomAction_action1_capability( uint8_t state, uint8_t stateType, uint8_t *args );
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
46 void CustomAction_blockHold_capability( uint8_t state, uint8_t stateType, uint8_t *args );
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
47 void CustomAction_blockKey_capability( uint8_t state, uint8_t stateType, uint8_t *args );
b7411ae25432 Initial code for MD1_1
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
48