Data Structures | Macros | Typedefs | Functions
gr55xx_hal.h File Reference

This file contains all the functions prototypes for the HAL module driver. More...

`#include "gr55xx.h"`
`#include "gr55xx_hal_conf.h"`
`#include "gr55xx_delay.h"`

Go to the source code of this file.

## Data Structures
struct | _hal_callback
| HAL_HAL Callback function definition. More...

## Macros
#define | CO_MAX(a, b) ((a) > (b) ? (a) : (b))
| compare if a > b More...
#define | BLE_INT_DISABLE()
| Disable BLE_IRQn and BLESLP_IRQn. More...
#define | BLE_INT_RESTORE()
| Restore BLE_IRQn and BLESLP_IRQn. More...
#define | GLOBAL_INT_DISABLE()
| Disable interrupts globally in the system. This macro must be used in conjunction with the GLOBAL_INT_RESTORE macro since this last one will close the brace that the current macro opens. This means that both macros must be located at the same scope level. More...
#define | GLOBAL_INT_RESTORE()
| Restore external interrupts(Exception Type: 16~255) from the previous disable. More...
#define | LOCAL_INT_DISABLE(IRQn_Type)
| Disable external interrupts with a priority lower than IRQn_Type in the system. This macro must be used in conjunction with the LOCAL_INT_RESTORE macro since this last one will close the brace that the current macro opens. This means that both macros must be located at the same scope level. More...
#define | LOCAL_INT_RESTORE()
| Restore external interrupts(apart from the BLE) from the previous disable. More...
#define | CHECK_IS_ON_FPGA() (AON->FPGA_CTRL & AON_REG_FPGA_CTRL_EXIST)
| Check if the program is running on the FPGA platform.
#define | SYSTICK_RELOAD_VALUE (SysTick->LOAD)
#define | SYSTICK_CURRENT_VALUE (SysTick->VAL)

## Typedefs
typedef struct _hal_callback | hal_callback_t
| HAL_HAL Callback function definition.

## Functions
hal_status_t | hal_init (void)
| This function configures time base source, NVIC and Low level hardware. More...
hal_status_t | hal_deinit (void)
| This function de-initializes common part of the HAL and stops the source of time base. More...
void | hal_msp_init (void)
| Initialize the MSP. More...
void | hal_msp_deinit (void)
| De-initialize the MSP. More...
hal_status_t | hal_init_tick (uint32_t tick_priority)
| This function configures the source of the time base. More...
void | hal_suspend_tick (void)
| Suspend Tick increment. More...
void | hal_resume_tick (void)
| Resume Tick increment. More...
uint32_t | hal_get_hal_version (void)
| This function returns the HAL revision. More...

## Detailed Description

This file contains all the functions prototypes for the HAL module driver.

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.