app_rng.h File Reference

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

#include "grx_hal.h"
#include "app_drv_error.h"
#include "app_drv_config.h"

Go to the source code of this file.

Classes

struct  app_rng_evt_t
 RNG event structure definition. More...
 
struct  rng_env_t
 RNG device structure definition. More...
 
struct  app_rng_params_t
 RNG parameters structure definition. More...
 

Typedefs

typedef void(* app_rng_evt_handler_t) (app_rng_evt_t *p_evt)
 RNG event callback definition. More...
 

Enumerations

enum  app_rng_type_t {
  APP_RNG_TYPE_INTERRUPT,
  APP_RNG_TYPE_POLLING,
  APP_RNG_TYPE_MAX
}
 RNG operating mode Enumerations definition. More...
 
enum  app_rng_evt_type_t {
  APP_RNG_EVT_DONE,
  APP_RNG_EVT_ERROR
}
 RNG event Enumerations definition. More...
 
enum  app_rng_state_t {
  APP_RNG_INVALID = 0,
  APP_RNG_ACTIVITY
}
 App rng state types. More...
 

Functions

uint16_t app_rng_init (app_rng_params_t *p_params, app_rng_evt_handler_t evt_handler)
 Initialize the APP RNG DRIVER according to the specified parameters in the app_rng_params_t and app_rng_evt_handler_t. More...
 
uint16_t app_rng_deinit (void)
 De-initialize the APP RNG DRIVER peripheral. More...
 
uint16_t app_rng_gen_sync (uint16_t *p_seed, uint32_t *p_random32bit)
 Generate a 32-bit random number. More...
 
uint16_t app_rng_gen_async (uint16_t *p_seed)
 Generate a 32-bit random number in interrupt mode. More...
 
rng_handle_tapp_rng_get_handle (void)
 Return the RNG handle. More...
 

Detailed Description

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