Macros | 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"`
Include dependency graph for gr55xx_hal.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Macros
#define | GLOBAL_EXCEPTION_DISABLE()
| Disable interrupts globally in the system(apart from the NMI). More...
#define | GLOBAL_EXCEPTION_ENABLE()
| Restore interrupts from the previous global disable(apart from the NMI). More...
#define | GLOBAL_INT_DISABLE()
| Disable interrupts globally in the system. More...
#define | GLOBAL_INT_RESTORE()
| Restore global interrupt. More...
#define | LOCAL_INT_DISABLE(IRQn_Type)
| Disable external interrupts with a priority lower than IRQn_Type in the system. More...
#define | LOCAL_INT_RESTORE()
| Restore external interrupts(apart from the BLE) from the previous disable. More...
#define | CHECK_IS_ON_FPGA() (MCU_SUB->FPGA_CTRL & MCU_SUB_FPGA_CTRL_REG_EXIST)
| Check if the program is running on the FPGA platform. More...
#define | SYSTICK_RELOAD_VALUE (SysTick->LOAD)
| SysTick Reload value. More...
#define | SYSTICK_CURRENT_VALUE (SysTick->VAL)
| SysTick Current value. More...

## 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...
void | hal_systick_irq_handler (void)
| This function handles SYSTICK interrupt request. More...
void | hal_systick_callback (void)
| SYSTICK callback. More...
void | hal_increment_tick (void)
| This function is called to increment a global variable "g_tick" used as application time base. More...
uint32_t | hal_get_tick (void)
| Povides a tick value in millisecond. More...
void | hal_delay (__IO uint32_t delay)
| This function provides accurate delay (in milliseconds) based on variable incremented. 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...
void | hal_dwt_enable (uint32_t _demcr_initial, uint32_t _dwt_ctrl_initial)
| This function enable the DWT function. More...
void | hal_dwt_disable (uint32_t _demcr_initial, uint32_t _dwt_ctrl_initial)
| This function disable the DWT function. 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.

Definition in file gr55xx_hal.h.