fsl_kpp.h

/*
 * Copyright 2017, 2019 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef _FSL_KPP_H_
#define _FSL_KPP_H_
 
#include "fsl_common.h"
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
#define FSL_KPP_DRIVER_VERSION (MAKE_VERSION(2, 0, 0))
#define KPP_KEYPAD_COLUMNNUM_MAX (8U)
#define KPP_KEYPAD_ROWNUM_MAX    (8U)
 
typedef enum _kpp_interrupt_enable
{
    kKPP_keyDepressInterrupt = KPP_KPSR_KDIE_MASK, 
    kKPP_keyReleaseInterrupt = KPP_KPSR_KRIE_MASK  
} kpp_interrupt_enable_t;
 
typedef enum _kpp_sync_operation
{
    kKPP_ClearKeyDepressSyncChain = KPP_KPSR_KDSC_MASK, 
    kKPP_SetKeyReleasesSyncChain  = KPP_KPSR_KRSS_MASK, 
} kpp_sync_operation_t;
 
typedef struct _kpp_config
{
    uint8_t activeRow;    
    uint8_t activeColumn; 
    uint16_t interrupt;   
} kpp_config_t;
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif
 
void KPP_Init(KPP_Type *base, kpp_config_t *configure);
 
void KPP_Deinit(KPP_Type *base);
 
/* @} */
 
static inline void KPP_EnableInterrupts(KPP_Type *base, uint16_t mask)
{
    uint16_t data = (uint16_t)(base->KPSR & ~(KPP_KPSR_KPKR_MASK | KPP_KPSR_KPKD_MASK));
    base->KPSR    = data | mask;
}
 
static inline void KPP_DisableInterrupts(KPP_Type *base, uint16_t mask)
{
    base->KPSR &= ~(mask | KPP_KPSR_KPKR_MASK | KPP_KPSR_KPKD_MASK);
}
 
static inline uint16_t KPP_GetStatusFlag(KPP_Type *base)
{
    return (base->KPSR & (KPP_KPSR_KPKR_MASK | KPP_KPSR_KPKD_MASK)) << KPP_KPSR_KDIE_SHIFT;
}
 
static inline void KPP_ClearStatusFlag(KPP_Type *base, uint16_t mask)
{
    base->KPSR |= (uint16_t)((mask) >> KPP_KPSR_KDIE_SHIFT);
}
 
static inline void KPP_SetSynchronizeChain(KPP_Type *base, uint16_t mask)
{
    uint16_t data = base->KPSR & (KPP_KPSR_KRSS_MASK | KPP_KPSR_KDSC_MASK | KPP_KPSR_KRIE_MASK | KPP_KPSR_KDIE_MASK);
    base->KPSR    = data | mask;
}
 
void KPP_keyPressScanning(KPP_Type *base, uint8_t *data, uint32_t clockSrc_Hz);
 
/* @} */
 
#if defined(__cplusplus)
}
#endif
 
#endif /* _FSL_KPP_H_*/