Scan/DPH/scan_loop.h

   1 /* Copyright (C) 2013-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 #pragma once
  23
  24 // ----- Includes -----
  25
  26 // Compiler Includes
  27 #include <stdint.h>
  28
  29 // Local Includes
  30
  31
  32
  33 // ----- Defines -----
  34
  35 #define KEYBOARD_KEYS 0xFF // TODO Determine max number of keys
  36 #define KEYBOARD_BUFFER 24 // Max number of key signals to buffer
  37                            // This limits the NKRO-ability, so at 24, the keyboard is 24KRO
  38                            // The buffer is really only needed for converter modules
  39                            // An alternative macro module could be written for matrix modules and still work well
  40
  41
  42
  43 // ----- Variables -----
  44
  45 extern volatile     uint8_t KeyIndex_Buffer[KEYBOARD_BUFFER];
  46 extern volatile     uint8_t KeyIndex_BufferUsed;
  47
  48
  49
  50 // ----- Functions -----
  51
  52 // Functions used by main.c
  53 void Scan_setup();
  54 uint8_t Scan_loop();
  55
  56
  57 // Functions available to macro.c
  58 uint8_t Scan_sendData( uint8_t dataPayload );
  59
  60 void Scan_finishedWithMacro( uint8_t sentKeys );
  61 void Scan_finishedWithOutput( uint8_t sentKeys );
  62