Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of nRF51822 by
nordic/nrf-sdk/sd_common/ant_stack_handler_types.h@0:eff01767de02, 2014-03-26 (annotated)
- Committer:
- bogdanm
- Date:
- Wed Mar 26 14:38:17 2014 +0000
- Revision:
- 0:eff01767de02
- Child:
- 37:c29c330d942c
Initial import of the nRF51822 code
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| bogdanm | 0:eff01767de02 | 1 | /* Copyright (c) 2013 Nordic Semiconductor. All Rights Reserved. |
| bogdanm | 0:eff01767de02 | 2 | * |
| bogdanm | 0:eff01767de02 | 3 | * The information contained herein is property of Nordic Semiconductor ASA. |
| bogdanm | 0:eff01767de02 | 4 | * Terms and conditions of usage are described in detail in NORDIC |
| bogdanm | 0:eff01767de02 | 5 | * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. |
| bogdanm | 0:eff01767de02 | 6 | * |
| bogdanm | 0:eff01767de02 | 7 | * Licensees are granted free, non-transferable use of the information. NO |
| bogdanm | 0:eff01767de02 | 8 | * WARRANTY of ANY KIND is provided. This heading must NOT be removed from |
| bogdanm | 0:eff01767de02 | 9 | * the file. |
| bogdanm | 0:eff01767de02 | 10 | * |
| bogdanm | 0:eff01767de02 | 11 | */ |
| bogdanm | 0:eff01767de02 | 12 | |
| bogdanm | 0:eff01767de02 | 13 | /**@file |
| bogdanm | 0:eff01767de02 | 14 | * |
| bogdanm | 0:eff01767de02 | 15 | * @defgroup ant_stack_handler_types Types definitions for ANT support in SoftDevice handler. |
| bogdanm | 0:eff01767de02 | 16 | * @{ |
| bogdanm | 0:eff01767de02 | 17 | * @ingroup app_common |
| bogdanm | 0:eff01767de02 | 18 | * @brief This file contains the declarations of types required for ANT stack support. These |
| bogdanm | 0:eff01767de02 | 19 | * types will be defined when the preprocessor define ANT_STACK_SUPPORT_REQD is defined. |
| bogdanm | 0:eff01767de02 | 20 | */ |
| bogdanm | 0:eff01767de02 | 21 | |
| bogdanm | 0:eff01767de02 | 22 | #ifndef ANT_STACK_HANDLER_TYPES_H__ |
| bogdanm | 0:eff01767de02 | 23 | #define ANT_STACK_HANDLER_TYPES_H__ |
| bogdanm | 0:eff01767de02 | 24 | |
| bogdanm | 0:eff01767de02 | 25 | #ifdef ANT_STACK_SUPPORT_REQD |
| bogdanm | 0:eff01767de02 | 26 | |
| bogdanm | 0:eff01767de02 | 27 | #include <stdlib.h> |
| bogdanm | 0:eff01767de02 | 28 | #include "nordic_global.h" |
| bogdanm | 0:eff01767de02 | 29 | |
| bogdanm | 0:eff01767de02 | 30 | #define ANT_STACK_EVT_MSG_BUF_SIZE 32 /**< Size of ANT event message buffer. This will be provided to the SoftDevice while fetching an event. */ |
| bogdanm | 0:eff01767de02 | 31 | #define ANT_STACK_EVT_STRUCT_SIZE (sizeof(ant_evt_t)) /**< Size of the @ref ant_evt_t structure. This will be used by the @ref softdevice_handler.h to internal event buffer size needed. */ |
| bogdanm | 0:eff01767de02 | 32 | |
| bogdanm | 0:eff01767de02 | 33 | /**@brief ANT stack event type. */ |
| bogdanm | 0:eff01767de02 | 34 | typedef struct |
| bogdanm | 0:eff01767de02 | 35 | { |
| bogdanm | 0:eff01767de02 | 36 | uint8_t channel; /**< Channel number. */ |
| bogdanm | 0:eff01767de02 | 37 | uint8_t event; /**< Event code. */ |
| bogdanm | 0:eff01767de02 | 38 | uint8_t evt_buffer[ANT_STACK_EVT_MSG_BUF_SIZE]; /**< Event message buffer. */ |
| bogdanm | 0:eff01767de02 | 39 | } ant_evt_t; |
| bogdanm | 0:eff01767de02 | 40 | |
| bogdanm | 0:eff01767de02 | 41 | /**@brief Application ANT stack event handler type. */ |
| bogdanm | 0:eff01767de02 | 42 | typedef void (*ant_evt_handler_t) (ant_evt_t * p_ant_evt); |
| bogdanm | 0:eff01767de02 | 43 | |
| bogdanm | 0:eff01767de02 | 44 | /**@brief Function for registering for ANT events. |
| bogdanm | 0:eff01767de02 | 45 | * |
| bogdanm | 0:eff01767de02 | 46 | * @details The application should use this function to register for receiving ANT events from |
| bogdanm | 0:eff01767de02 | 47 | * the SoftDevice. If the application does not call this function, then any ANT event |
| bogdanm | 0:eff01767de02 | 48 | * that may be generated by the SoftDevice will NOT be fetched. Once the application has |
| bogdanm | 0:eff01767de02 | 49 | * registered for the events, it is not possible to possible to cancel the registration. |
| bogdanm | 0:eff01767de02 | 50 | * However, it is possible to register a different function for handling the events at |
| bogdanm | 0:eff01767de02 | 51 | * any point of time. |
| bogdanm | 0:eff01767de02 | 52 | * |
| bogdanm | 0:eff01767de02 | 53 | * @param[in] ant_evt_handler Function to be called for each received ANT event. |
| bogdanm | 0:eff01767de02 | 54 | * |
| bogdanm | 0:eff01767de02 | 55 | * @retval NRF_SUCCESS Successful registration. |
| bogdanm | 0:eff01767de02 | 56 | * @retval NRF_ERROR_NULL Null pointer provided as input. |
| bogdanm | 0:eff01767de02 | 57 | */ |
| bogdanm | 0:eff01767de02 | 58 | uint32_t softdevice_ant_evt_handler_set(ant_evt_handler_t ant_evt_handler); |
| bogdanm | 0:eff01767de02 | 59 | |
| bogdanm | 0:eff01767de02 | 60 | #else |
| bogdanm | 0:eff01767de02 | 61 | |
| bogdanm | 0:eff01767de02 | 62 | // The ANT Stack support is not required. |
| bogdanm | 0:eff01767de02 | 63 | |
| bogdanm | 0:eff01767de02 | 64 | #define ANT_STACK_EVT_STRUCT_SIZE 0 /**< Since the ANT stack support is not required, this is equated to 0, so that the @ref softdevice_handler.h can compute the internal event buffer size without having to care for ANT events.*/ |
| bogdanm | 0:eff01767de02 | 65 | |
| bogdanm | 0:eff01767de02 | 66 | #endif // ANT_STACK_SUPPORT_REQD |
| bogdanm | 0:eff01767de02 | 67 | |
| bogdanm | 0:eff01767de02 | 68 | #endif // ANT_STACK_HANDLER_TYPES_H__ |
| bogdanm | 0:eff01767de02 | 69 | |
| bogdanm | 0:eff01767de02 | 70 | /** @} */ |
