123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248 |
- /**
- * Copyright (c) 2013 - 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 ble_sdk_srv_sc_ctrlpt Speed and Cadence Control Point
- * @{
- * @ingroup ble_sdk_srv
- * @brief Speed and Cadence Control Point module.
- *
- * @details This module implements the Speed and Cadence control point behavior. It is used
- * by the @ref ble_cscs module and the ble_sdk_srv_rsc module for control point
- * mechanisms like setting a cumulative value, Start an automatic calibration,
- * Update the sensor location or request the supported locations.
- *
- * @note Attention!
- * To maintain compliance with Nordic Semiconductor ASA Bluetooth profile
- * qualification listings, this section of source code must not be modified.
- */
- #ifndef BLE_SC_CTRLPT_H__
- #define BLE_SC_CTRLPT_H__
- #include <stdint.h>
- #include <stdbool.h>
- #include "ble.h"
- #include "ble_srv_common.h"
- #include "ble_sensor_location.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- #define BLE_SC_CTRLPT_MAX_LEN 19 /**< maximum lenght for Speed and cadence control point characteristic value. */
- #define BLE_SC_CTRLPT_MIN_LEN 1 /**< minimum length for Speed and cadence control point characteristic value. */
- // Forward declaration of the ble_sc_ctrlpt_t type.
- typedef struct ble_sc_ctrlpt_s ble_sc_ctrlpt_t;
- /**@brief Speed and Cadence Control Point event type. */
- typedef enum
- {
- BLE_SC_CTRLPT_EVT_UPDATE_LOCATION, /**< rcvd update location opcode (the control point handles the change of location automatically, the event just informs the application in case it needs to adjust its algorithm). */
- BLE_SC_CTRLPT_EVT_SET_CUMUL_VALUE, /**< rcvd set cumulative value opcode, it is then up to the application to use the new cumulative value. */
- BLE_SC_CTRLPT_EVT_START_CALIBRATION, /**< rcvd start calibration opcode, the application needs, at the end ot the calibration to call ble_sc_ctrlpt_send_rsp. */
- } ble_sc_ctrlpt_evt_type_t;
- /**@brief Speed and Cadence Control point event. */
- typedef struct
- {
- ble_sc_ctrlpt_evt_type_t evt_type; /**< Type of event. */
- union
- {
- ble_sensor_location_t update_location;
- uint32_t cumulative_value;
- }params;
- } ble_sc_ctrlpt_evt_t;
- /** Speed and Cadence Control Point operator code (see RSC service specification)*/
- typedef enum {
- BLE_SCPT_SET_CUMULATIVE_VALUE = 0x01, /**< Operator to set a given cumulative value. */
- BLE_SCPT_START_AUTOMATIC_CALIBRATION = 0x02, /**< Operator to start automatic calibration. */
- BLE_SCPT_UPDATE_SENSOR_LOCATION = 0x03, /**< Operator to update the sensor location. */
- BLE_SCPT_REQUEST_SUPPORTED_SENSOR_LOCATIONS = 0x04, /**< Operator to request the supported sensor locations. */
- BLE_SCPT_RESPONSE_CODE = 0x10, /**< Response Code. */
- } ble_scpt_operator_t;
- /** Speed and Cadence Control Point response parameter (see RSC service specification)*/
- typedef enum {
- BLE_SCPT_SUCCESS = 0x01, /**< Sucess Response. */
- BLE_SCPT_OP_CODE_NOT_SUPPORTED = 0x02, /**< Error Response received opcode not supported. */
- BLE_SCPT_INVALID_PARAMETER = 0x03, /**< Error Response received parameter invalid. */
- BLE_SCPT_OPERATION_FAILED = 0x04, /**< Error Response operation failed. */
- } ble_scpt_response_t;
- /** Speed and Cadence Control Point procedure status (indicates is a procedure is in progress or not and which procedure is in progress*/
- typedef enum {
- BLE_SCPT_NO_PROC_IN_PROGRESS = 0x00, /**< No procedure in progress. */
- BLE_SCPT_AUTOMATIC_CALIB_IN_PROGRESS = 0x01, /**< Automatic Calibration is in progress. */
- BLE_SCPT_INDICATION_PENDING = 0x02, /**< Control Point Indication is pending. */
- BLE_SCPT_IND_CONFIRM_PENDING = 0x03, /**< Waiting for the indication confirmation. */
- }ble_scpt_procedure_status_t;
- /**@brief Speed and Cadence Control point event handler type. */
- typedef ble_scpt_response_t (*ble_sc_ctrlpt_evt_handler_t) (ble_sc_ctrlpt_t * p_sc_ctrlpt,
- ble_sc_ctrlpt_evt_t * p_evt);
- typedef struct{
- ble_scpt_operator_t opcode;
- uint32_t cumulative_value;
- ble_sensor_location_t location;
- }ble_sc_ctrlpt_val_t;
- typedef struct{
- ble_scpt_operator_t opcode;
- ble_scpt_response_t status;
- ble_sensor_location_t location_list[BLE_NB_MAX_SENSOR_LOCATIONS];
- }ble_sc_ctrlpt_rsp_t;
- /**
- * \defgroup BLE_SRV_SC_CTRLPT_SUPP_FUNC Control point functionalities.
- *@{
- */
- #define BLE_SRV_SC_CTRLPT_SENSOR_LOCATIONS_OP_SUPPORTED 0x01 /**< Support for sensor location related operations */
- #define BLE_SRV_SC_CTRLPT_CUM_VAL_OP_SUPPORTED 0x02 /**< Support for setting cumulative value related operations */
- #define BLE_SRV_SC_CTRLPT_START_CALIB_OP_SUPPORTED 0x04 /**< Support for starting calibration related operations */
- /**
- *@}
- */
- /**@brief Speed and Cadence Control Point init structure. This contains all options and data
- * needed for initialization of the Speed and Cadence Control Point module. */
- typedef struct
- {
- security_req_t sc_ctrlpt_cccd_wr_sec; /**< Security requirement for writing speed and cadence control point characteristic CCCD. */
- security_req_t sc_ctrlpt_wr_sec; /**< Security requirement for writing speed and cadence control point characteristic. */
- uint8_t supported_functions; /**< supported control point functionalities see @ref BLE_SRV_SC_CTRLPT_SUPP_FUNC. */
- uint16_t service_handle; /**< Handle of the parent service (as provided by the BLE stack). */
- ble_sc_ctrlpt_evt_handler_t evt_handler; /**< event handler */
- ble_sensor_location_t *list_supported_locations; /**< list of supported sensor locations.*/
- uint8_t size_list_supported_locations; /**< number of supported sensor locations in the list.*/
- uint16_t sensor_location_handle; /**< handle for the sensor location characteristic (if sensor_location related operation are supported).*/
- ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
- } ble_cs_ctrlpt_init_t;
- /**@brief Speed and Cadence Control Point response indication structure. */
- typedef struct
- {
- ble_scpt_response_t status; /**< control point response status .*/
- uint8_t len; /**< control point response length .*/
- uint8_t encoded_ctrl_rsp[BLE_SC_CTRLPT_MAX_LEN]; /**< control point encoded response.*/
- }ble_sc_ctrlpt_resp_t;
- /**@brief Speed and Cadence Control Point structure. This contains various status information for
- * the Speed and Cadence Control Point behavior. */
- struct ble_sc_ctrlpt_s
- {
- uint8_t supported_functions; /**< supported control point functionalities see @ref BLE_SRV_SC_CTRLPT_SUPP_FUNC. */
- uint16_t service_handle; /**< Handle of the parent service (as provided by the BLE stack). */
- ble_gatts_char_handles_t sc_ctrlpt_handles; /**< Handles related to the Speed and Cadence Control Point characteristic. */
- uint16_t conn_handle; /**< Handle of the current connection (as provided by the BLE stack, is BLE_CONN_HANDLE_INVALID if not in a connection). */
- ble_sensor_location_t list_supported_locations[BLE_NB_MAX_SENSOR_LOCATIONS]; /**< list of supported sensor locations.*/
- uint8_t size_list_supported_locations; /**< number of supported sensor locations in the list.*/
- ble_sc_ctrlpt_evt_handler_t evt_handler; /**< Handle of the parent service (as provided by the BLE stack). */
- uint16_t sensor_location_handle; /**< handle for the sensor location characteristic (if sensor_location related operation are supported).*/
- ble_scpt_procedure_status_t procedure_status; /**< status of possible procedure*/
- ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
- ble_sc_ctrlpt_resp_t response; /**< pending response data.*/
- };
- #define SCPT_OPCODE_POS 0 /**< Request opcode position. */
- #define SCPT_PARAMETER_POS 1 /**< Request parameter position. */
- #define SCPT_RESPONSE_REQUEST_OPCODE_POS 1 /**< Response position of requested opcode. */
- #define SCPT_RESPONSE_CODE_POS 2 /**< Response position of response code. */
- #define SCPT_RESPONSE_PARAMETER 3 /**< Response position of response parameter. */
- #define SCPT_MIN_RESPONSE_SIZE 3 /**< Minimum size for control point response. */
- #define SCPT_MAX_RESPONSE_SIZE (SCPT_MIN_RESPONSE_SIZE + NB_MAX_SENSOR_LOCATIONS) /**< Maximum size for control point response. */
- /**@brief Function for Initializing the Speed and Cadence Control Point.
- *
- * @details Function for Initializing the Speed and Cadence Control Point.
- * @param[in] p_sc_ctrlpt Speed and Cadence Control Point structure.
- * @param[in] p_sc_ctrlpt_init Information needed to initialize the control point behavior.
- *
- * @return NRF_SUCCESS on successful initialization of service, otherwise an error code.
- */
- uint32_t ble_sc_ctrlpt_init(ble_sc_ctrlpt_t * p_sc_ctrlpt,
- ble_cs_ctrlpt_init_t const * p_sc_ctrlpt_init);
- /**@brief Function for sending a control point response.
- *
- * @details Function for sending a control point response when the control point received was
- * BLE_SCPT_START_AUTOMATIC_CALIBRATION. To be called after the calibration procedure is finished.
- *
- * @param[in] p_sc_ctrlpt Speed and Cadence Control Point structure.
- * @param[in] response_status status to include in the control point response.
- */
- uint32_t ble_sc_ctrlpt_rsp_send(ble_sc_ctrlpt_t * p_sc_ctrlpt, ble_scpt_response_t response_status);
- /**@brief Speed and Cadence Control Point BLE stack event handler.
- *
- * @details Handles all events from the BLE stack of interest to the Speed and Cadence Control Point.
- *
- * @param[in] p_sc_ctrlpt Speed and Cadence Control Point structure.
- * @param[in] p_ble_evt Event received from the BLE stack.
- */
- void ble_sc_ctrlpt_on_ble_evt(ble_sc_ctrlpt_t * p_sc_ctrlpt, ble_evt_t const * p_ble_evt);
- #ifdef __cplusplus
- }
- #endif
- #endif // BLE_SC_CTRLPT_H__
- /** @} */
|