Scan/WhiteFox/scan_loop.c

   1 /* Copyright (C) 2014-2015 by Jacob Alexander
   2  *
   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:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  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
  19  * THE SOFTWARE.
  20  */
  21
  22 // ----- Includes -----
  23
  24 // Compiler Includes
  25 #include <Lib/ScanLib.h>
  26
  27 // Project Includes
  28 #include <cli.h>
  29 #include <led.h>
  30 #include <led_scan.h>
  31 #include <print.h>
  32 #include <matrix_scan.h>
  33 #include <macro.h>
  34 #include <output_com.h>
  35
  36 // Local Includes
  37 #include "scan_loop.h"
  38
  39
  40
  41 // ----- Function Declarations -----
  42
  43 // ----- Variables -----
  44
  45 // Number of scans since the last USB send
  46 uint16_t Scan_scanCount = 0;
  47
  48
  49
  50 // ----- Functions -----
  51
  52 // Setup
  53 inline void Scan_setup()
  54 {
  55         // Setup GPIO pins for matrix scanning
  56         Matrix_setup();
  57
  58         // Setup ISSI chip to control the leds
  59         LED_setup();
  60
  61         // Reset scan count
  62         Scan_scanCount = 0;
  63 }
  64
  65
  66 // Main Detection Loop
  67 inline uint8_t Scan_loop()
  68 {
  69         // Scan Matrix
  70         Matrix_scan( Scan_scanCount++ );
  71
  72         // Process any LED events
  73         LED_scan();
  74
  75         return 0;
  76 }
  77
  78
  79 // Signal from Macro Module that all keys have been processed (that it knows about)
  80 inline void Scan_finishedWithMacro( uint8_t sentKeys )
  81 {
  82 }
  83
  84
  85 // Signal from Output Module that all keys have been processed (that it knows about)
  86 inline void Scan_finishedWithOutput( uint8_t sentKeys )
  87 {
  88         // Reset scan loop indicator (resets each key debounce state)
  89         // TODO should this occur after USB send or Macro processing?
  90         Scan_scanCount = 0;
  91 }
  92