Files
ch32v20x-examples/EVT/EXAM/BLE/CyclingSensor/Profile/cyclingservice.c
T
2023-09-06 10:08:11 +08:00

822 lines
24 KiB
C

/********************************** (C) COPYRIGHT *******************************
* File Name : cyclingservice.c
* Author : WCH
* Version : V1.0
* Date : 2018/12/11
* Description : Cycling service
*********************************************************************************
* Copyright (c) 2021 Nanjing Qinheng Microelectronics Co., Ltd.
* Attention: This software (modified or not) and binary are used for
* microcontroller manufactured by Nanjing Qinheng Microelectronics.
*******************************************************************************/
/*********************************************************************
* INCLUDES
*/
#include "CONFIG.h"
#include "battservice.h"
#include "cyclingservice.h"
/*********************************************************************
* MACROS
*/
/*********************************************************************
* CONSTANTS
*/
/*********************************************************************
* TYPEDEFS
*/
// Cycling Service Task Events
#define CSC_CMD_IND_SEND_EVT 0x0001
#define CSC_MEAS_VALUE_POS 2
#define CSC_MEAS_CFG_POS 3
#define CSC_COMMAND_VALUE_POS 9
#define CSC_COMMAND_CFG_POS 10
#define COMMAND_IND_LENGTH 2
#define CSC_CMD_LEN (3 + CSC_MAX_SENSOR_LOCS)
/*********************************************************************
* GLOBAL VARIABLES
*/
// CSC service
const uint8_t cyclingServUUID[ATT_BT_UUID_SIZE] = {
LO_UINT16(CSC_SERV_UUID), HI_UINT16(CSC_SERV_UUID)};
// CSC measurement characteristic
const uint8_t cyclingMeasUUID[ATT_BT_UUID_SIZE] = {
LO_UINT16(CSC_MEAS_UUID), HI_UINT16(CSC_MEAS_UUID)};
// CSC feature characteristic
const uint8_t cyclingFeatureUUID[ATT_BT_UUID_SIZE] = {
LO_UINT16(CSC_FEATURE_UUID), HI_UINT16(CSC_FEATURE_UUID)};
// CSC sensor location characteristic
const uint8_t cyclingSensLocUUID[ATT_BT_UUID_SIZE] = {
LO_UINT16(SENSOR_LOC_UUID), HI_UINT16(SENSOR_LOC_UUID)};
// CSC command characteristic
const uint8_t cyclingCommandUUID[ATT_BT_UUID_SIZE] = {
LO_UINT16(SC_CTRL_PT_UUID), HI_UINT16(SC_CTRL_PT_UUID)};
/*********************************************************************
* EXTERNAL VARIABLES
*/
/*********************************************************************
* EXTERNAL FUNCTIONS
*/
/*********************************************************************
* LOCAL VARIABLES
*/
static cyclingServiceCB_t cyclingServiceCB = NULL;
static uint8_t supportedSensors = 0;
static BOOL scOpInProgress = FALSE;
// Variables used in CSC command processing
static uint16_t connectionHandle;
static attHandleValueInd_t cscCmdInd;
/*********************************************************************
* Profile Attributes - variables
*/
// TaskID
uint8_t cyclingService_TaskID = 0;
// CSC Service attribute
static const gattAttrType_t cyclingService = {ATT_BT_UUID_SIZE, cyclingServUUID};
// Available sensor locations
static uint8_t supportedSensorLocations[CSC_MAX_SENSOR_LOCS];
// Cycling Measurement Characteristic
// Note: characteristic value is not stored here
static uint8_t cyclingMeasProps = GATT_PROP_NOTIFY;
static uint8_t cyclingMeas = 0;
static gattCharCfg_t cyclingMeasClientCharCfg[GATT_MAX_NUM_CONN];
// Feature Characteristic
static uint8_t cyclingFeatureProps = GATT_PROP_READ;
static uint16_t cyclingFeatures = CSC_NO_SUPPORT;
// Sensor Location Characteristic
static uint8_t cyclingSensLocProps = GATT_PROP_READ;
static uint8_t cyclingSensLoc = CSC_SENSOR_LOC_TOP_OF_SHOE;
// Command Characteristic
static uint8_t cyclingCommandProps = GATT_PROP_WRITE | GATT_PROP_INDICATE;
static uint8_t cyclingCommand = 0;
static gattCharCfg_t cyclingCommandClientCharCfg[GATT_MAX_NUM_CONN];
/*********************************************************************
* Profile Attributes - Table
*/
static gattAttribute_t cyclingAttrTbl[] = {
// CSC Service
{
{ATT_BT_UUID_SIZE, primaryServiceUUID}, /* type */
GATT_PERMIT_READ, /* permissions */
0, /* handle */
(uint8_t *)&cyclingService /* pValue */
},
// CSC Measurement Declaration
{
{ATT_BT_UUID_SIZE, characterUUID},
GATT_PERMIT_READ,
0,
&cyclingMeasProps},
// Measurement Value
{
{ATT_BT_UUID_SIZE, cyclingMeasUUID},
0,
0,
&cyclingMeas},
// Measurement Client Characteristic Configuration
{
{ATT_BT_UUID_SIZE, clientCharCfgUUID},
GATT_PERMIT_READ | GATT_PERMIT_WRITE,
0,
(uint8_t *)&cyclingMeasClientCharCfg},
// CSC Feature Declaration
{
{ATT_BT_UUID_SIZE, characterUUID},
GATT_PERMIT_READ,
0,
&cyclingFeatureProps},
// Feature Value
{
{ATT_BT_UUID_SIZE, cyclingFeatureUUID},
GATT_PERMIT_READ,
0,
(uint8_t *)&cyclingFeatures},
// CSC Sensor Location Declaration
{
{ATT_BT_UUID_SIZE, characterUUID},
GATT_PERMIT_READ,
0,
&cyclingSensLocProps},
// Sensor Location Value
{
{ATT_BT_UUID_SIZE, cyclingSensLocUUID},
GATT_PERMIT_READ,
0,
&cyclingSensLoc},
// CSC Command Declaration
{
{ATT_BT_UUID_SIZE, characterUUID},
GATT_PERMIT_READ,
0,
&cyclingCommandProps},
// Command Value
{
{ATT_BT_UUID_SIZE, cyclingCommandUUID},
GATT_PERMIT_WRITE,
0,
&cyclingCommand},
// Command Client Characteristic Configuration
{
{ATT_BT_UUID_SIZE, clientCharCfgUUID},
GATT_PERMIT_READ | GATT_PERMIT_WRITE,
0,
(uint8_t *)&cyclingCommandClientCharCfg}
};
/*********************************************************************
* LOCAL FUNCTIONS
*/
static uint8_t cycling_ReadAttrCB(uint16_t connHandle, gattAttribute_t *pAttr,
uint8_t *pValue, uint16_t *pLen, uint16_t offset,
uint16_t maxLen, uint8_t method);
static bStatus_t cycling_WriteAttrCB(uint16_t connHandle, gattAttribute_t *pAttr,
uint8_t *pValue, uint16_t len, uint16_t offset,
uint8_t method);
static void cycling_ProcessTMOSMsg(tmos_event_hdr_t *pMsg);
static void cycling_ProcessGATTMsg(gattMsgEvent_t *pMsg);
static BOOL cycling_SensorLocSupported(uint8_t sensorLoc);
static void cycling_ProcessCSCCmd(uint16_t attrHandle, uint8_t *pValue, uint8_t len);
/*********************************************************************
* PROFILE CALLBACKS
*/
// CSC Service Callbacks
gattServiceCBs_t cyclingCBs = {
cycling_ReadAttrCB, // Read callback function pointer
cycling_WriteAttrCB, // Write callback function pointer
NULL // Authorization callback function pointer
};
/*********************************************************************
* PUBLIC FUNCTIONS
*/
/*********************************************************************
* @fn CyclingService_Init
*
* @brief collect the TMOS task ID.
*
* @param task_id - TMOS task ID.
*
* @return none
*/
void CyclingService_Init()
{
// Only purpose is to obtain task ID
cyclingService_TaskID = TMOS_ProcessEventRegister(CyclingService_ProcessEvent);
}
/*********************************************************************
* @fn CyclingService_ProcessEvent
*
* @brief process incoming event.
*
* @param task_id - TMOS task id.
*
* @param events - event bit(s) set for the task(s)
*
* @return none
*/
uint16_t CyclingService_ProcessEvent(uint8_t task_id, uint16_t events)
{
if(events & SYS_EVENT_MSG)
{
uint8_t *pMsg;
if((pMsg = tmos_msg_receive(cyclingService_TaskID)) != NULL)
{
cycling_ProcessTMOSMsg((tmos_event_hdr_t *)pMsg);
// Release the TMOS message
tmos_msg_deallocate(pMsg);
}
// return unprocessed events
return (events ^ SYS_EVENT_MSG);
}
if(events & CSC_CMD_IND_SEND_EVT)
{
// Send the indication.
if(GATT_Indication(connectionHandle, &cscCmdInd, FALSE, cyclingService_TaskID) != SUCCESS)
{
GATT_bm_free((gattMsg_t *)&cscCmdInd, ATT_HANDLE_VALUE_IND);
}
// Set Control Point Cfg done
scOpInProgress = FALSE;
return (events ^ CSC_CMD_IND_SEND_EVT);
}
return 0;
}
/*********************************************************************
* @fn cycling_ProcessTMOSMsg
*
* @brief process incoming TMOS msg.
*
* @param pMsg- pointer to messag to be read.
*
* @return none
*/
void cycling_ProcessTMOSMsg(tmos_event_hdr_t *pMsg)
{
switch(pMsg->event)
{
case GATT_MSG_EVENT:
cycling_ProcessGATTMsg((gattMsgEvent_t *)pMsg);
break;
default: // do nothing
break;
}
}
/*********************************************************************
* @fn cycling_ProcessGATTMsg
*
* @brief process incoming GATT msg.
*
* @param pMsg- pointer to messag to be read.
*
* @return none
*/
void cycling_ProcessGATTMsg(gattMsgEvent_t *pMsg)
{
if(pMsg->method == ATT_HANDLE_VALUE_CFM)
{
// Indication receipt was confirmed by the client.
// This is a placeholder for future.
}
}
/*********************************************************************
* @fn cycling_SensorLocSupported
*
* @brief check to see if sensor location is supported
*
* @param sensorLoc - location to check for
*
* @return TRUE if supported, FALSE otherwise
*/
static BOOL cycling_SensorLocSupported(uint8_t sensorLoc)
{
uint8_t i;
for(i = 0; i <= supportedSensors; i++)
{
if(supportedSensorLocations[i] == sensorLoc)
{
return TRUE;
}
}
return FALSE;
}
/*********************************************************************
* @fn Cycling_AddService
*
* @brief Initializes the CSC service by registering
* GATT attributes with the GATT server.
*
* @param services - services to add. This is a bit map and can
* contain more than one service.
*
* @return Success or Failure
*/
bStatus_t Cycling_AddService(uint32_t services)
{
uint8_t status = SUCCESS;
// Initialize Client Characteristic Configuration attributes
GATTServApp_InitCharCfg(INVALID_CONNHANDLE, cyclingMeasClientCharCfg);
GATTServApp_InitCharCfg(INVALID_CONNHANDLE, cyclingCommandClientCharCfg);
if(services & CYCLING_SERVICE)
{
// Register GATT attribute list and CBs with GATT Server App
status = GATTServApp_RegisterService(cyclingAttrTbl,
GATT_NUM_ATTRS(cyclingAttrTbl),
GATT_MAX_ENCRYPT_KEY_SIZE,
&cyclingCBs);
}
return (status);
}
/*********************************************************************
* @fn Cycling_Register
*
* @brief Register a callback function with the CSC Service.
*
* @param pfnServiceCB - Callback function.
*
* @return None.
*/
void Cycling_Register(cyclingServiceCB_t pfnServiceCB)
{
cyclingServiceCB = pfnServiceCB;
}
/*********************************************************************
* @fn Cycling_SetParameter
*
* @brief Set a CSC parameter.
*
* @param param - Profile parameter ID
* @param len - length of data to right
* @param value - pointer to data to write. This is dependent on
* the parameter ID and WILL be cast to the appropriate
* data type (example: data type of uint16_t will be cast to
* uint16_t pointer).
*
* @return bStatus_t
*/
bStatus_t Cycling_SetParameter(uint8_t param, uint8_t len, void *pValue)
{
bStatus_t ret = SUCCESS;
switch(param)
{
case CSC_SENS_LOC:
cyclingSensLoc = *((uint8_t *)pValue);
break;
case CSC_FEATURE:
cyclingFeatures = *((uint8_t *)pValue);
break;
case CSC_AVAIL_SENS_LOCS:
if(supportedSensors < CSC_MAX_SENSOR_LOCS)
{
supportedSensorLocations[supportedSensors++] = *((uint8_t *)pValue);
}
break;
default:
ret = INVALIDPARAMETER;
break;
}
return (ret);
}
/*********************************************************************
* @fn Cycling_GetParameter
*
* @brief Get a CSC parameter.
*
* @param param - Profile parameter ID
* @param value - pointer to data to get. This is dependent on
* the parameter ID and WILL be cast to the appropriate
* data type (example: data type of uint16_t will be cast to
* uint16_t pointer).
*
* @return bStatus_t
*/
bStatus_t Cycling_GetParameter(uint8_t param, void *value)
{
bStatus_t ret = SUCCESS;
switch(param)
{
case CSC_FEATURE:
*((uint8_t *)value) = cyclingFeatures;
break;
case CSC_SENS_LOC:
*((uint8_t *)value) = cyclingSensLoc;
break;
case CSC_COMMAND:
*((uint8_t *)value) = cyclingCommand;
break;
default:
ret = INVALIDPARAMETER;
break;
}
return (ret);
}
/*********************************************************************
* @fn Cycling_MeasNotify
*
* @brief Send a notification containing a CSC
* measurement.
*
* @param connHandle - connection handle
* @param pNoti - pointer to notification structure
*
* @return Success or Failure
*/
bStatus_t Cycling_MeasNotify(uint16_t connHandle, attHandleValueNoti_t *pNoti)
{
uint16_t value = GATTServApp_ReadCharCfg(connHandle, cyclingMeasClientCharCfg);
// If notifications enabled
if(value & GATT_CLIENT_CFG_NOTIFY)
{
// Set the handle
pNoti->handle = cyclingAttrTbl[CSC_MEAS_VALUE_POS].handle;
// Send the notification
return GATT_Notification(connHandle, pNoti, FALSE);
}
return bleIncorrectMode;
}
/*********************************************************************
* @fn cycling_ProcessCSCCmd
*
* @brief process an incoming CSC command.
*
* @param attrHandle - attribute handle
* @param pValue - pointer to data to be written
* @param len - length of data
*
* @return none
*/
static void cycling_ProcessCSCCmd(uint16_t attrHandle, uint8_t *pValue, uint8_t len)
{
uint8_t cscStatus = CSC_SUCCESS;
// See if need to alloc payload for new indication.
if(cscCmdInd.pValue == NULL)
{
cscCmdInd.pValue = GATT_bm_alloc(connectionHandle, ATT_HANDLE_VALUE_IND,
CSC_CMD_LEN, NULL, 0);
if(cscCmdInd.pValue == NULL)
{
return; // failed to alloc space!
}
}
// Set Control Point Cfg in progress
scOpInProgress = TRUE;
// Set indication info to be sent out
cscCmdInd.handle = attrHandle;
cscCmdInd.len = 3;
cscCmdInd.pValue[0] = CSC_COMMAND_RSP;
cscCmdInd.pValue[1] = pValue[0];
switch(pValue[0])
{
case CSC_SET_CUMM_VAL:
// If wheel revolutions is a feature
if((len <= 5) && (cyclingFeatures & CSC_WHEEL_REV_SUPP))
{
uint32_t cummWheelRevolutions;
// full 32 bits were specified.
if((len - 1) == 4)
{
cummWheelRevolutions = BUILD_UINT32(pValue[1], pValue[2], pValue[3], pValue[4]);
}
else
{
int i;
cummWheelRevolutions = 0;
// In case only lower bits were specified and upper bits remain zero.
for(i = 0; i < (len - 1); ++i)
{
cummWheelRevolutions += pValue[i + 1] << (i * 8);
}
}
// Notify app
if(cyclingServiceCB != NULL)
{
(*cyclingServiceCB)(CSC_CMD_SET_CUMM_VAL, &cummWheelRevolutions);
}
}
else // characteristic not supported.
{
cscStatus = CSC_INVALID_PARAMETER;
}
break;
case CSC_UPDATE_SENS_LOC:
// If multiple sensor locations is supported and that this is a valid location.
if((len == 2) &&
(cyclingFeatures & CSC_MULTI_SENS_SUPP) &&
(cycling_SensorLocSupported(pValue[1]) == TRUE))
{
// Update sensor location
cyclingSensLoc = pValue[1];
// Notify app
if(cyclingServiceCB != NULL)
{
(*cyclingServiceCB)(CSC_CMD_UPDATE_SENS_LOC, NULL);
}
}
else // characteristic not supported.
{
cscStatus = CSC_INVALID_PARAMETER;
}
break;
case CSC_REQ_SUPP_SENS_LOC:
// If multiple sensor locations are supported and list requested
if((len == 1) && (cyclingFeatures & CSC_MULTI_SENS_SUPP))
{
cscCmdInd.len += supportedSensors;
tmos_memcpy(&(cscCmdInd.pValue[3]), supportedSensorLocations, supportedSensors);
}
else // characteristic not supported.
{
// Send an indication with the list.
cscStatus = CSC_INVALID_PARAMETER;
}
break;
default:
// Send an indication with opcode not suported response
cscStatus = CSC_OPCODE_NOT_SUPPORTED;
break;
}
// Send indication of operation result
cscCmdInd.pValue[2] = cscStatus;
// Ask our task to send out indication
tmos_set_event(cyclingService_TaskID, CSC_CMD_IND_SEND_EVT);
}
/*********************************************************************
* @fn Cycling_HandleConnStatusCB
*
* @brief CSC Service link status change handler function.
*
* @param connHandle - connection handle
* @param changeType - type of change
*
* @return none
*/
void Cycling_HandleConnStatusCB(uint16_t connHandle, uint8_t changeType)
{
// Make sure this is not loopback connection
if(connHandle != LOOPBACK_CONNHANDLE)
{
// Reset Client Char Config if connection has dropped
if((changeType == LINKDB_STATUS_UPDATE_REMOVED) ||
((changeType == LINKDB_STATUS_UPDATE_STATEFLAGS) &&
(!linkDB_Up(connHandle))))
{
GATTServApp_InitCharCfg(connHandle, cyclingMeasClientCharCfg);
GATTServApp_InitCharCfg(connHandle, cyclingCommandClientCharCfg);
}
}
}
/*********************************************************************
* @fn cycling_ReadAttrCB
*
* @brief Read an attribute.
*
* @param connHandle - connection message was received on
* @param pAttr - pointer to attribute
* @param pValue - pointer to data to be read
* @param pLen - length of data to be read
* @param offset - offset of the first octet to be read
* @param maxLen - maximum length of data to be read
*
* @return Success or Failure
*/
static uint8_t cycling_ReadAttrCB(uint16_t connHandle, gattAttribute_t *pAttr,
uint8_t *pValue, uint16_t *pLen, uint16_t offset,
uint16_t maxLen, uint8_t method)
{
bStatus_t status = SUCCESS;
uint16_t uuid = BUILD_UINT16(pAttr->type.uuid[0], pAttr->type.uuid[1]);
// Make sure it's not a blob operation (no attributes in the profile are long)
if(offset > 0)
{
return (ATT_ERR_ATTR_NOT_LONG);
}
switch(uuid)
{
case SENSOR_LOC_UUID:
{
// Read Sensor Location
*pLen = 1;
pValue[0] = pAttr->pValue[0];
}
break;
case CSC_FEATURE_UUID:
{
//Read Cycling Feature
*pLen = 2;
pValue[0] = LO_UINT16(pAttr->pValue[0]);
pValue[1] = HI_UINT16(pAttr->pValue[0]);
}
break;
case GATT_CLIENT_CHAR_CFG_UUID:
{
// Read Measurement or Command Configuration
if(pAttr->pValue == (uint8_t *)cyclingMeasClientCharCfg)
{
*pLen = 1;
pValue[0] = GATTServApp_ReadCharCfg(connHandle, cyclingMeasClientCharCfg);
}
else if(pAttr->pValue == (uint8_t *)cyclingCommandClientCharCfg)
{
*pLen = 1;
pValue[0] = GATTServApp_ReadCharCfg(connHandle, cyclingCommandClientCharCfg);
}
else
{
status = ATT_ERR_ATTR_NOT_FOUND;
}
}
break;
default:
status = ATT_ERR_ATTR_NOT_FOUND;
break;
}
// Notify app
if(cyclingServiceCB != NULL)
{
(*cyclingServiceCB)(CSC_READ_ATTR, NULL);
}
return (status);
}
/*********************************************************************
* @fn cycling_WriteAttrCB
*
* @brief Validate attribute data prior to a write operation
*
* @param connHandle - connection message was received on
* @param pAttr - pointer to attribute
* @param pValue - pointer to data to be written
* @param len - length of data
* @param offset - offset of the first octet to be written
*
* @return Success or Failure
*/
static bStatus_t cycling_WriteAttrCB(uint16_t connHandle, gattAttribute_t *pAttr,
uint8_t *pValue, uint16_t len, uint16_t offset,
uint8_t method)
{
bStatus_t status = SUCCESS;
uint16_t uuid = BUILD_UINT16(pAttr->type.uuid[0], pAttr->type.uuid[1]);
if(offset > 0)
{
return (ATT_ERR_ATTR_NOT_LONG);
}
switch(uuid)
{
case SC_CTRL_PT_UUID:
// Make sure Control Point Cfg is not already in progress
if(scOpInProgress == TRUE)
{
status = CSC_ERR_PROC_IN_PROGRESS;
}
// Make sure Control Point Cfg is configured for Indications
else if((cyclingCommandClientCharCfg[connHandle].value & GATT_CLIENT_CFG_INDICATE) == FALSE)
{
status = CSC_ERR_CCC_IMPROPER_CFG;
}
else
{
// Process CSC command
cycling_ProcessCSCCmd(pAttr->handle, pValue, len);
connectionHandle = connHandle;
}
break;
// For Measure and Commands CCC
case GATT_CLIENT_CHAR_CFG_UUID:
if(pAttr->handle == cyclingAttrTbl[CSC_COMMAND_CFG_POS].handle)
{
status = GATTServApp_ProcessCCCWriteReq(connHandle, pAttr, pValue, len,
offset, GATT_CLIENT_CFG_INDICATE);
// Notify app
if(cyclingServiceCB != NULL)
{
(*cyclingServiceCB)(CSC_WRITE_ATTR, NULL);
}
}
else if(pAttr->handle == cyclingAttrTbl[CSC_MEAS_CFG_POS].handle)
{
status = GATTServApp_ProcessCCCWriteReq(connHandle, pAttr, pValue, len,
offset, GATT_CLIENT_CFG_NOTIFY);
if(status == SUCCESS)
{
// Notify app
if(cyclingServiceCB != NULL)
{
uint16_t charCfg = BUILD_UINT16(pValue[0], pValue[1]);
(*cyclingServiceCB)(((charCfg == GATT_CFG_NO_OPERATION) ? CSC_MEAS_NOTI_DISABLED : CSC_MEAS_NOTI_ENABLED), NULL);
}
}
}
break;
default:
status = ATT_ERR_ATTR_NOT_FOUND;
break;
}
return (status);
}
/*********************************************************************
*********************************************************************/