app_comp.h File Reference

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

#include "grx_hal.h"
#include "app_drv_error.h"
#include "app_drv_config.h"
#include "app_io.h"
+ Include dependency graph for app_comp.h:

Go to the source code of this file.

Classes

struct  app_comp_pin_t
 COMP pins Structures. More...
 
struct  app_comp_pin_cfg_t
 COMP pins config Structures. More...
 
struct  comp_env_t
 COMP device structure definition. More...
 
struct  app_comp_params_t
 COMP parameters structure definition. More...
 

Typedefs

typedef void(* app_comp_evt_handler_t) (app_comp_evt_t *p_evt)
 COMP event callback definition. More...
 

Enumerations

enum  app_comp_evt_t { APP_COMP_EVT_DONE, APP_COMP_EVT_ERROR }
 APP COMP event Enumerations definition. More...
 
enum  app_comp_state_t { APP_COMP_INVALID = 0, APP_COMP_ACTIVITY }
 App COMP state types. More...
 

Functions

uint16_t app_comp_init (app_comp_params_t *p_params, app_comp_evt_handler_t evt_handler)
 Initialize the APP COMP DRIVER according to the specified parameters in the app_comp_params_t and app_comp_evt_handler_t. More...
 
uint16_t app_comp_deinit (void)
 De-initialize the APP COMP DRIVER peripheral. More...
 
uint16_t app_comp_start (void)
 Start the comparator. More...
 
uint16_t app_comp_stop (void)
 Stop the comparator. More...
 
comp_handle_tapp_comp_get_handle (void)
 Return the COMP handle. More...
 

Detailed Description

Header file containing functions prototypes of COMP 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_comp.h.