ble_radio_notification.h

00001 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
00002  *
00003  * The information contained herein is property of Nordic Semiconductor ASA.
00004  * Terms and conditions of usage are described in detail in NORDIC
00005  * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
00006  *
00007  * Licensees are granted free, non-transferable use of the information. NO
00008  * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
00009  * the file.
00010  */
00011 
00012 /** @file
00013  *
00014  * @defgroup ble_radio_notification Radio Notification Event Handler
00015  * @{
00016  * @ingroup ble_sdk_lib
00017  * @brief Module for propagating Radio Notification events to the application.
00018  */
00019 
00020 #ifndef BLE_RADIO_NOTIFICATION_H__
00021 #define BLE_RADIO_NOTIFICATION_H__
00022 
00023 #include <stdint.h>
00024 #include <stdbool.h>
00025 #include "nrf_soc.h"
00026 
00027 /**@brief Application radio notification event handler type. */
00028 typedef void (*ble_radio_notification_evt_handler_t) (bool radio_active);
00029 
00030 /**@brief Function for initializing the Radio Notification module.
00031  *
00032  * @param[in]  irq_priority   Interrupt priority for the Radio Notification interrupt handler.
00033  * @param[in]  distance       The time from an Active event until the radio is activated.
00034  * @param[in]  evt_handler    Handler to be executed when a radio notification event has been
00035  *                            received.
00036  *
00037  * @return     NRF_SUCCESS on successful initialization, otherwise an error code.
00038  */
00039 uint32_t ble_radio_notification_init(nrf_app_irq_priority_t               irq_priority,
00040                                      nrf_radio_notification_distance_t    distance,
00041                                      ble_radio_notification_evt_handler_t evt_handler);
00042 
00043 #endif // BLE_RADIO_NOTIFICATION_H__
00044 
00045 /** @} */