annotate Scan/CK3/scan_loop.h @ 425:971e88d4420a

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