keys.h

Go to the documentation of this file.

/* Header file for eXPal key scanning system */
/* Copyright (C) 2009 Thomas Klosa
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) version 3.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License along
 *   with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef HL_KEYS_H
#define HL_KEYS_H


#include <avr/pgmspace.h>

#include "xpal_disp_areas.h"

typedef uint16_t keyscan_t;


#define HL_NOKEY                0

#define HL_KEY_PRESSED  0xFFFF


#define BLD_SC(col, row, row_abc) ((_BV(col)<<8) | (_BV(row_abc)<<8) | _BV(row))  //!< \n

 
#define HL_SCAN_SOFT1           BLD_SC(HL_KEY_COL0,HL_KEY_ROW0,HL_KEY_ROW_A_ID) //!< Display SOFT1 - up left
#define HL_SCAN_SOFT2           BLD_SC(HL_KEY_COL0,HL_KEY_ROW1,HL_KEY_ROW_A_ID) //!< Display SOFT2
#define HL_SCAN_SOFT3           BLD_SC(HL_KEY_COL0,HL_KEY_ROW2,HL_KEY_ROW_A_ID) //!< Display SOFT3 - bottom left

#define HL_SCAN_SOFT4           BLD_SC(HL_KEY_COL0,HL_KEY_ROW3,HL_KEY_ROW_A_ID) //!< Display SOFT4 - below left
#define HL_SCAN_SOFT5           BLD_SC(HL_KEY_COL0,HL_KEY_ROW4,HL_KEY_ROW_B_ID) //!< Display SOFT5
#define HL_SCAN_SOFT6           BLD_SC(HL_KEY_COL0,HL_KEY_ROW5,HL_KEY_ROW_B_ID) //!< Display SOFT6
#define HL_SCAN_SOFT7           BLD_SC(HL_KEY_COL0,HL_KEY_ROW6,HL_KEY_ROW_B_ID) //!< Display SOFT7
#define HL_SCAN_SOFT8           BLD_SC(HL_KEY_COL0,HL_KEY_ROW7,HL_KEY_ROW_B_ID) //!< Display SOFT8 - below right

#define HL_SCAN_SOFT9           BLD_SC(HL_KEY_COL0,HL_KEY_ROW8,HL_KEY_ROW_B_ID) //!< Display SOFT9 - up right
#define HL_SCAN_SOFT10          BLD_SC(HL_KEY_COL0,HL_KEY_ROW9,HL_KEY_ROW_B_ID) //!< Display SOFT10
#define HL_SCAN_SOFT11          BLD_SC(HL_KEY_COL0,HL_KEY_ROW10,HL_KEY_ROW_B_ID)//!< Display SOFT11 - bottom right\n

#define HL_SCAN_LEFT_II         BLD_SC(HL_KEY_COL2,HL_KEY_ROW0,HL_KEY_ROW_A_ID) //!< Left Thumb - II
#define HL_SCAN_LEFT_I          BLD_SC(HL_KEY_COL2,HL_KEY_ROW1,HL_KEY_ROW_A_ID) //!< Left Thumb - I
#define HL_SCAN_LEFT_ESC        BLD_SC(HL_KEY_COL2,HL_KEY_ROW2,HL_KEY_ROW_A_ID) //!< Left Thumb - ESC
#define HL_SCAN_LEFT_OK         BLD_SC(HL_KEY_COL2,HL_KEY_ROW3,HL_KEY_ROW_A_ID) //!< Left Thumb - OK

#define HL_SCAN_RIGHT_II        BLD_SC(HL_KEY_COL2,HL_KEY_ROW4,HL_KEY_ROW_B_ID) //!< Right Thumb - II
#define HL_SCAN_RIGHT_I         BLD_SC(HL_KEY_COL2,HL_KEY_ROW5,HL_KEY_ROW_B_ID) //!< Right Thumb - I
#define HL_SCAN_RIGHT_ESC       BLD_SC(HL_KEY_COL2,HL_KEY_ROW6,HL_KEY_ROW_B_ID) //!< Right Thumb - ESC
#define HL_SCAN_RIGHT_OK        BLD_SC(HL_KEY_COL2,HL_KEY_ROW7,HL_KEY_ROW_B_ID) //!< Right Thumb - OK\n

#define HL_SCAN_NUM0            BLD_SC(HL_KEY_COL1,HL_KEY_ROW0,HL_KEY_ROW_A_ID) //!< Number Area 0 - bottom center
#define HL_SCAN_NUM1            BLD_SC(HL_KEY_COL1,HL_KEY_ROW1,HL_KEY_ROW_A_ID) //!< Number Area 1
#define HL_SCAN_NUM2            BLD_SC(HL_KEY_COL1,HL_KEY_ROW2,HL_KEY_ROW_A_ID) //!< Number Area 2
#define HL_SCAN_NUM3            BLD_SC(HL_KEY_COL1,HL_KEY_ROW3,HL_KEY_ROW_A_ID) //!< Number Area 3
#define HL_SCAN_NUM4            BLD_SC(HL_KEY_COL1,HL_KEY_ROW4,HL_KEY_ROW_B_ID) //!< Number Area 4
#define HL_SCAN_NUM5            BLD_SC(HL_KEY_COL1,HL_KEY_ROW5,HL_KEY_ROW_B_ID) //!< Number Area 5
#define HL_SCAN_NUM6            BLD_SC(HL_KEY_COL1,HL_KEY_ROW6,HL_KEY_ROW_B_ID) //!< Number Area 6
#define HL_SCAN_NUM7            BLD_SC(HL_KEY_COL1,HL_KEY_ROW7,HL_KEY_ROW_B_ID) //!< Number Area 7
#define HL_SCAN_NUM8            BLD_SC(HL_KEY_COL1,HL_KEY_ROW8,HL_KEY_ROW_B_ID) //!< Number Area 8
#define HL_SCAN_NUM9            BLD_SC(HL_KEY_COL1,HL_KEY_ROW9,HL_KEY_ROW_B_ID) //!< Number Area 9
#define HL_SCAN_STAR            BLD_SC(HL_KEY_COL1,HL_KEY_ROW10,HL_KEY_ROW_B_ID)        //!< Number Area *
#define HL_SCAN_POUND           BLD_SC(HL_KEY_COL1,HL_KEY_ROW11,HL_KEY_ROW_B_ID)        //!< Number Area #\n

#define HL_SCAN_POWER           BLD_SC(HL_KEY_COL3,HL_KEY_ROW0,HL_KEY_ROW_A_ID) //!< Power Key

/* Key States */
#define HL_KEYSTATE_SAME        0x01    //!< Scan Code is the same as during the last call of hlKeyTmTick() 
#define HL_KEYSTATE_OTHER       0x02    //!< Scan Code is different as during the last call of hlKeyTmTick() 
#define HL_KEYSTATE_PWR         0x04    //!< Current Scan Code is for Power key
#define HL_KEYSTATE_PREVIOUS 0x08       //!< Scan Code is equal to the last key down


