123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377 |
- /**
- * Copyright (c) 2015 - 2020, Nordic Semiconductor ASA
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form, except as embedded into a Nordic
- * Semiconductor ASA integrated circuit in a product or a software update for
- * such product, must reproduce the above copyright notice, this list of
- * conditions and the following disclaimer in the documentation and/or other
- * materials provided with the distribution.
- *
- * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
- * contributors may be used to endorse or promote products derived from this
- * software without specific prior written permission.
- *
- * 4. This software, with or without modification, must only be used with a
- * Nordic Semiconductor ASA integrated circuit.
- *
- * 5. Any software provided in binary form under this license must not be reverse
- * engineered, decompiled, modified and/or disassembled.
- *
- * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
- * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
- * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
- /**
- * @file
- * @defgroup ant_bpwr Bicycle Power profile
- * @{
- * @ingroup ant_sdk_profiles
- * @brief This module implements the Bicycle Power profile.
- *
- */
- #ifndef ANT_BICYCLE_POWER_H__
- #define ANT_BICYCLE_POWER_H__
- #include <stdint.h>
- #include <stdbool.h>
- #include "ant_parameters.h"
- #include "nrf_sdh_ant.h"
- #include "ant_channel_config.h"
- #include "ant_bpwr_pages.h"
- #include "sdk_errors.h"
- #define BPWR_DEVICE_TYPE 0x0Bu ///< Device type reserved for ANT+ Bicycle Power.
- #define BPWR_ANTPLUS_RF_FREQ 0x39u ///< Frequency, decimal 57 (2457 MHz).
- #define BPWR_MSG_PERIOD 8182u ///< Message period, decimal 8182 (4.0049 Hz).
- #define BPWR_EXT_ASSIGN 0x00 ///< ANT ext assign (see Ext. Assign Channel Parameters in ant_parameters.h: @ref ant_parameters).
- #define BPWR_DISP_CHANNEL_TYPE CHANNEL_TYPE_SLAVE ///< Display Bicycle Power channel type.
- #define BPWR_SENS_CHANNEL_TYPE CHANNEL_TYPE_MASTER ///< Sensor Bicycle Power channel type.
- #define BPWR_CALIBRATION_TIMOUT_S 5u ///< Time-out for responding to calibration callback (s).
- /**@brief Initialize an ANT channel configuration structure for the Bicycle Power profile (Display).
- *
- * @param[in] NAME Name of related instance.
- * @param[in] CHANNEL_NUMBER Number of the channel assigned to the profile instance.
- * @param[in] TRANSMISSION_TYPE Type of transmission assigned to the profile instance.
- * @param[in] DEVICE_NUMBER Number of the device assigned to the profile instance.
- * @param[in] NETWORK_NUMBER Number of the network assigned to the profile instance.
- */
- #define BPWR_DISP_CHANNEL_CONFIG_DEF(NAME, \
- CHANNEL_NUMBER, \
- TRANSMISSION_TYPE, \
- DEVICE_NUMBER, \
- NETWORK_NUMBER) \
- static const ant_channel_config_t CONCAT_2(NAME, _channel_bpwr_disp_config) = \
- { \
- .channel_number = (CHANNEL_NUMBER), \
- .channel_type = BPWR_DISP_CHANNEL_TYPE, \
- .ext_assign = BPWR_EXT_ASSIGN, \
- .rf_freq = BPWR_ANTPLUS_RF_FREQ, \
- .transmission_type = (TRANSMISSION_TYPE), \
- .device_type = BPWR_DEVICE_TYPE, \
- .device_number = (DEVICE_NUMBER), \
- .channel_period = BPWR_MSG_PERIOD, \
- .network_number = (NETWORK_NUMBER), \
- }
- #define BPWR_DISP_CHANNEL_CONFIG(NAME) &CONCAT_2(NAME, _channel_bpwr_disp_config)
- /**@brief Initialize an ANT channel configuration structure for the Bicycle Power profile (Sensor).
- *
- * @param[in] NAME Name of related instance.
- * @param[in] CHANNEL_NUMBER Number of the channel assigned to the profile instance.
- * @param[in] TRANSMISSION_TYPE Type of transmission assigned to the profile instance.
- * @param[in] DEVICE_NUMBER Number of the device assigned to the profile instance.
- * @param[in] NETWORK_NUMBER Number of the network assigned to the profile instance.
- */
- #define BPWR_SENS_CHANNEL_CONFIG_DEF(NAME, \
- CHANNEL_NUMBER, \
- TRANSMISSION_TYPE, \
- DEVICE_NUMBER, \
- NETWORK_NUMBER) \
- static const ant_channel_config_t CONCAT_2(NAME, _channel_bpwr_sens_config) = \
- { \
- .channel_number = (CHANNEL_NUMBER), \
- .channel_type = BPWR_SENS_CHANNEL_TYPE, \
- .ext_assign = BPWR_EXT_ASSIGN, \
- .rf_freq = BPWR_ANTPLUS_RF_FREQ, \
- .transmission_type = (TRANSMISSION_TYPE), \
- .device_type = BPWR_DEVICE_TYPE, \
- .device_number = (DEVICE_NUMBER), \
- .channel_period = BPWR_MSG_PERIOD, \
- .network_number = (NETWORK_NUMBER), \
- }
- #define BPWR_SENS_CHANNEL_CONFIG(NAME) &CONCAT_2(NAME, _channel_bpwr_sens_config)
- /**@brief Initialize an ANT profile configuration structure for the BPWR profile (Display).
- *
- * @param[in] NAME Name of related instance.
- * @param[in] EVT_HANDLER Event handler to be called for handling events in the BPWR profile.
- */
- #define BPWR_DISP_PROFILE_CONFIG_DEF(NAME, \
- EVT_HANDLER) \
- static ant_bpwr_disp_cb_t CONCAT_2(NAME, _bpwr_disp_cb); \
- static const ant_bpwr_disp_config_t CONCAT_2(NAME, _profile_bpwr_disp_config) = \
- { \
- .p_cb = &CONCAT_2(NAME, _bpwr_disp_cb), \
- .evt_handler = (EVT_HANDLER), \
- }
- #define BPWR_DISP_PROFILE_CONFIG(NAME) &CONCAT_2(NAME, _profile_bpwr_disp_config)
- /**@brief Initialize an ANT profile configuration structure for the BPWR profile (Sensor).
- *
- * @param[in] NAME Name of related instance.
- * @param[in] TORQUE_USED Determines whether the torque page is included.
- * @param[in] CALIB_HANDLER Event handler to be called for handling calibration requests.
- * @param[in] EVT_HANDLER Event handler to be called for handling events in the BPWR profile.
- */
- #define BPWR_SENS_PROFILE_CONFIG_DEF(NAME, \
- TORQUE_USED, \
- CALIB_HANDLER, \
- EVT_HANDLER) \
- static ant_bpwr_sens_cb_t CONCAT_2(NAME, _bpwr_sens_cb); \
- static const ant_bpwr_sens_config_t CONCAT_2(NAME, _profile_bpwr_sens_config) = \
- { \
- .torque_use = (TORQUE_USED), \
- .calib_handler = (CALIB_HANDLER), \
- .p_cb = &CONCAT_2(NAME, _bpwr_sens_cb), \
- .evt_handler = (EVT_HANDLER), \
- }
- #define BPWR_SENS_PROFILE_CONFIG(NAME) &NAME##_profile_bpwr_sens_config
- /**@brief Configuration values for the Bicycle Power torque page. */
- typedef enum
- {
- TORQUE_NONE = 0,
- TORQUE_WHEEL = 1,
- TORQUE_CRANK = 2,
- } ant_bpwr_torque_t;
- /**@brief Bicycle Power page number type. */
- typedef enum
- {
- ANT_BPWR_PAGE_1 = 1, ///< Calibration data page.
- ANT_BPWR_PAGE_16 = 16, ///< Standard power-only main data page.
- ANT_BPWR_PAGE_17 = 17, ///< Standard wheel torque main data page.
- ANT_BPWR_PAGE_18 = 18, ///< Standard crank torque main data page.
- ANT_BPWR_PAGE_80 = ANT_COMMON_PAGE_80,
- ANT_BPWR_PAGE_81 = ANT_COMMON_PAGE_81
- } ant_bpwr_page_t;
- /**@brief BPWR profile event type. */
- typedef enum
- {
- ANT_BPWR_PAGE_1_UPDATED = ANT_BPWR_PAGE_1, ///< Data page 1 and speed have been updated (Display) or sent (Sensor).
- ANT_BPWR_PAGE_16_UPDATED = ANT_BPWR_PAGE_16, ///< Data page 16 and speed have been updated (Display) or sent (Sensor).
- ANT_BPWR_PAGE_17_UPDATED = ANT_BPWR_PAGE_17, ///< Data page 17 and speed have been updated (Display) or sent (Sensor).
- ANT_BPWR_PAGE_18_UPDATED = ANT_BPWR_PAGE_18, ///< Data page 18 has been updated (Display) or sent (Sensor).
- ANT_BPWR_PAGE_80_UPDATED = ANT_BPWR_PAGE_80, ///< Data page 80 has been updated (Display) or sent (Sensor).
- ANT_BPWR_PAGE_81_UPDATED = ANT_BPWR_PAGE_81, ///< Data page 81 has been updated (Display) or sent (Sensor).
- ANT_BPWR_CALIB_TIMEOUT, ///< Request of calibration time-out occurred (Display).
- ANT_BPWR_CALIB_REQUEST_TX_FAILED, ///< Calibration request did not reach the destination (Display).
- } ant_bpwr_evt_t;
- // Forward declaration of the ant_bpwr_profile_t type.
- typedef struct ant_bpwr_profile_s ant_bpwr_profile_t;
- /**@brief BPWR event handler type. */
- typedef void (* ant_bpwr_evt_handler_t) (ant_bpwr_profile_t *, ant_bpwr_evt_t);
- /**@brief BPWR Sensor calibration request handler type. */
- typedef void (* ant_bpwr_calib_handler_t) (ant_bpwr_profile_t *, ant_bpwr_page1_data_t *);
- #include "ant_bpwr_local.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**@brief Bicycle Power Sensor configuration structure. */
- typedef struct
- {
- ant_bpwr_torque_t torque_use; ///< Determines whether the torque page is included.
- ant_bpwr_sens_cb_t * p_cb; ///< Pointer to the data buffer for internal use.
- ant_bpwr_evt_handler_t evt_handler; ///< Event handler to be called for handling events in the BPWR profile.
- ant_bpwr_calib_handler_t calib_handler; ///< Event handler to be called for handling calibration requests.
- } ant_bpwr_sens_config_t;
- /**@brief Bicycle Power Display configuration structure. */
- typedef struct
- {
- ant_bpwr_disp_cb_t * p_cb; ///< Pointer to the data buffer for internal use.
- ant_bpwr_evt_handler_t evt_handler; ///< Event handler to be called for handling events in the BPWR profile.
- } ant_bpwr_disp_config_t;
- /**@brief Bicycle Power profile structure. */
- struct ant_bpwr_profile_s
- {
- uint8_t channel_number; ///< Channel number assigned to the profile.
- union {
- ant_bpwr_disp_cb_t * p_disp_cb;
- ant_bpwr_sens_cb_t * p_sens_cb;
- } _cb; ///< Pointer to internal control block.
- ant_bpwr_evt_handler_t evt_handler; ///< Event handler to be called for handling events in the BPWR profile.
- ant_bpwr_page1_data_t page_1; ///< Page 1.
- ant_bpwr_page16_data_t page_16; ///< Page 16.
- ant_bpwr_page17_data_t page_17; ///< Page 17.
- ant_bpwr_page18_data_t page_18; ///< Page 18.
- ant_common_page80_data_t page_80; ///< Page 80.
- ant_common_page81_data_t page_81; ///< Page 81.
- ant_bpwr_common_data_t common; ///< BPWR common data.
- };
- /** @name Defines for accessing ant_bpwr_profile_t member variables
- @{ */
- #define BPWR_PROFILE_calibration_id page_1.calibration_id
- #define BPWR_PROFILE_auto_zero_status page_1.auto_zero_status
- #define BPWR_PROFILE_general_calib_data page_1.data.general_calib
- #define BPWR_PROFILE_custom_calib_data page_1.data.custom_calib
- #define BPWR_PROFILE_instantaneous_cadence common.instantaneous_cadence
- #define BPWR_PROFILE_pedal_power page_16.pedal_power.items
- #define BPWR_PROFILE_power_update_event_count page_16.update_event_count
- #define BPWR_PROFILE_accumulated_power page_16.accumulated_power
- #define BPWR_PROFILE_instantaneous_power page_16.instantaneous_power
- #define BPWR_PROFILE_wheel_update_event_count page_17.update_event_count
- #define BPWR_PROFILE_wheel_tick page_17.tick
- #define BPWR_PROFILE_wheel_period page_17.period
- #define BPWR_PROFILE_wheel_accumulated_torque page_17.accumulated_torque
- #define BPWR_PROFILE_crank_update_event_count page_18.update_event_count
- #define BPWR_PROFILE_crank_tick page_18.tick
- #define BPWR_PROFILE_crank_period page_18.period
- #define BPWR_PROFILE_crank_accumulated_torque page_18.accumulated_torque
- #define BPWR_PROFILE_manuf_id page_80.manuf_id
- #define BPWR_PROFILE_hw_revision page_80.hw_revision
- #define BPWR_PROFILE_manufacturer_id page_80.manufacturer_id
- #define BPWR_PROFILE_model_number page_80.model_number
- #define BPWR_PROFILE_sw_revision_minor page_81.sw_revision_minor
- #define BPWR_PROFILE_sw_revision_major page_81.sw_revision_major
- #define BPWR_PROFILE_serial_number page_81.serial_number
- /** @} */
- /**@brief Function for initializing the ANT Bicycle Power Display profile instance.
- *
- * @param[in] p_profile Pointer to the profile instance.
- * @param[in] p_channel_config Pointer to the ANT channel configuration structure.
- * @param[in] p_disp_config Pointer to the Bicycle Power Display configuration structure.
- *
- * @retval NRF_SUCCESS If initialization was successful. Otherwise, an error code is returned.
- */
- ret_code_t ant_bpwr_disp_init(ant_bpwr_profile_t * p_profile,
- ant_channel_config_t const * p_channel_config,
- ant_bpwr_disp_config_t const * p_disp_config);
- /**@brief Function for initializing the ANT Bicycle Power Sensor profile instance.
- *
- * @param[in] p_profile Pointer to the profile instance.
- * @param[in] p_channel_config Pointer to the ANT channel configuration structure.
- * @param[in] p_sens_config Pointer to the Bicycle Power Sensor configuration structure.
- *
- * @retval NRF_SUCCESS If initialization was successful. Otherwise, an error code is returned.
- */
- ret_code_t ant_bpwr_sens_init(ant_bpwr_profile_t * p_profile,
- ant_channel_config_t const * p_channel_config,
- ant_bpwr_sens_config_t const * p_sens_config);
- /**@brief Function for opening the profile instance channel for ANT BPWR Display.
- *
- * Before calling this function, pages should be configured.
- *
- * @param[in] p_profile Pointer to the profile instance.
- *
- * @retval NRF_SUCCESS If the channel was successfully opened. Otherwise, an error code is returned.
- */
- ret_code_t ant_bpwr_disp_open(ant_bpwr_profile_t * p_profile);
- /**@brief Function for opening the profile instance channel for ANT BPWR Sensor.
- *
- * Before calling this function, pages should be configured.
- *
- * @param[in] p_profile Pointer to the profile instance.
- *
- * @retval NRF_SUCCESS If the channel was successfully opened. Otherwise, an error code is returned.
- */
- ret_code_t ant_bpwr_sens_open(ant_bpwr_profile_t * p_profile);
- /** @name Functions: Sensor calibration API
- * @{
- */
- /** @brief Function for initializing the response for a calibration request.
- *
- * This function should be used to signal the status of the calibration procedure to the ANT profile layer .
- *
- * @param[in] p_profile Pointer to the profile instance.
- */
- void ant_bpwr_calib_response(ant_bpwr_profile_t * p_profile);
- /** @} */
- /**@brief Function for handling the Sensor ANT events.
- *
- * @details This function handles all events from the ANT stack that are of interest to the Bicycle Power Display profile.
- *
- * @param[in] p_ant_evt Event received from the ANT stack.
- * @param[in] p_context Pointer to the profile instance.
- */
- void ant_bpwr_sens_evt_handler(ant_evt_t * p_ant_evt, void * p_context);
- /**@brief Function for handling the Display ANT events.
- *
- * @details This function handles all events from the ANT stack that are of interest to the Bicycle Power Display profile.
- *
- * @param[in] p_ant_evt Event received from the ANT stack.
- * @param[in] p_context Pointer to the profile instance.
- */
- void ant_bpwr_disp_evt_handler(ant_evt_t * p_ant_evt, void * p_context);
- /** @name Functions: Display calibration API
- * @{
- */
- /**@brief Function for initializing the calibration request process from the Bicycle Power Display side.
- *
- * @details This function requests a transfer to the Sensor and starts watching for the calibration response.
- * If a calibration response has already been requested, the function ignores the new request and returns NRF_SUCCESS.
- *
- * @param [in] p_profile Pointer to the profile instance.
- * @param [in] p_page_1 Pointer to the prepared page 1.
- *
- * @return Values returned by the @ref sd_ant_acknowledge_message_tx SVC callback.
- */
- uint32_t ant_bpwr_calib_request(ant_bpwr_profile_t * p_profile, ant_bpwr_page1_data_t * p_page_1);
- /**
- * @}
- */
- /**
- * @}
- */
- #ifdef __cplusplus
- }
- #endif
- #endif // ANT_BICYCLE_POWER_H__
|