pinebuds/services/ble_profiles/cscp/cscps/src/cscps.c

358 lines
13 KiB
C
Raw Normal View History

2022-08-15 04:20:27 -05:00
/**
****************************************************************************************
* @addtogroup CSCPS
* @{
****************************************************************************************
*/
/*
* INCLUDE FILES
****************************************************************************************
*/
#include "rwip_config.h"
#if (BLE_CSC_SENSOR)
#include "cscp_common.h"
#include "gap.h"
#include "gattc_task.h"
#include "cscps.h"
#include "cscps_task.h"
#include "prf_utils.h"
#include "ke_mem.h"
/*
* GLOBAL VARIABLE DEFINITIONS
****************************************************************************************
*/
/// Full CSCPS Database Description - Used to add attributes into the database
static const struct attm_desc cscps_att_db[CSCS_IDX_NB] =
{
// Cycling Speed and Cadence Service Declaration
[CSCS_IDX_SVC] = {ATT_DECL_PRIMARY_SERVICE, PERM(RD, ENABLE), 0, 0},
// CSC Measurement Characteristic Declaration
[CSCS_IDX_CSC_MEAS_CHAR] = {ATT_DECL_CHARACTERISTIC, PERM(RD, ENABLE), 0, 0},
// CSC Measurement Characteristic Value
[CSCS_IDX_CSC_MEAS_VAL] = {ATT_CHAR_CSC_MEAS, PERM(NTF, ENABLE), PERM(RI, ENABLE), CSCP_CSC_MEAS_MAX_LEN},
// CSC Measurement Characteristic - Client Characteristic Configuration Descriptor
[CSCS_IDX_CSC_MEAS_NTF_CFG] = {ATT_DESC_CLIENT_CHAR_CFG, PERM(RD, ENABLE) | PERM(WRITE_REQ, ENABLE), 0, 0},
// CSC Feature Characteristic Declaration
[CSCS_IDX_CSC_FEAT_CHAR] = {ATT_DECL_CHARACTERISTIC, PERM(RD, ENABLE), 0, 0},
// CSC Feature Characteristic Value
[CSCS_IDX_CSC_FEAT_VAL] = {ATT_CHAR_CSC_FEAT, PERM(RD, ENABLE), PERM(RI, ENABLE), sizeof(uint16_t)},
// Sensor Location Characteristic Declaration
[CSCS_IDX_SENSOR_LOC_CHAR] = {ATT_DECL_CHARACTERISTIC, PERM(RD, ENABLE), 0, 0},
// Sensor Location Characteristic Value
[CSCS_IDX_SENSOR_LOC_VAL] = {ATT_CHAR_SENSOR_LOC, PERM(RD, ENABLE), PERM(RI, ENABLE), sizeof(uint8_t)},
// SC Control Point Characteristic Declaration
[CSCS_IDX_SC_CTNL_PT_CHAR] = {ATT_DECL_CHARACTERISTIC, PERM(RD, ENABLE), CSCS_IDX_SC_CTNL_PT_VAL, 0},
// SC Control Point Characteristic Value - The response has the maximal length
[CSCS_IDX_SC_CTNL_PT_VAL] = {ATT_CHAR_SC_CNTL_PT, PERM(IND, ENABLE) | PERM(WRITE_REQ, ENABLE),
PERM(RI, ENABLE), CSCP_SC_CNTL_PT_RSP_MAX_LEN},
// SC Control Point Characteristic - Client Characteristic Configuration Descriptor
[CSCS_IDX_SC_CTNL_PT_NTF_CFG] = {ATT_DESC_CLIENT_CHAR_CFG, PERM(RD, ENABLE) | PERM(WRITE_REQ, ENABLE), 0, 0},
};
/*
* EXPORTED FUNCTIONS DEFINITIONS
****************************************************************************************
*/
/**
****************************************************************************************
* @brief Initialization of the CSCPS module.
* This function performs all the initializations of the Profile module.
* - Creation of database (if it's a service)
* - Allocation of profile required memory
* - Initialization of task descriptor to register application
* - Task State array
* - Number of tasks
* - Default task handler
*
* @param[out] env Collector or Service allocated environment data.
* @param[in|out] start_hdl Service start handle (0 - dynamically allocated), only applies for services.
* @param[in] app_task Application task number.
* @param[in] sec_lvl Security level (AUTH, EKS and MI field of @see enum attm_value_perm_mask)
* @param[in] param Configuration parameters of profile collector or service (32 bits aligned)
*
* @return status code to know if profile initialization succeed or not.
****************************************************************************************
*/
static uint8_t cscps_init(struct prf_task_env* env, uint16_t* start_hdl, uint16_t app_task, uint8_t sec_lvl, struct cscps_db_cfg* param)
{
//------------------ create the attribute database for the profile -------------------
// Service content flag
uint32_t cfg_flag= CSCPS_MANDATORY_MASK;
// DB Creation Status
uint8_t status = ATT_ERR_NO_ERROR;
/*
* Check if the Sensor Location characteristic shall be added.
* Mandatory if the Multiple Sensor Location feature is supported, otherwise optional.
*/
if ((param->sensor_loc_supp == CSCPS_SENSOR_LOC_SUPP) ||
(CSCPS_IS_FEATURE_SUPPORTED(param->csc_feature, CSCP_FEAT_MULT_SENSOR_LOC_SUPP)))
{
cfg_flag |= CSCPS_SENSOR_LOC_MASK;
}
/*
* Check if the SC Control Point characteristic shall be added
* Mandatory if at least one SC Control Point procedure is supported, otherwise excluded.
*/
if (CSCPS_IS_FEATURE_SUPPORTED(param->csc_feature, CSCP_FEAT_WHEEL_REV_DATA_SUPP) ||
CSCPS_IS_FEATURE_SUPPORTED(param->csc_feature, CSCP_FEAT_MULT_SENSOR_LOC_SUPP))
{
cfg_flag |= CSCPS_SC_CTNL_PT_MASK;
}
// Add service in the database
status = attm_svc_create_db(start_hdl, ATT_SVC_CYCLING_SPEED_CADENCE, (uint8_t *)&cfg_flag,
CSCS_IDX_NB, NULL, env->task, &cscps_att_db[0],
(sec_lvl & (PERM_MASK_SVC_DIS | PERM_MASK_SVC_AUTH | PERM_MASK_SVC_EKS)) | PERM(SVC_MI, DISABLE));
// Check if an error has occured
if (status == ATT_ERR_NO_ERROR)
{
// Allocate CSCPS required environment variable
struct cscps_env_tag* cscps_env =
(struct cscps_env_tag* ) ke_malloc(sizeof(struct cscps_env_tag), KE_MEM_ATT_DB);
// Initialize CSCPS environment
env->env = (prf_env_t*) cscps_env;
cscps_env->shdl = *start_hdl;
cscps_env->prfl_cfg = cfg_flag;
cscps_env->features = param->csc_feature;
cscps_env->operation = CSCPS_RESERVED_OP_CODE;
if (CSCPS_IS_FEATURE_SUPPORTED(cscps_env->prfl_cfg, CSCPS_SENSOR_LOC_MASK))
{
cscps_env->sensor_loc = (param->sensor_loc >= CSCP_LOC_MAX) ?
CSCP_LOC_OTHER : param->sensor_loc;
}
cscps_env->prf_env.app_task = app_task
| (PERM_GET(sec_lvl, SVC_MI) ? PERM(PRF_MI, ENABLE) : PERM(PRF_MI, DISABLE));
// Mono Instantiated task
cscps_env->prf_env.prf_task = env->task | PERM(PRF_MI, DISABLE);
// initialize environment variable
env->id = TASK_ID_CSCPS;
cscps_task_init(&(env->desc));
// Store the provided cumulative wheel revolution value
cscps_env->tot_wheel_rev = param->wheel_rev;
cscps_env->ntf = NULL;
memset(cscps_env->prfl_ntf_ind_cfg, 0, BLE_CONNECTION_MAX);
// If we are here, database has been fulfilled with success, go to idle state
ke_state_set(env->task, CSCPS_IDLE);
}
return (status);
}
/**
****************************************************************************************
* @brief Destruction of the CSCPS module - due to a reset for instance.
* This function clean-up allocated memory (attribute database is destroyed by another
* procedure)
*
* @param[in|out] env Collector or Service allocated environment data.
****************************************************************************************
*/
static void cscps_destroy(struct prf_task_env* env)
{
struct cscps_env_tag* cscps_env = (struct cscps_env_tag*) env->env;
// cleanup environment variable for each task instances
if(cscps_env->ntf != NULL)
{
ke_free(cscps_env->ntf);
}
// free profile environment variables
env->env = NULL;
ke_free(cscps_env);
}
/**
****************************************************************************************
* @brief Handles Connection creation
*
* @param[in|out] env Collector or Service allocated environment data.
* @param[in] conidx Connection index
****************************************************************************************
*/
static void cscps_create(struct prf_task_env* env, uint8_t conidx)
{
struct cscps_env_tag* cscps_env = (struct cscps_env_tag*) env->env;
cscps_env->prfl_ntf_ind_cfg[conidx] = 0;
}
/**
****************************************************************************************
* @brief Handles Disconnection
*
* @param[in|out] env Collector or Service allocated environment data.
* @param[in] conidx Connection index
* @param[in] reason Detach reason
****************************************************************************************
*/
static void cscps_cleanup(struct prf_task_env* env, uint8_t conidx, uint8_t reason)
{
struct cscps_env_tag* cscps_env = (struct cscps_env_tag*) env->env;
// clean-up environment variable allocated for task instance
cscps_env->prfl_ntf_ind_cfg[conidx] = 0;
}
/*
* GLOBAL VARIABLE DEFINITIONS
****************************************************************************************
*/
/// CSCPS Task interface required by profile manager
const struct prf_task_cbs cscps_itf =
{
(prf_init_fnct) cscps_init,
cscps_destroy,
cscps_create,
cscps_cleanup,
};
/*
* EXPORTED FUNCTIONS DEFINITIONS
****************************************************************************************
*/
const struct prf_task_cbs* cscps_prf_itf_get(void)
{
return &cscps_itf;
}
void cscps_send_cmp_evt(uint8_t conidx, uint8_t src_id, uint8_t dest_id, uint8_t operation, uint8_t status)
{
// Get the address of the environment
struct cscps_env_tag *cscps_env = PRF_ENV_GET(CSCPS, cscps);
// Go back to the Connected state if the state is busy
if (ke_state_get(src_id) == CSCPS_BUSY)
{
ke_state_set(src_id, CSCPS_IDLE);
}
// Set the operation code
cscps_env->operation = CSCPS_RESERVED_OP_CODE;
// Send the message
struct cscps_cmp_evt *evt = KE_MSG_ALLOC(CSCPS_CMP_EVT,
dest_id, src_id,
cscps_cmp_evt);
evt->conidx = conidx;
evt->operation = operation;
evt->status = status;
ke_msg_send(evt);
}
void cscps_exe_operation(void)
{
struct cscps_env_tag *cscps_env = PRF_ENV_GET(CSCPS, cscps);
ASSERT_ERR(cscps_env->ntf != NULL);
bool finished = true;
while(cscps_env->ntf->cursor < BLE_CONNECTION_MAX)
{
// Check if notifications are enabled
if(CSCPS_IS_NTFIND_ENABLED(cscps_env->ntf->cursor, CSCP_PRF_CFG_FLAG_CSC_MEAS_NTF))
{
// Allocate the GATT notification message
struct gattc_send_evt_cmd *meas_val = KE_MSG_ALLOC_DYN(GATTC_SEND_EVT_CMD,
KE_BUILD_ID(TASK_GATTC, cscps_env->ntf->cursor),
prf_src_task_get(&(cscps_env->prf_env), 0),
gattc_send_evt_cmd, cscps_env->ntf->length);
// Fill in the parameter structure
meas_val->operation = GATTC_NOTIFY;
meas_val->handle = CSCPS_HANDLE(CSCS_IDX_CSC_MEAS_VAL);
meas_val->length = cscps_env->ntf->length;
memcpy(meas_val->value, cscps_env->ntf->value, cscps_env->ntf->length);
// Send the event
ke_msg_send(meas_val);
finished = false;
cscps_env->ntf->cursor++;
break;
}
cscps_env->ntf->cursor++;
}
// check if operation is finished
if(finished)
{
// Inform the application that a procedure has been completed
struct cscps_ntf_csc_meas_rsp *rsp = KE_MSG_ALLOC(CSCPS_NTF_CSC_MEAS_RSP,
prf_dst_task_get(&(cscps_env->prf_env), 0),
prf_src_task_get(&(cscps_env->prf_env), 0),
cscps_ntf_csc_meas_rsp);
rsp->status = GAP_ERR_NO_ERROR;
rsp->tot_wheel_rev = cscps_env->tot_wheel_rev;
ke_msg_send(rsp);
// free operation
ke_free(cscps_env->ntf);
cscps_env->ntf = NULL;
cscps_env->operation = CSCPS_RESERVED_OP_CODE;
ke_state_set(prf_src_task_get(&(cscps_env->prf_env), 0), CSCPS_IDLE);
}
}
void cscps_send_rsp_ind(uint8_t conidx, uint8_t req_op_code, uint8_t status)
{
// Get the address of the environment
struct cscps_env_tag *cscps_env = PRF_ENV_GET(CSCPS, cscps);
// Allocate the GATT notification message
struct gattc_send_evt_cmd *ctl_pt_rsp = KE_MSG_ALLOC_DYN(GATTC_SEND_EVT_CMD,
KE_BUILD_ID(TASK_GATTC, conidx),
prf_src_task_get(&cscps_env->prf_env, conidx),
gattc_send_evt_cmd, CSCP_SC_CNTL_PT_RSP_MIN_LEN);
// Fill in the parameter structure
ctl_pt_rsp->operation = GATTC_INDICATE;
ctl_pt_rsp->handle = CSCPS_HANDLE(CSCS_IDX_SC_CTNL_PT_VAL);
// Pack Control Point confirmation
ctl_pt_rsp->length = CSCP_SC_CNTL_PT_RSP_MIN_LEN;
// Response Code
ctl_pt_rsp->value[0] = CSCP_CTNL_PT_RSP_CODE;
// Request Operation Code
ctl_pt_rsp->value[1] = req_op_code;
// Response value
ctl_pt_rsp->value[2] = status;
// Send the event
ke_msg_send(ctl_pt_rsp);
}
#endif //(BLE_CSC_SENSOR)
/// @} CSCPS