Thomas Butler
cvb
Fork of
nrf51-sdk
by 
Lancaster University
source/nordic_sdk/components/softdevice/common/softdevice_handler/ant_stack_handler_types.h@9:d3dd910b0f4b, 2018-08-14 (annotated)
- Committer:
- tb942
- Date:
- Tue Aug 14 18:27:20 2018 +0000
- Revision:
- 9:d3dd910b0f4b
- Parent:
- 0:bc2961fa1ef0
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Jonathan Austin |
0:bc2961fa1ef0 | 1 | /* |
| Jonathan Austin |
0:bc2961fa1ef0 | 2 | * Copyright (c) Nordic Semiconductor ASA |
| Jonathan Austin |
0:bc2961fa1ef0 | 3 | * All rights reserved. |
| Jonathan Austin |
0:bc2961fa1ef0 | 4 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 5 | * Redistribution and use in source and binary forms, with or without modification, |
| Jonathan Austin |
0:bc2961fa1ef0 | 6 | * are permitted provided that the following conditions are met: |
| Jonathan Austin |
0:bc2961fa1ef0 | 7 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 8 | * 1. Redistributions of source code must retain the above copyright notice, this |
| Jonathan Austin |
0:bc2961fa1ef0 | 9 | * list of conditions and the following disclaimer. |
| Jonathan Austin |
0:bc2961fa1ef0 | 10 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 11 | * 2. Redistributions in binary form must reproduce the above copyright notice, this |
| Jonathan Austin |
0:bc2961fa1ef0 | 12 | * list of conditions and the following disclaimer in the documentation and/or |
| Jonathan Austin |
0:bc2961fa1ef0 | 13 | * other materials provided with the distribution. |
| Jonathan Austin |
0:bc2961fa1ef0 | 14 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 15 | * 3. Neither the name of Nordic Semiconductor ASA nor the names of other |
| Jonathan Austin |
0:bc2961fa1ef0 | 16 | * contributors to this software may be used to endorse or promote products |
| Jonathan Austin |
0:bc2961fa1ef0 | 17 | * derived from this software without specific prior written permission. |
| Jonathan Austin |
0:bc2961fa1ef0 | 18 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 19 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| Jonathan Austin |
0:bc2961fa1ef0 | 21 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| Jonathan Austin |
0:bc2961fa1ef0 | 22 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| Jonathan Austin |
0:bc2961fa1ef0 | 23 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
| Jonathan Austin |
0:bc2961fa1ef0 | 24 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| Jonathan Austin |
0:bc2961fa1ef0 | 25 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| Jonathan Austin |
0:bc2961fa1ef0 | 26 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
| Jonathan Austin |
0:bc2961fa1ef0 | 27 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| Jonathan Austin |
0:bc2961fa1ef0 | 28 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| Jonathan Austin |
0:bc2961fa1ef0 | 29 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| Jonathan Austin |
0:bc2961fa1ef0 | 30 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 31 | */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 32 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 33 | /**@file |
| Jonathan Austin |
0:bc2961fa1ef0 | 34 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 35 | * @defgroup ant_stack_handler_types Types definitions for ANT support in SoftDevice handler. |
| Jonathan Austin |
0:bc2961fa1ef0 | 36 | * @{ |
| Jonathan Austin |
0:bc2961fa1ef0 | 37 | * @ingroup softdevice_handler |
| Jonathan Austin |
0:bc2961fa1ef0 | 38 | * @brief This file contains the declarations of types required for ANT stack support. These |
| Jonathan Austin |
0:bc2961fa1ef0 | 39 | * types will be defined when the preprocessor define ANT_STACK_SUPPORT_REQD is defined. |
| Jonathan Austin |
0:bc2961fa1ef0 | 40 | */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 41 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 42 | #ifndef ANT_STACK_HANDLER_TYPES_H__ |
| Jonathan Austin |
0:bc2961fa1ef0 | 43 | #define ANT_STACK_HANDLER_TYPES_H__ |
| Jonathan Austin |
0:bc2961fa1ef0 | 44 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 45 | #ifdef ANT_STACK_SUPPORT_REQD |
| Jonathan Austin |
0:bc2961fa1ef0 | 46 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 47 | #include <stdlib.h> |
| Jonathan Austin |
0:bc2961fa1ef0 | 48 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 49 | #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. */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 50 | #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 to internal event buffer size needed. */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 51 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 52 | /**@brief ANT stack event type. */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 53 | typedef struct |
| Jonathan Austin |
0:bc2961fa1ef0 | 54 | { |
| Jonathan Austin |
0:bc2961fa1ef0 | 55 | uint8_t channel; /**< Channel number. */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 56 | uint8_t event; /**< Event code. */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 57 | uint8_t evt_buffer[ANT_STACK_EVT_MSG_BUF_SIZE]; /**< Event message buffer. */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 58 | } ant_evt_t; |
| Jonathan Austin |
0:bc2961fa1ef0 | 59 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 60 | /**@brief Application ANT stack event handler type. */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 61 | typedef void (*ant_evt_handler_t) (ant_evt_t * p_ant_evt); |
| Jonathan Austin |
0:bc2961fa1ef0 | 62 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 63 | /**@brief Function for registering for ANT events. |
| Jonathan Austin |
0:bc2961fa1ef0 | 64 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 65 | * @details The application should use this function to register for receiving ANT events from |
| Jonathan Austin |
0:bc2961fa1ef0 | 66 | * the SoftDevice. If the application does not call this function, then any ANT event |
| Jonathan Austin |
0:bc2961fa1ef0 | 67 | * that may be generated by the SoftDevice will NOT be fetched. Once the application has |
| Jonathan Austin |
0:bc2961fa1ef0 | 68 | * registered for the events, it is not possible to possible to cancel the registration. |
| Jonathan Austin |
0:bc2961fa1ef0 | 69 | * However, it is possible to register a different function for handling the events at |
| Jonathan Austin |
0:bc2961fa1ef0 | 70 | * any point of time. |
| Jonathan Austin |
0:bc2961fa1ef0 | 71 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 72 | * @param[in] ant_evt_handler Function to be called for each received ANT event. |
| Jonathan Austin |
0:bc2961fa1ef0 | 73 | * |
| Jonathan Austin |
0:bc2961fa1ef0 | 74 | * @retval NRF_SUCCESS Successful registration. |
| Jonathan Austin |
0:bc2961fa1ef0 | 75 | * @retval NRF_ERROR_NULL Null pointer provided as input. |
| Jonathan Austin |
0:bc2961fa1ef0 | 76 | */ |
| Jonathan Austin |
0:bc2961fa1ef0 | 77 | uint32_t softdevice_ant_evt_handler_set(ant_evt_handler_t ant_evt_handler); |
| Jonathan Austin |
0:bc2961fa1ef0 | 78 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 79 | #else |
| Jonathan Austin |
0:bc2961fa1ef0 | 80 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 81 | // The ANT Stack support is not required. |
| Jonathan Austin |
0:bc2961fa1ef0 | 82 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 83 | #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.*/ |
| Jonathan Austin |
0:bc2961fa1ef0 | 84 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 85 | #endif // ANT_STACK_SUPPORT_REQD |
| Jonathan Austin |
0:bc2961fa1ef0 | 86 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 87 | #endif // ANT_STACK_HANDLER_TYPES_H__ |
| Jonathan Austin |
0:bc2961fa1ef0 | 88 | |
| Jonathan Austin |
0:bc2961fa1ef0 | 89 | /** @} */ |