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

Header file containing functions prototypes of ADC HAL library. More...

`#include "gr55xx_ll_bod.h"`
`#include "gr55xx_hal_def.h"`
`#include <stdbool.h>`
Include dependency graph for gr55xx_hal_bod.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
struct | _bod_handle
| BOD handle Structure definition. More...
struct | _hal_bod_callback
| HAL BOD Callback function definition. More...

## Macros
#define | HAL_BOD_ENABLE LL_BOD_ENABLE
| BOD enable More...
#define | HAL_BOD_DISABLE LL_BOD_DISABLE
| BOD disable More...
#define | HAL_BOD2_ENABLE LL_BOD2_ENABLE
| BOD2 enable More...
#define | HAL_BOD2_DISABLE LL_BOD2_DISABLE
| BOD2 disable More...
#define | HAL_BOD_STATIC_ENABLE LL_BOD_STATIC_ENABLE
| BOD STATIC enable More...
#define | HAL_BOD_STATIC_DISABLE LL_BOD_STATIC_DISABLE
| BOD STATIC disable More...
#define | HAL_BOD2_LEVEL_0 LL_BOD2_LEVEL_0
| BOD2 Level 0 More...
#define | HAL_BOD2_LEVEL_1 LL_BOD2_LEVEL_1
| BOD2 Level 1 More...
#define | HAL_BOD2_LEVEL_2 LL_BOD2_LEVEL_2
| BOD2 Level 2 More...
#define | HAL_BOD2_LEVEL_3 LL_BOD2_LEVEL_3
| BOD2 Level 3 More...
#define | HAL_BOD2_LEVEL_4 LL_BOD2_LEVEL_4
| BOD2 Level 4 More...
#define | HAL_BOD2_LEVEL_5 LL_BOD2_LEVEL_5
| BOD2 Level 5 More...
#define | HAL_BOD2_LEVEL_6 LL_BOD2_LEVEL_6
| BOD2 Level 6 More...
#define | HAL_BOD2_LEVEL_7 LL_BOD2_LEVEL_7
| BOD2 Level 7 More...
#define | HAL_BOD2_LEVEL_8 LL_BOD2_LEVEL_8
| BOD2 Level 8 More...
#define | HAL_BOD2_LEVEL_9 LL_BOD2_LEVEL_9
| BOD2 Level 9 More...
#define | HAL_BOD2_LEVEL_10 LL_BOD2_LEVEL_10
| BOD2 Level 10 More...
#define | HAL_BOD2_LEVEL_11 LL_BOD2_LEVEL_11
| BOD2 Level 11 More...
#define | HAL_BOD2_LEVEL_12 LL_BOD2_LEVEL_12
| BOD2 Level 12 More...
#define | HAL_BOD2_LEVEL_13 LL_BOD2_LEVEL_13
| BOD2 Level 13 More...
#define | HAL_BOD2_LEVEL_14 LL_BOD2_LEVEL_14
| BOD2 Level 14 More...
#define | HAL_BOD2_LEVEL_15 LL_BOD2_LEVEL_15
| BOD2 Level 15 More...

## Typedefs
typedef ll_bod_init_t | bod_init_t
| BOD init structure definition. More...
typedef struct _bod_handle | bod_handle_t
| BOD handle Structure definition. More...
typedef struct _hal_bod_callback | hal_bod_callback_t
| HAL BOD Callback function definition. More...

## Functions
hal_status_t | hal_bod_init (bod_handle_t *p_bod)
| Initialize the BOD according to the specified parameters in the bod_init_t and initialize the associated handle. More...
hal_status_t | hal_bod_deinit (bod_handle_t *p_bod)
| De-initialize the BOD peripheral. More...
void | hal_bod_msp_init (bod_handle_t *p_bod)
| Initialize the BOD MSP. More...
void | hal_bod_msp_deinit (bod_handle_t *p_bod)
| De-initialize the BOD MSP. More...
void | hal_bod_fedge_callback (bod_handle_t *p_bod)
| BOD fall edge callback. More...
void | hal_bod_redge_callback (bod_handle_t *p_bod)
| BOD rise edge callback. More...
void | hal_bod_fedge_irq_handler (bod_handle_t *p_bod)
| Handle BOD fall edge interrupt request. More...
void | hal_bod_redge_irq_handler (bod_handle_t *p_bod)
| Handle BOD rise edge interrupt request. More...
hal_status_t | hal_bod_enable (bod_handle_t *p_bod, uint8_t enable)
| enable bod More...
hal_status_t | hal_bod2_enable (bod_handle_t *p_bod, uint8_t enable)
| enable bod2 More...
hal_status_t | hal_bod2_set_level (bod_handle_t *p_bod, uint8_t level)
| Set BOD2 control level. More...
hal_status_t | hal_bod_static_mode_enable (bod_handle_t *p_bod, uint8_t enable)
| enable/disable static mode More...

## Detailed Description

Header file containing functions prototypes of ADC HAL 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_hal_bod.h.