Scan/matrix/scan_loop.h

   1 /* Copyright (C) 2011-2012,2014 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 #ifndef __SCAN_LOOP_H
  23 #define __SCAN_LOOP_H
  24
  25 // ----- Includes -----
  26
  27 // Compiler Includes
  28 #include <stdint.h>
  29
  30 // Local Includes
  31 #include "matrix_scan.h"
  32
  33 // Matrix Configuration
  34 #include <matrix.h>
  35
  36
  37
  38 // ----- Defines -----
  39
  40 #define KEYBOARD_BUFFER 24 // Max number of key signals to buffer
  41
  42
  43
  44 // ----- Variables -----
  45
  46 // NOTE: Highest Bit: Valid keypress (0x80 is valid keypress)
  47 //        Other Bits: Pressed state sample counter
  48 extern                       uint8_t KeyIndex_Array [KEYBOARD_KEYS + 1];
  49                 static const uint8_t KeyIndex_Size = KEYBOARD_KEYS;
  50
  51 extern volatile              uint8_t KeyIndex_Buffer[KEYBOARD_BUFFER];
  52 extern volatile              uint8_t KeyIndex_BufferUsed;
  53 extern volatile     uint8_t KeyIndex_Add_InputSignal;
  54
  55
  56
  57 // ----- Functions -----
  58
  59 void    Scan_setup( void );
  60 uint8_t Scan_loop( void );
  61
  62 // Callbacks from the Macro and Output modules (useful with difficult protocols)
  63 void Scan_finishedWithBuffer( uint8_t sentKeys );
  64 void Scan_finishedWithUSBBuffer( uint8_t sentKeys );
  65
  66
  67 #endif // __SCAN_LOOP_H
  68