vance/vos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
vance
2022-10-23 23:45:43 -07:00
commit e190fa5193
6450 changed files with 8626944 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ambiq-hal-sys/ambiq-sparkfun-sdk/third_party/exactle/ble-profiles/sources/profiles/hid/hid_api.h
Vendored
+203
View File
@@ -0,0 +1,203 @@
/*************************************************************************************************/
/*!
* \file
*
* \brief Human Interface Device Profile.
*
* Copyright (c) 2015-2018 Arm Ltd.
*
* Copyright (c) 2019 Packetcraft, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*************************************************************************************************/
#ifndef HID_API_H
#define HID_API_H
#ifdef __cplusplus
extern "C" {
#endif
/*! \addtogroup HUMAN_INTERFACE_DEVICE_PROFILE
* \{ */
/**************************************************************************************************
Constant Values
**************************************************************************************************/
/** \name Type of HID Information
*
*/
/**@{*/
#define HID_INFO_CONTROL_POINT 0 /*!< \brief Control point information. */
#define HID_INFO_PROTOCOL_MODE 1 /*!< \brief Protocol mode information. */
/**@}*/
/** \name HID Boot Report ID
*
*/
/**@{*/
#define HID_KEYBOARD_BOOT_ID 0xFF /*!< \brief Keyboard boot ID. */
#define HID_MOUSE_BOOT_ID 0xFE /*!< \brief Mouse boot ID. */
/**@}*/
/**************************************************************************************************
Callback Function Types
**************************************************************************************************/
/*************************************************************************************************/
/*!
* \brief This callback function sends a received Output Report to the application.
*
* \param connId The connection identifier.
* \param id The ID of the report.
* \param len The length of the report data in pReport.
* \param pReport A buffer containing the report.
*
* \return None.
*/
/*************************************************************************************************/
typedef void (*hidOutputReportCback_t)(dmConnId_t connId, uint8_t id, uint16_t len, uint8_t *pReport);
/*************************************************************************************************/
/*!
* \brief This callback function sends a received Feature Report to the application.
*
* \param connId The connection identifier.
* \param id The ID of the report.
* \param len The length of the report data in pReport.
* \param pReport A buffer containing the report.
*
* \return None.
*/
/*************************************************************************************************/
typedef void (*hidFeatureReportCback_t)(dmConnId_t connId, uint8_t id, uint16_t len, uint8_t *pReport);
/*************************************************************************************************/
/*!
* \brief This callback function notifies the application of a change in the protocol mode or
* control point from the host.
*
* \param connId The connection identifier.
* \param mode The type of information (\ref HID_INFO_CONTROL_POINT or \ref HID_INFO_PROTOCOL_MODE)
* \param value The value of the information
*
* \return None.
*/
/*************************************************************************************************/
typedef void (*hidInfoCback_t)(dmConnId_t connId, uint8_t type, uint8_t value);
/*! \brief HID Report Type/ID to Attribute handle map item */
typedef struct
{
uint8_t type; /*!< \brief Type */
uint8_t id; /*!< \brief Id */
uint16_t handle; /*!< \brief Handle */
} hidReportIdMap_t;
/*! \brief HID Profile Configuration */
typedef struct
{
hidReportIdMap_t *pReportIdMap; /*!< \brief A map between report Type/ID and Attribute handle */
uint8_t reportIdMapSize; /*!< \brief The number of Reports in the ID map (pReportIdMap) */
hidOutputReportCback_t outputCback; /*!< \brief Callback called on receipt of an Output Report */
hidFeatureReportCback_t featureCback; /*!< \brief Callback called on receipt of a Feature Report */
hidInfoCback_t infoCback; /*!< \brief Callback called on receipt of protocol mode or control point */
} hidConfig_t;
/**************************************************************************************************
API Functions
**************************************************************************************************/
/*************************************************************************************************/
/*!
* \brief Sends an input report to the host
*
* \param connId The connection ID
* \param reportId The Report ID
* \param len The length of the report in bytes
* \param pValue A buffer containing the report
*
* \return none.
*/
/*************************************************************************************************/
void HidSendInputReport(dmConnId_t connId, uint8_t reportId, uint16_t len, uint8_t *pValue);
/*************************************************************************************************/
/*!
* \brief Sets the HID protocol mode for keyboard and mouse devices that support Boot Mode.
*
* \param protocolMode The protocol mode (\ref HID_PROTOCOL_MODE_REPORT or \ref HID_PROTOCOL_MODE_BOOT)
*
* \return None.
*/
/*************************************************************************************************/
void HidSetProtocolMode(uint8_t protocolMode);
/*************************************************************************************************/
/*!
* \brief Gets the HID protocol mode value.
*
* \return The protocol mode value (\ref HID_PROTOCOL_MODE_REPORT or \ref HID_PROTOCOL_MODE_BOOT).
*/
/*************************************************************************************************/
uint8_t HidGetProtocolMode(void);
/*************************************************************************************************/
/*!
* \brief Gets the HID control point value.
*
* \return The control point value (\ref HID_CONTROL_POINT_SUSPEND or \ref HID_CONTROL_POINT_RESUME).
*/
/*************************************************************************************************/
uint8_t HidGetControlPoint(void);
/*************************************************************************************************/
/*!
* \brief Initialize the HID profile.
*
* \param pConfig HID Configuration structure
*
* \return None.
*/
/*************************************************************************************************/
void HidInit(const hidConfig_t *pConfig);
/*************************************************************************************************/
/*!
* \brief Called on an ATTS Write to the HID Service.
*
* \param connId DM connection identifier.
* \param handle ATT handle.
* \param operation ATT operation.
* \param offset Write offset.
* \param len Write length.
* \param pValue Value to write.
* \param pAttr Attribute to write.
*
* \return ATT status.
*
*/
/*************************************************************************************************/
uint8_t HidAttsWriteCback(dmConnId_t connId, uint16_t handle, uint8_t operation,
uint16_t offset, uint16_t len, uint8_t *pValue,
attsAttr_t *pAttr);
/*! \} */ /* HUMAN_INTERFACE_DEVICE_PROFILE */
#ifdef __cplusplus
};
#endif
#endif /* HID_API_H */
ambiq-hal-sys/ambiq-sparkfun-sdk/third_party/exactle/ble-profiles/sources/profiles/hid/hid_main.c
Vendored
+286
View File
@@ -0,0 +1,286 @@
/*************************************************************************************************/
/*!
* \file
*
* \brief Human Interface Device Profile.
*
* Copyright (c) 2015-2019 Arm Ltd.
*
* Copyright (c) 2019 Packetcraft, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*************************************************************************************************/
#include <string.h>
#include "wsf_types.h"
#include "wsf_assert.h"
#include "wsf_trace.h"
#include "att_api.h"
#include "svc_hid.h"
#include "app_api.h"
#include "hid_api.h"
/**************************************************************************************************
Global Variables
**************************************************************************************************/
/*! HID control block */
typedef struct
{
const hidConfig_t *pConfig; /* HID Configuration passed in from the application */
} hidCb_t;
hidCb_t hidCb;
/*************************************************************************************************/
/*!
* \brief Gets the attribute handle of a report given the type and id
*
* \param type The type of report (HID_REPORT_TYPE_INPUT, HID_REPORT_TYPE_OUTPUT, HID_REPORT_TYPE_FEATURE)
* \param id The ID of the report
*
* \return The attribute handle for the report or ATT_HANDLE_NONE if the report is not in the map.
*/
/*************************************************************************************************/
static uint16_t hidGetReportHandle(uint8_t type, uint8_t id)
{
hidReportIdMap_t *pMap;
uint8_t count;
uint8_t i;
WSF_ASSERT(hidCb.pConfig);
WSF_ASSERT(hidCb.pConfig->pReportIdMap);
pMap = hidCb.pConfig->pReportIdMap;
count = hidCb.pConfig->reportIdMapSize;
for (i = 0; i < count; i++)
{
if (pMap[i].type == type && pMap[i].id == id)
{
return pMap[i].handle;
}
}
return ATT_HANDLE_NONE;
}
/*************************************************************************************************/
/*!
* \brief Gets the type and ID of a report given a handle
*
* \param handle The attribute handle
*
* \return A pointer to the hidReportIdMap_t with the type and ID
*/
/*************************************************************************************************/
static hidReportIdMap_t *hidGetReportIdMap(uint16_t handle)
{
hidReportIdMap_t *pMap;
uint8_t count;
uint8_t i;
WSF_ASSERT(hidCb.pConfig);
WSF_ASSERT(hidCb.pConfig->pReportIdMap);
pMap = hidCb.pConfig->pReportIdMap;
count = hidCb.pConfig->reportIdMapSize;
for (i = 0; i < count; i++)
{
if (pMap[i].handle == handle)
{
return &pMap[i];
}
}
return NULL;
}
/*************************************************************************************************/
/*!
* \brief Gets the HID control point value.
*
* \return The control point value (HID_CONTROL_POINT_SUSPEND or HID_CONTROL_POINT_RESUME).
*/
/*************************************************************************************************/
uint8_t HidGetControlPoint(void)
{
uint16_t len = 1;
uint8_t *pValue = NULL;
AttsGetAttr(HID_CONTROL_POINT_HDL, &len, &pValue);
return *pValue;
}
/*************************************************************************************************/
/*!
* \brief Gets the HID protocol mode value.
*
* \return The protocol mode value (HID_PROTOCOL_MODE_REPORT or HID_PROTOCOL_MODE_BOOT).
*/
/*************************************************************************************************/
uint8_t HidGetProtocolMode(void)
{
uint16_t len = 1;
uint8_t *pValue = NULL;
AttsGetAttr(HID_PROTOCOL_MODE_HDL, &len, &pValue);
return *pValue;
}
/*************************************************************************************************/
/*!
* \brief Sets the HID protocol mode for keyboard and mouse devices that support Boot Mode.
*
* \param protocolMode The protocol mode (HID_PROTOCOL_MODE_REPORT or HID_PROTOCOL_MODE_BOOT)
*
* \return None.
*/
/*************************************************************************************************/
void HidSetProtocolMode(uint8_t protocolMode)
{
AttsSetAttr(HID_PROTOCOL_MODE_HDL, 1, &protocolMode);
}
/*************************************************************************************************/
/*!
* \brief Sends an input report to the host
*
* \param connId The connection ID
* \param reportId The Report ID
* \param len The length of the report in bytes
* \param pValue A buffer containing the report
*
* \return none.
*/
/*************************************************************************************************/
void HidSendInputReport(dmConnId_t connId, uint8_t reportId, uint16_t len, uint8_t *pValue)
{
uint16_t handle = hidGetReportHandle(HID_REPORT_TYPE_INPUT, reportId);
if (handle != ATT_HANDLE_NONE)
{
/* Store the attribute value */
AttsSetAttr(handle, len, pValue);
/* send notification */
AttsHandleValueNtf(connId, handle, len, pValue);
}
}
/*************************************************************************************************/
/*!
* \brief Called on an ATTS Write to the HID Service.
*
* \return ATT status.
*
*/
/*************************************************************************************************/
uint8_t HidAttsWriteCback(dmConnId_t connId, uint16_t handle, uint8_t operation,
uint16_t offset, uint16_t len, uint8_t *pValue,
attsAttr_t *pAttr)
{
hidReportIdMap_t *pIdMap;
WSF_ASSERT(hidCb.pConfig);
switch (handle)
{
case HID_CONTROL_POINT_HDL:
/* notify the application */
if (hidCb.pConfig->infoCback != NULL)
{
hidCb.pConfig->infoCback(connId, HID_INFO_CONTROL_POINT, *pValue);
}
break;
case HID_PROTOCOL_MODE_HDL:
/* Record the value of the protocol mode */
HidSetProtocolMode(pValue[0]);
if (hidCb.pConfig->infoCback != NULL)
{
hidCb.pConfig->infoCback(connId, HID_INFO_PROTOCOL_MODE, *pValue);
}
break;
case HID_KEYBOARD_BOOT_OUT_HDL:
/* set the attribute value so it can be read by the host */
AttsSetAttr(handle, len, pValue);
/* notify the application */
if (hidCb.pConfig->outputCback != NULL)
{
pIdMap = hidGetReportIdMap(handle);
if (pIdMap != NULL)
{
hidCb.pConfig->outputCback(connId, pIdMap->id, len, pValue);
}
}
break;
default:
pIdMap = hidGetReportIdMap(handle);
if (pIdMap != NULL)
{
/* set the attribute value so it can be read by the host */
AttsSetAttr(handle, len, pValue);
/* notify the application */
if (pIdMap->type == HID_REPORT_TYPE_FEATURE)
{
if (hidCb.pConfig->featureCback != NULL)
{
hidCb.pConfig->featureCback(connId, pIdMap->id, len, pValue);
}
}
else if (pIdMap->type == HID_REPORT_TYPE_OUTPUT)
{
if (hidCb.pConfig->outputCback != NULL)
{
hidCb.pConfig->outputCback(connId, pIdMap->id, len, pValue);
}
}
}
break;
}
return 0;
}
/*************************************************************************************************/
/*!
* \brief Initialize the HID profile.
*
* \param pConfig HID Configuration structure
*
* \return None.
*/
/*************************************************************************************************/
void HidInit(const hidConfig_t *pConfig)
{
WSF_ASSERT(pConfig);
/* Store the configuration */
hidCb.pConfig = pConfig;
}