Glimworm Beacons / nRF51822

test

Fork of nRF51822 by Nordic Semiconductor

source/nordic-sdk/components/ble/ble_radio_notification/ble_radio_notification.h@448:b71e96a821de, 2015-10-10 (annotated)

Committer:
GlimwormBeacons
Date:
Sat Oct 10 09:19:50 2015 +0000
Revision:
448:b71e96a821de
Parent:
387:b13ab9a7ddb9 
test

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 371:8f7d2137727a 1 /*
rgrover1 371:8f7d2137727a 2 * Copyright (c) Nordic Semiconductor ASA
rgrover1 371:8f7d2137727a 3 * All rights reserved.
rgrover1 371:8f7d2137727a 4 *
rgrover1 371:8f7d2137727a 5 * Redistribution and use in source and binary forms, with or without modification,
rgrover1 371:8f7d2137727a 6 * are permitted provided that the following conditions are met:
rgrover1 371:8f7d2137727a 7 *
rgrover1 371:8f7d2137727a 8 * 1. Redistributions of source code must retain the above copyright notice, this
rgrover1 371:8f7d2137727a 9 * list of conditions and the following disclaimer.
rgrover1 371:8f7d2137727a 10 *
rgrover1 371:8f7d2137727a 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
rgrover1 371:8f7d2137727a 12 * list of conditions and the following disclaimer in the documentation and/or
rgrover1 371:8f7d2137727a 13 * other materials provided with the distribution.
rgrover1 371:8f7d2137727a 14 *
rgrover1 371:8f7d2137727a 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
rgrover1 371:8f7d2137727a 16 * contributors to this software may be used to endorse or promote products
rgrover1 371:8f7d2137727a 17 * derived from this software without specific prior written permission.
rgrover1 371:8f7d2137727a 18 *
rgrover1 371:8f7d2137727a 19 *
rgrover1 371:8f7d2137727a 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
rgrover1 371:8f7d2137727a 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
rgrover1 371:8f7d2137727a 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
rgrover1 371:8f7d2137727a 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
rgrover1 371:8f7d2137727a 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
rgrover1 371:8f7d2137727a 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
rgrover1 371:8f7d2137727a 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
rgrover1 371:8f7d2137727a 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
rgrover1 371:8f7d2137727a 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
rgrover1 371:8f7d2137727a 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
rgrover1 371:8f7d2137727a 30 *
rgrover1 371:8f7d2137727a 31 */
rgrover1 371:8f7d2137727a 32
rgrover1 371:8f7d2137727a 33 /** @file
rgrover1 371:8f7d2137727a 34 *
rgrover1 371:8f7d2137727a 35 * @defgroup ble_radio_notification Radio Notification Event Handler
rgrover1 371:8f7d2137727a 36 * @{
rgrover1 371:8f7d2137727a 37 * @ingroup ble_sdk_lib
rgrover1 371:8f7d2137727a 38 * @brief Module for propagating Radio Notification events to the application.
rgrover1 371:8f7d2137727a 39 */
rgrover1 371:8f7d2137727a 40
rgrover1 371:8f7d2137727a 41 #ifndef BLE_RADIO_NOTIFICATION_H__
rgrover1 371:8f7d2137727a 42 #define BLE_RADIO_NOTIFICATION_H__
rgrover1 371:8f7d2137727a 43
rgrover1 371:8f7d2137727a 44 #include <stdint.h>
rgrover1 371:8f7d2137727a 45 #include <stdbool.h>
rgrover1 371:8f7d2137727a 46 #include "nrf_soc.h"
rgrover1 371:8f7d2137727a 47
rgrover1 371:8f7d2137727a 48 #ifdef __cplusplus
rgrover1 371:8f7d2137727a 49 extern "C" {
rgrover1 371:8f7d2137727a 50 #endif
rgrover1 371:8f7d2137727a 51
rgrover1 371:8f7d2137727a 52 /**@brief Application radio notification event handler type. */
rgrover1 371:8f7d2137727a 53 typedef void (*ble_radio_notification_evt_handler_t) (bool radio_active);
rgrover1 371:8f7d2137727a 54
rgrover1 371:8f7d2137727a 55 /**@brief Function for initializing the Radio Notification module.
rgrover1 371:8f7d2137727a 56 *
rgrover1 371:8f7d2137727a 57 * @param[in] irq_priority Interrupt priority for the Radio Notification interrupt handler.
rgrover1 371:8f7d2137727a 58 * @param[in] distance The time from an Active event until the radio is activated.
rgrover1 371:8f7d2137727a 59 * @param[in] evt_handler Handler to be executed when a radio notification event has been
rgrover1 371:8f7d2137727a 60 * received.
rgrover1 371:8f7d2137727a 61 *
rgrover1 371:8f7d2137727a 62 * @return NRF_SUCCESS on successful initialization, otherwise an error code.
rgrover1 371:8f7d2137727a 63 */
rgrover1 371:8f7d2137727a 64 uint32_t ble_radio_notification_init(nrf_app_irq_priority_t irq_priority,
rgrover1 371:8f7d2137727a 65 nrf_radio_notification_distance_t distance,
rgrover1 371:8f7d2137727a 66 ble_radio_notification_evt_handler_t evt_handler);
rgrover1 371:8f7d2137727a 67
rgrover1 371:8f7d2137727a 68 #ifdef __cplusplus
rgrover1 371:8f7d2137727a 69 }
rgrover1 371:8f7d2137727a 70 #endif
rgrover1 371:8f7d2137727a 71
rgrover1 371:8f7d2137727a 72 #endif // BLE_RADIO_NOTIFICATION_H__
rgrover1 371:8f7d2137727a 73
rgrover1 371:8f7d2137727a 74 /** @} */