pan_kscan.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Panchip Technology Corp. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0 
 */
 
#ifndef __PAN_KSCAN_H__
#define __PAN_KSCAN_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define KS_PERIPHRAL_ENABLE                 (0X00000001)  
#define KS_WAKEUP_ENABLE                    (0X00000002)  
#define KS_WAKEUP_AND_PERIPH_ENABLE         (0X00000003)  
#define KS_INTERVAL_TIME_CLK_1              (0X0)   
#define KS_INTERVAL_TIME_CLK_2              (0X1)   
#define KS_INTERVAL_TIME_CLK_4              (0X2)   
#define KS_INTERVAL_TIME_CLK_8              (0X3)   
#define KS_INTERVAL_TIME_CLK_16             (0X4)   
#define KS_INTERVAL_TIME_CLK_32             (0X5)   
#define KS_INTERVAL_TIME_CLK_64             (0X6)   
#define KS_INTERVAL_TIME_CLK_128            (0X7)   
#define KS_INTERVAL_TIME_CLK_256            (0X8)   
#define KS_INTERVAL_TIME_CLK_512            (0X9)   
#define KS_INTERVAL_TIME_CLK_1024           (0XA)   
#define KS_INTERVAL_TIME_CLK_2048           (0XB)   
#define KS_INTERVAL_TIME_CLK_4K             (0XC)   
#define KS_INTERVAL_TIME_CLK_8K             (0XD)   
#define KS_INTERVAL_TIME_CLK_16K            (0XE)   
#define KS_INTERVAL_TIME_CLK_32K            (0XF)   
__STATIC_INLINE void KS_Enable(KSCAN_T *ks,FunctionalState NewState,uint32_t func)
{
    (NewState != DISABLE)?((ks)->KS_EN |= func):((ks)->KS_EN &= ~func);
}
 
 
__STATIC_INLINE void KS_InputEnable(KSCAN_T *ks,FunctionalState NewState,uint32_t func)
{
    (NewState != DISABLE)?((ks)->KS_IO_CFG |= func):((ks)->KS_IO_CFG &= ~func);
}
 
__STATIC_INLINE void KS_OutputEnable(KSCAN_T *ks,FunctionalState NewState,uint32_t func)
{
    (NewState != DISABLE)?((ks)->KS_IO_CFG |= (func << 8)):((ks)->KS_IO_CFG &= ~(func << 8));
}
 
__STATIC_INLINE void KS_IntEnable(KSCAN_T *ks,FunctionalState NewState)
{
    (NewState != DISABLE)?((ks)->KS_INT_CFG |= KS_INT_ENABLE_Msk):((ks)->KS_INT_CFG &= ~KS_INT_ENABLE_Msk);
}
 
__STATIC_INLINE bool KS_StatusCheck(KSCAN_T *ks,uint32_t func)
{
    return ((ks)->KS_INT_CFG & func)?(true):(false);
}
 
__STATIC_INLINE void KS_ClearFlag(KSCAN_T *ks,uint32_t func)
{
    (ks)->KS_INT_CFG |= func;
}
 
__STATIC_INLINE void KS_SetKeyscanPolarity(KSCAN_T *ks,FunctionalState NewState)
{
    (NewState != DISABLE)?((ks)->KS_CFG |= KS_POLARITY_VALID_HIGH_Msk):((ks)->KS_CFG &= ~KS_POLARITY_VALID_HIGH_Msk);
}
 
__STATIC_INLINE void KS_ClearKeyscanStatus(KSCAN_T *ks,FunctionalState NewState)
{
    (NewState != DISABLE)?((ks)->KS_CFG |= KS_STATUS_CLEAR_Msk):((ks)->KS_CFG &= ~KS_STATUS_CLEAR_Msk);
}
 
__STATIC_INLINE void KS_SetFrameInterval(KSCAN_T *ks,uint32_t func)
{
    (ks)->KS_CFG = ((ks)->KS_CFG & ~KS_SCAN_INTERVAL_Msk) | (func << KS_SCAN_INTERVAL_Pos);
}
 
__STATIC_INLINE uint32_t KS_GetFrameInterval(KSCAN_T *ks)
{
    return (((ks)->KS_CFG & KS_SCAN_INTERVAL_Msk) >> KS_SCAN_INTERVAL_Pos);
}
 
__STATIC_INLINE void KS_SetRowInterval(KSCAN_T *ks,uint32_t func)
{
    (ks)->KS_CFG = ((ks)->KS_CFG & ~KS_ROW_INTERVAL_Msk) | (func << KS_ROW_INTERVAL_Pos);
}
__STATIC_INLINE uint32_t KS_GetRowInterval(KSCAN_T *ks)
{
    return (((ks)->KS_CFG & KS_ROW_INTERVAL_Msk) >> KS_ROW_INTERVAL_Pos);
}
 
__STATIC_INLINE void KS_SetDebounceTime(KSCAN_T *ks,uint32_t func)
{
    (ks)->KS_CFG = ((ks)->KS_CFG & ~KS_DEBOUNCE_TIME_Msk) | (func << KS_DEBOUNCE_TIME_Pos);
}
 
__STATIC_INLINE uint32_t KS_GetDebounceTime(KSCAN_T *ks)
{
    return (((ks)->KS_CFG & KS_DEBOUNCE_TIME_Msk) >> KS_DEBOUNCE_TIME_Pos);
}
__STATIC_INLINE void KS_WaitScanFinish(KSCAN_T *ks,bool enable)
{
    (enable) ? (ks->KS_EN |= KS_DLY_DISABLE_Msk) : (ks->KS_EN &= ~KS_DLY_DISABLE_Msk);
}
uint32_t KS_ReadKeyRowInfo(KSCAN_T *ks,uint8_t rowIdx);
 
bool KS_IsKeyPressed(KSCAN_T *ks,uint8_t rowIdx,uint8_t colIdx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PAN_KSCAN_H__ */