Scan/BETKB/scan_loop.h

   1 /* Copyright (C) 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
  32
  33
  34 // ----- Defines -----
  35
  36 #define KEYBOARD_KEYS 0x7F // 127 - Size of the array space for the keyboard(max index)
  37 #define KEYBOARD_BUFFER 24 // Max number of key signals to buffer
  38
  39
  40
  41 // ----- Variables -----
  42
  43 extern volatile     uint8_t KeyIndex_Buffer[KEYBOARD_BUFFER];
  44 extern volatile     uint8_t KeyIndex_BufferUsed;
  45 extern volatile     uint8_t KeyIndex_Add_InputSignal;
  46
  47
  48
  49 // ----- Functions -----
  50
  51 // Functions used by main.c
  52 void Scan_setup( void );
  53 uint8_t Scan_loop( void );
  54
  55
  56 // Functions available to macro.c
  57 uint8_t Scan_sendData( uint8_t dataPayload );
  58
  59 void Scan_finishedWithBuffer( uint8_t sentKeys );
  60 void Scan_finishedWithUSBBuffer( uint8_t sentKeys );
  61 void Scan_lockKeyboard( void );
  62 void Scan_unlockKeyboard( void );
  63 void Scan_resetKeyboard( void );
  64
  65
  66 #endif // __SCAN_LOOP_H
  67