/* Key Timing  */
#define HL_KEY_DEBOUNCE_CYCLES  1       //!< Key recognized after n poll cycles
#define HL_KEY_STAY_AKTIVE              4       //!< cycles to stay active after key up
#define HL_KEY_WAIT_ALT_FKT             50      //!< wait for same key again, polls to keep splash screen open
#define HL_KEY_MAX_KEY_FUNCT    3   //!< maximum number of key codes per key
#define HL_KEY_INT_MIN_CYCLE    5   //!< minimum number of timer cycles to run after a key interrupt, max 126.
#define HL_KEY_PWR_ON_SEQUENCE  -1  //!< system is debouncing a power on cycle

#define HL_KEY_BUFSZ    8                       //!< size of key buffer

typedef enum {
  KEY_UP        = 0, 
  ALLOW_SLEEP   = 1, 
  MOVING_DOWN   = 2, 
  KEY_DOWN      = 3, 
  MOVING_UP     = 4, 
  OFF_KEY_UP    = 5, 
  PWR_OFF       = 6, 
  KEY_PROCESSED = 7, 
  POWER_ON      = 8, 
} hl_key_DebounceStates;




/*******************************************************************/
/* Function prototypes */

void hl_Key_Init(void);


uint16_t hlKeyTmTick(void);     // key handling routine, must be called every 20ms


uint8_t hlGetKeySc(keyscan_t *Key);     


void  hlAllKeyWakeup(void);


void  hlRow3KeyWakeup(void);


#endif