Classes | Macros | Typedefs | Functions
gr55xx_ll_comp.h File Reference

Header file containing functions prototypes of COMP LL library. More...

`#include "gr55xx.h"`
Include dependency graph for gr55xx_ll_comp.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
struct | _ll_comp_init
| LL COMP init Structure definition. More...

## Macros
#define | LL_COMP_INPUT_SRC_IO0 (0UL << AON_RF_REG_10_CHANNEL_SEL_P_Pos)
| Set MSIO_0 as inputs for the comparator. More...
#define | LL_COMP_INPUT_SRC_IO1 (1UL << AON_RF_REG_10_CHANNEL_SEL_P_Pos)
| Set MSIO_1 as inputs for the comparator. More...
#define | LL_COMP_INPUT_SRC_IO2 (2UL << AON_RF_REG_10_CHANNEL_SEL_P_Pos)
| Set MSIO_2 as inputs for the comparator. More...
#define | LL_COMP_INPUT_SRC_IO3 (3UL << AON_RF_REG_10_CHANNEL_SEL_P_Pos)
| Set MSIO_3 as inputs for the comparator. More...
#define | LL_COMP_INPUT_SRC_IO4 (4UL << AON_RF_REG_10_CHANNEL_SEL_P_Pos)
| Set MSIO_4 as inputs for the comparator. More...
#define | LL_COMP_REF_SRC_IO0 (0UL << AON_RF_REG_10_CHANNEL_SEL_N_Pos)
| Set MSIO_0 as references for the comparator. More...
#define | LL_COMP_REF_SRC_IO1 (1UL << AON_RF_REG_10_CHANNEL_SEL_N_Pos)
| Set MSIO_1 as references for the comparator. More...
#define | LL_COMP_REF_SRC_IO2 (2UL << AON_RF_REG_10_CHANNEL_SEL_N_Pos)
| Set MSIO_2 as references for the comparator. More...
#define | LL_COMP_REF_SRC_IO3 (3UL << AON_RF_REG_10_CHANNEL_SEL_N_Pos)
| Set MSIO_3 as references for the comparator. More...
#define | LL_COMP_REF_SRC_IO4 (4UL << AON_RF_REG_10_CHANNEL_SEL_N_Pos)
| Set MSIO_4 as references for the comparator. More...
#define | LL_COMP_REF_SRC_VBAT (6UL << AON_RF_REG_10_CHANNEL_SEL_N_Pos)
| Set VBATT as references for the comparator More...
#define | LL_COMP_REF_SRC_VREF (7UL << AON_RF_REG_10_CHANNEL_SEL_N_Pos)
| Set VREF as references for the comparator More...
#define | LL_COMP_WriteReg(__instance__, __REG__, __VALUE__) WRITE_REG((__instance__)->__REG__, (__VALUE__))
| Write a value in COMP register. More...
#define | LL_COMP_ReadReg(__instance__, __REG__) READ_REG((__instance__)->__REG__)
| Read a value in COMP register. More...
#define | LL_COMP_DEFAULT_CONFIG
| Default configuartion for initializing structure. More...

## Typedefs
typedef struct _ll_comp_init | ll_comp_init_t
| LL COMP init Structure definition. More...

## Functions
__STATIC_INLINE void | ll_comp_enable (void)
| Enable COMP module. More...
__STATIC_INLINE void | ll_comp_disable (void)
| Disable COMP module. More...
__STATIC_INLINE void | ll_comp_set_input_src (uint32_t source)
| Set channel of COMP input source. More...
__STATIC_INLINE void | ll_comp_set_ref_src (uint32_t source)
| Set channel of COMP reference source. More...
__STATIC_INLINE void | ll_comp_set_vbatt_lvl (uint32_t level)
| Set VBATT control level. More...
__STATIC_INLINE void | ll_comp_set_vref_lvl (uint32_t level)
| Set VREF control level. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t | ll_comp_is_active_flag_it (void)
| Indicate if the COMP Interrupt Flag is set or not. More...
SECTION_RAM_CODE __STATIC_INLINE void | ll_comp_clear_flag_it (void)
| Clear Interrupt Status flag for COMP. More...
error_status_t | ll_comp_deinit (void)
| De-initialize COMP registers (Registers restored to their default values). More...
error_status_t | ll_comp_init (ll_comp_init_t *p_comp_init)
| Initialize COMP registers according to the specified. More...
void | ll_comp_struct_init (ll_comp_init_t *p_comp_init)
| Set each field of a ll_comp_init_t type structure to default value. More...

## Detailed Description

Header file containing functions prototypes of COMP LL library.

Author
  BLE Driver Team

Attention

  ##### Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file gr55xx_ll_comp.h.