mbed official
The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_NRF51_DONGLE/TOOLCHAIN_ARM_STD/ant_stack_handler_types.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_TY51822R3/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/softdevice/common/softdevice_handler/ant_stack_handler_types.h@169:a7c7b631e539
mbed library. Release version 164
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| AnnaBridge | 143:86740a56073b | 1 | /* |
| AnnaBridge | 143:86740a56073b | 2 | * Copyright (c) 2013 Nordic Semiconductor ASA |
| AnnaBridge | 143:86740a56073b | 3 | * All rights reserved. |
| AnnaBridge | 143:86740a56073b | 4 | * |
| AnnaBridge | 143:86740a56073b | 5 | * Redistribution and use in source and binary forms, with or without modification, |
| AnnaBridge | 143:86740a56073b | 6 | * are permitted provided that the following conditions are met: |
| AnnaBridge | 143:86740a56073b | 7 | * |
| AnnaBridge | 143:86740a56073b | 8 | * 1. Redistributions of source code must retain the above copyright notice, this list |
| AnnaBridge | 143:86740a56073b | 9 | * of conditions and the following disclaimer. |
| AnnaBridge | 143:86740a56073b | 10 | * |
| AnnaBridge | 143:86740a56073b | 11 | * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA |
| AnnaBridge | 143:86740a56073b | 12 | * integrated circuit in a product or a software update for such product, must reproduce |
| AnnaBridge | 143:86740a56073b | 13 | * the above copyright notice, this list of conditions and the following disclaimer in |
| AnnaBridge | 143:86740a56073b | 14 | * the documentation and/or other materials provided with the distribution. |
| AnnaBridge | 143:86740a56073b | 15 | * |
| AnnaBridge | 143:86740a56073b | 16 | * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be |
| AnnaBridge | 143:86740a56073b | 17 | * used to endorse or promote products derived from this software without specific prior |
| AnnaBridge | 143:86740a56073b | 18 | * written permission. |
| AnnaBridge | 143:86740a56073b | 19 | * |
| AnnaBridge | 143:86740a56073b | 20 | * 4. This software, with or without modification, must only be used with a |
| AnnaBridge | 143:86740a56073b | 21 | * Nordic Semiconductor ASA integrated circuit. |
| AnnaBridge | 143:86740a56073b | 22 | * |
| AnnaBridge | 143:86740a56073b | 23 | * 5. Any software provided in binary or object form under this license must not be reverse |
| AnnaBridge | 143:86740a56073b | 24 | * engineered, decompiled, modified and/or disassembled. |
| AnnaBridge | 143:86740a56073b | 25 | * |
| AnnaBridge | 143:86740a56073b | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| AnnaBridge | 143:86740a56073b | 27 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| AnnaBridge | 143:86740a56073b | 28 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| AnnaBridge | 143:86740a56073b | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
| AnnaBridge | 143:86740a56073b | 30 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| AnnaBridge | 143:86740a56073b | 31 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| AnnaBridge | 143:86740a56073b | 32 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
| AnnaBridge | 143:86740a56073b | 33 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| AnnaBridge | 143:86740a56073b | 34 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| AnnaBridge | 143:86740a56073b | 35 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| AnnaBridge | 143:86740a56073b | 36 | * |
| AnnaBridge | 143:86740a56073b | 37 | */ |
| AnnaBridge | 143:86740a56073b | 38 | |
| AnnaBridge | 143:86740a56073b | 39 | |
| AnnaBridge | 143:86740a56073b | 40 | /**@file |
| AnnaBridge | 143:86740a56073b | 41 | * |
| AnnaBridge | 143:86740a56073b | 42 | * @defgroup ant_stack_handler_types Types definitions for ANT support in SoftDevice handler. |
| AnnaBridge | 143:86740a56073b | 43 | * @{ |
| AnnaBridge | 143:86740a56073b | 44 | * @ingroup softdevice_handler |
| AnnaBridge | 143:86740a56073b | 45 | * @brief This file contains the declarations of types required for ANT stack support. These |
| AnnaBridge | 143:86740a56073b | 46 | * types will be defined when the preprocessor define ANT_STACK_SUPPORT_REQD is defined. |
| AnnaBridge | 143:86740a56073b | 47 | */ |
| AnnaBridge | 143:86740a56073b | 48 | |
| AnnaBridge | 143:86740a56073b | 49 | #ifndef ANT_STACK_HANDLER_TYPES_H__ |
| AnnaBridge | 143:86740a56073b | 50 | #define ANT_STACK_HANDLER_TYPES_H__ |
| AnnaBridge | 143:86740a56073b | 51 | |
| AnnaBridge | 143:86740a56073b | 52 | #ifdef ANT_STACK_SUPPORT_REQD |
| AnnaBridge | 143:86740a56073b | 53 | |
| AnnaBridge | 143:86740a56073b | 54 | #include <stdlib.h> |
| AnnaBridge | 143:86740a56073b | 55 | |
| AnnaBridge | 143:86740a56073b | 56 | #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. */ |
| AnnaBridge | 143:86740a56073b | 57 | #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. */ |
| AnnaBridge | 143:86740a56073b | 58 | |
| AnnaBridge | 143:86740a56073b | 59 | /**@brief ANT stack event type. */ |
| AnnaBridge | 143:86740a56073b | 60 | typedef struct |
| AnnaBridge | 143:86740a56073b | 61 | { |
| AnnaBridge | 143:86740a56073b | 62 | union |
| AnnaBridge | 143:86740a56073b | 63 | { |
| AnnaBridge | 143:86740a56073b | 64 | uint32_t ulForceAlign; ///< force the evt_buffer to be 4-byte aligned, required for some casting to ANT_MESSAGE. |
| AnnaBridge | 143:86740a56073b | 65 | uint8_t evt_buffer[ANT_STACK_EVT_MSG_BUF_SIZE]; ///< Event message buffer. |
| AnnaBridge | 143:86740a56073b | 66 | } msg; |
| AnnaBridge | 143:86740a56073b | 67 | uint8_t channel; ///< Channel number. |
| AnnaBridge | 143:86740a56073b | 68 | uint8_t event; ///< Event code. |
| AnnaBridge | 143:86740a56073b | 69 | } ant_evt_t; |
| AnnaBridge | 143:86740a56073b | 70 | |
| AnnaBridge | 143:86740a56073b | 71 | /**@brief Application ANT stack event handler type. */ |
| AnnaBridge | 143:86740a56073b | 72 | typedef void (*ant_evt_handler_t) (ant_evt_t * p_ant_evt); |
| AnnaBridge | 143:86740a56073b | 73 | |
| AnnaBridge | 143:86740a56073b | 74 | /**@brief Function for registering for ANT events. |
| AnnaBridge | 143:86740a56073b | 75 | * |
| AnnaBridge | 143:86740a56073b | 76 | * @details The application should use this function to register for receiving ANT events from |
| AnnaBridge | 143:86740a56073b | 77 | * the SoftDevice. If the application does not call this function, then any ANT event |
| AnnaBridge | 143:86740a56073b | 78 | * that may be generated by the SoftDevice will NOT be fetched. Once the application has |
| AnnaBridge | 143:86740a56073b | 79 | * registered for the events, it is not possible to possible to cancel the registration. |
| AnnaBridge | 143:86740a56073b | 80 | * However, it is possible to register a different function for handling the events at |
| AnnaBridge | 143:86740a56073b | 81 | * any point of time. |
| AnnaBridge | 143:86740a56073b | 82 | * |
| AnnaBridge | 143:86740a56073b | 83 | * @param[in] ant_evt_handler Function to be called for each received ANT event. |
| AnnaBridge | 143:86740a56073b | 84 | * |
| AnnaBridge | 143:86740a56073b | 85 | * @retval NRF_SUCCESS Successful registration. |
| AnnaBridge | 143:86740a56073b | 86 | * @retval NRF_ERROR_NULL Null pointer provided as input. |
| AnnaBridge | 143:86740a56073b | 87 | */ |
| AnnaBridge | 143:86740a56073b | 88 | uint32_t softdevice_ant_evt_handler_set(ant_evt_handler_t ant_evt_handler); |
| AnnaBridge | 143:86740a56073b | 89 | |
| AnnaBridge | 143:86740a56073b | 90 | #else |
| AnnaBridge | 143:86740a56073b | 91 | |
| AnnaBridge | 143:86740a56073b | 92 | // The ANT Stack support is not required. |
| AnnaBridge | 143:86740a56073b | 93 | |
| AnnaBridge | 143:86740a56073b | 94 | #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.*/ |
| AnnaBridge | 143:86740a56073b | 95 | |
| AnnaBridge | 143:86740a56073b | 96 | #endif // ANT_STACK_SUPPORT_REQD |
| AnnaBridge | 143:86740a56073b | 97 | |
| AnnaBridge | 143:86740a56073b | 98 | #endif // ANT_STACK_HANDLER_TYPES_H__ |
| AnnaBridge | 143:86740a56073b | 99 | |
| AnnaBridge | 143:86740a56073b | 100 | /** @} */ |
