cmp_001.h

Go to the documentation of this file.

/*
 * @brief CMP Registers and control functions
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __CMP_001_H_
#define __CMP_001_H_

#include "sys_config.h"
#include "cmsis.h"

#ifdef __cplusplus
extern "C" {
#endif

#define CMP_NUM         2

typedef struct {          
 __IO uint32_t  CMP_CTRL;       
 __IO uint32_t  CMP_CTRLx[CMP_NUM];     
} IP_CMP_001_T;

typedef enum IP_CMP_ENCTRL {
 CMP_ENCTRL_DISABLE,   
 CMP_ENCTRL_DIS_IN_DS_PWD, 
 CMP_ENCTRL_DIS_IN_PWD,  
 CMP_ENCTRL_ENABLE,   
} IP_CMP_ENCTRL_T;

#define CMP_CTRL_BITMASK     (0xF30F)

#define CMP_CTRL_PD_IREF_BITMASK            (0x03)

#define CMP_CTRL_PD_IREF(n)                 ((((uint32_t) (n)) & 0x03))

#define CMP_CTRL_PD_VBG_BITMASK             (((uint32_t) 0x03) << 2)

#define CMP_CTRL_PD_VBG(n)                  ((((uint32_t) (n)) & 0x03) << 2)

#define CMP_CTRL_ROSC_BITMASK               ((uint32_t) 0x300)

#define CMP_CTRL_ROSCCTL_CMP1               (0x00)

#define CMP_CTRL_ROSCCTL_CMP0               (((uint32_t) 0x01) << 8)

#define CMP_CTRL_EXT_RESET_INTERNAL         (0x00)

#define CMP_CTRL_EXT_RESET_CMPRESET         (((uint32_t) 0x01) << 9)

#define CMP_CTRL_TIMERCAPTURE_BITMASK       ((uint32_t) 0xF000)

#define CMP_CTRL_T0CAP2_0LEVEL              (0x00)

#define CMP_CTRL_T0CAP2_1LEVEL              (((uint32_t) 0x01) << 12)

#define CMP_CTRL_T0CAP3_0EDGE               (0x00)

#define CMP_CTRL_T0CAP3_1EDGE               (((uint32_t) 0x01) << 13)

#define CMP_CTRL_T1CAP2_1EDGE               (0x00)

#define CMP_CTRL_T1CAP2_0LEVEL              (((uint32_t) 0x01) << 14)

#define CMP_CTRL_T1CAP3_1LEVEL              (0x00)

#define CMP_CTRL_T1CAP3_0EDGE               (((uint32_t) 0x01) << 15)

#define CMP_CTRLx_BITMASK           ((uint32_t) 0x1F7FF77F)

#define CMP_CTRLx_EN_BITMASK            (0x03)

#define CMP_CTRLx_EN(n)                 ((((uint32_t) (n)) & 0x03))

#define CMP_CTRLx_OE                    (((uint32_t) 0x01) << 2)

#define CMP_CTRLx_STAT                  (((uint32_t) 0x01) << 3)

#define CMP_CTRLx_VM_BITMASK            (((uint32_t) 0x07) << 4)

#define CMP_CTRLx_VM(n)                 ((((uint32_t) (n)) & 0x07) << 4)

#define CMP_CTRLx_VP_BITMASK            (((uint32_t) 0x07) << 8)

#define CMP_CTRLx_VP(n)                 ((((uint32_t) (n)) & 0x07) << 8)

#define CMP_CTRLx_SYNC                  (((uint32_t) 0x01) << 12)

#define CMP_CTRLx_HYS_BITMASK           (((uint32_t) 0x03) << 13)

#define CMP_CTRLx_HYS(n)                ((((uint32_t) (n)) & 0x03) << 13)

#define CMP_CTRLx_INTCTRL_BITMASK       ((uint32_t) 0x78000)

#define CMP_CTRLx_INTPOL_NORMAL         (0x00)

#define CMP_CTRLx_INTPOL_INV            (((uint32_t) 0x01) << 15)

#define CMP_CTRLx_INTTYPE_EDGE          (0x00)

#define CMP_CTRLx_INTTYPE_LEVEL         (((uint32_t) 0x01) << 16)

#define CMP_CTRLx_INTEDGE_BITMASK       (((uint32_t) 0x03) << 17)

#define CMP_CTRLx_INTEDGE(n)            ((((uint32_t) (n)) & 0x03) << 17)

#define CMP_CTRLx_INTFLAG               (((uint32_t) 0x01) << 19)

#define CMP_CTRLx_VLADEN_BITMASK        (((uint32_t) 0x03) << 20)

#define CMP_CTRLx_VLADEN(n)             ((((uint32_t) (n)) & 0x03) << 20)

#define CMP_CTRLx_VLADREF_VREFCMP       (0x00)

#define CMP_CTRLx_VLADREF_VDDA          (((uint32_t) 0x01) << 22)

#define CMP_CTRLx_VSEL_BITMASK          ((uint32_t) ((0x1F) << 24))

#define CMP_CTRLx_VSEL(n)               ((((uint32_t) (n)) & 0x1F) << 24)

typedef enum IP_CMP_INPUT {
 CMP_INPUT_VREF_DIV,   
 CMP_INPUT_CMPx_IN0,   
 CMP_INPUT_CMPx_IN1,   
 CMP_INPUT_CMPx_IN2,   
 CMP_INPUT_CMPx_IN3,   
 CMP_INPUT_CMP_OTHER_IN0, 
 CMP_INPUT_INTERNAL_09VBG, 
} IP_CMP_INPUT_T;

typedef enum IP_CMP_HYS {
 CMP_HYS_NONE = CMP_CTRLx_HYS(0),  
 CMP_HYS_5MV  = CMP_CTRLx_HYS(1),  
 CMP_HYS_10MV = CMP_CTRLx_HYS(2),  
 CMP_HYS_15MV = CMP_CTRLx_HYS(3),  
} IP_CMP_HYS_T;

typedef enum IP_CMP_INTEDGE {
 CMP_INTEDGE_FALLING = CMP_CTRLx_INTEDGE(0), 
 CMP_INTEDGE_RISING  = CMP_CTRLx_INTEDGE(1), 
 CMP_INTEDGE_BOTH    = CMP_CTRLx_INTEDGE(2), 
} IP_CMP_INTEDGE_T;

STATIC INLINE void IP_CMP_Init(IP_CMP_001_T *pCMP) {}

STATIC INLINE void IP_CMP_DeInit(IP_CMP_001_T *pCMP) {}

STATIC INLINE void IP_CMP_EnableCurrentSrc(IP_CMP_001_T *pCMP,  IP_CMP_ENCTRL_T en)
{
 pCMP->CMP_CTRL = (pCMP->CMP_CTRL & (~CMP_CTRL_PD_IREF_BITMASK)) | CMP_CTRL_PD_IREF(en);
}

STATIC INLINE void IP_CMP_EnableBandGap(IP_CMP_001_T *pCMP,  IP_CMP_ENCTRL_T en)
{
 pCMP->CMP_CTRL = (pCMP->CMP_CTRL & (~CMP_CTRL_PD_VBG_BITMASK)) | CMP_CTRL_PD_VBG(en);
}

STATIC INLINE void IP_CMP_ControlROSC(IP_CMP_001_T *pCMP,  uint32_t flag)
{
 pCMP->CMP_CTRL = (pCMP->CMP_CTRL & (~CMP_CTRL_ROSC_BITMASK)) | flag;
}

STATIC INLINE void IP_CMP_SetTimerCapInput(IP_CMP_001_T *pCMP,  uint32_t flag)
{
 pCMP->CMP_CTRL = (pCMP->CMP_CTRL & (~CMP_CTRL_TIMERCAPTURE_BITMASK)) | flag;
}

STATIC INLINE void IP_CMP_SetupVoltLadder(IP_CMP_001_T *pCMP,  uint8_t id,
            uint16_t ladSel, uint32_t flag)
{
 pCMP->CMP_CTRLx[id] = (pCMP->CMP_CTRLx[id] & (~(CMP_CTRLx_VSEL_BITMASK | CMP_CTRLx_VLADREF_VDDA))) | CMP_CTRLx_VSEL(
  ladSel) | flag;
}

STATIC INLINE void IP_CMP_EnableVoltLadder(IP_CMP_001_T *pCMP,  uint8_t id, IP_CMP_ENCTRL_T en)
{
 pCMP->CMP_CTRLx[id] = (pCMP->CMP_CTRLx[id] & (~CMP_CTRLx_VLADEN_BITMASK)) | CMP_CTRLx_VLADEN(en);
}

STATIC INLINE void IP_CMP_SetPosVoltRef(IP_CMP_001_T *pCMP, uint8_t id, IP_CMP_INPUT_T input)
{
 pCMP->CMP_CTRLx[id] = (pCMP->CMP_CTRLx[id] & (~CMP_CTRLx_VP_BITMASK)) | CMP_CTRLx_VP(input);
}

STATIC INLINE void IP_CMP_SetNegVoltRef(IP_CMP_001_T *pCMP, uint8_t id, IP_CMP_INPUT_T input)
{
 pCMP->CMP_CTRLx[id] = (pCMP->CMP_CTRLx[id] & (~CMP_CTRLx_VM_BITMASK)) | CMP_CTRLx_VM(input);
}

STATIC INLINE void IP_CMP_SetHysteresis(IP_CMP_001_T *pCMP, uint8_t id, IP_CMP_HYS_T hys)
{
 pCMP->CMP_CTRLx[id] = (pCMP->CMP_CTRLx[id] & (~CMP_CTRLx_HYS_BITMASK)) | hys;
}

STATIC INLINE void IP_CMP_Enable(IP_CMP_001_T *pCMP,  uint8_t id, IP_CMP_ENCTRL_T en)
{
 pCMP->CMP_CTRLx[id] = (pCMP->CMP_CTRLx[id] & (~CMP_CTRLx_EN_BITMASK)) | CMP_CTRLx_EN(en);
}

STATIC INLINE FlagStatus IP_CMP_GetCmpStatus(IP_CMP_001_T *pCMP, uint8_t id)
{
 return (pCMP->CMP_CTRLx[id] & CMP_CTRLx_STAT) ? SET : RESET;
}

STATIC INLINE void IP_CMP_EnableOuput(IP_CMP_001_T *pCMP, uint8_t id)
{
 pCMP->CMP_CTRLx[id] |= CMP_CTRLx_OE;
}

STATIC INLINE void IP_CMP_DisableOutput(IP_CMP_001_T *pCMP, uint8_t id)
{
 pCMP->CMP_CTRLx[id] &= ~CMP_CTRLx_OE;
}

STATIC INLINE void IP_CMP_EnableSyncCmpOut(IP_CMP_001_T *pCMP, uint8_t id)
{
 pCMP->CMP_CTRLx[id] |= CMP_CTRLx_SYNC;
}

STATIC INLINE void IP_CMP_DisableSyncCmpOut(IP_CMP_001_T *pCMP, uint8_t id)
{
 pCMP->CMP_CTRLx[id] &= ~CMP_CTRLx_SYNC;
}

STATIC INLINE void IP_CMP_ConfigInt(IP_CMP_001_T *pCMP, uint8_t id,
         uint32_t intFlag,
         IP_CMP_INTEDGE_T edgeSel)
{
 pCMP->CMP_CTRLx[id] = (pCMP->CMP_CTRLx[id] & (~CMP_CTRLx_INTCTRL_BITMASK)) | intFlag | edgeSel;
}

STATIC INLINE FlagStatus IP_CMP_GetIntStatus(IP_CMP_001_T *pCMP, uint8_t id)
{
 return (pCMP->CMP_CTRLx[id] & CMP_CTRLx_INTFLAG) ? SET : RESET;
}

STATIC INLINE void IP_CMP_CMP_ClearIntStatus(IP_CMP_001_T *pCMP, uint8_t id)
{
 pCMP->CMP_CTRLx[id] |= CMP_CTRLx_INTFLAG;
}

#ifdef __cplusplus
}
#endif

#endif /* __CMP_001_H_ */