Classes | Typedefs | Enumerations | Functions
app_dual_tim.h File Reference

Header file containing functions prototypes of DUAL TIM app library. More...

`#include "grx_hal.h"`
`#include "app_drv_error.h"`
`#include "app_drv_config.h"`
Include dependency graph for app_dual_tim.h:

Go to the source code of this file.

## Classes
struct | dual_tim_env_t
| DUAL_TIM device structure definition. More...
struct | app_dual_tim_params_t
| DUAL_TIM parameters structure definition. More...

## Typedefs
typedef void(* | app_dual_tim_evt_handler_t) (app_dual_tim_evt_t *p_evt)
| APP_DUAL_TIM event callback definition. More...

## Enumerations
enum | app_dual_tim_id_t { APP_DUAL_TIM_ID_0, APP_DUAL_TIM_ID_1, APP_DUAL_TIM_ID_MAX }
| APP_DUAL_TIM module Enumerations definition. More...
enum | app_dual_tim_evt_t { APP_DUAL_TIM_EVT_ERROR, APP_DUAL_TIM_EVT_DONE }
| DUAL_TIM event Enumerations definition. More...
enum | app_dual_tim_state_t { APP_DUAL_TIM_INVALID = 0, APP_DUAL_TIM_ACTIVITY }
| DUAL_TIM state type Enumerations definition. More...

## Functions
uint16_t | app_dual_tim_init (app_dual_tim_params_t *p_params, app_dual_tim_evt_handler_t evt_handler)
| Initialize the APP DUAL TIM DRIVER according to the specified parameters in the app_dual_tim_params_t and app_dual_tim_evt_handler_t. More...
uint16_t | app_dual_tim_deinit (app_dual_tim_id_t id)
| De-initialize the APP DUAL TIM DRIVER peripheral. More...
uint16_t | app_dual_tim_start (app_dual_tim_id_t id)
| Starts the DUAL TIM counter in interrupt mode. More...
uint16_t | app_dual_tim_stop (app_dual_tim_id_t id)
| Stops the DUAL TIM counter in interrupt mode. More...
uint16_t | app_dual_tim_set_params (app_dual_tim_params_t *p_params, app_dual_tim_id_t id)
| Set the APP DUAL TIM according to the specified parameters. More...
uint16_t | app_dual_tim_set_background_reload (app_dual_tim_id_t id, uint32_t reload_value)
| Set the APP DUAL TIM background reload value The background reload value contains the value from which the counter is to decrement. More...
dual_timer_handle_t * | app_dual_tim_get_handle (app_dual_tim_id_t id)
| Return the DUAL TIM handle. More...
uint16_t | app_dual_tim_set_reload_value_bg_reload_value (app_dual_tim_id_t id, uint32_t reload_value, uint32_t bg_reload_value)
| Set the APP DUAL TIM background reload value and current reload value The background reload value contains the value from which the counter is to decrement. More...
uint32_t | app_dual_tim_get_counter_value (app_dual_tim_id_t id)
| Return the DUAL TIM counter. More...

## Detailed Description

Header file containing functions prototypes of DUAL TIM app 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 app_dual_tim.h.