Cordio Stack and Cordio Profiles  r2p3-02rel0
hid_api.h File Reference

Human Interface Device Profile. More...

Go to the source code of this file.

Data Structures

struct  hidReportIdMap_t
 HID Report Type/ID to Attribute handle map item. More...
 
struct  hidConfig_t
 HID Profile Configuration. More...
 

Macros

Type of HID Information
#define HID_INFO_CONTROL_POINT   0
 Control point information.
 
#define HID_INFO_PROTOCOL_MODE   1
 Protocol mode information.
 
HID Boot Report ID
#define HID_KEYBOARD_BOOT_ID   0xFF
 Keyboard boot ID.
 
#define HID_MOUSE_BOOT_ID   0xFE
 Mouse boot ID.
 

Typedefs

typedef void(* hidOutputReportCback_t) (dmConnId_t connId, uint8_t id, uint16_t len, uint8_t *pReport)
 This callback function sends a received Output Report to the application. More...
 
typedef void(* hidFeatureReportCback_t) (dmConnId_t connId, uint8_t id, uint16_t len, uint8_t *pReport)
 This callback function sends a received Feature Report to the application. More...
 
typedef void(* hidInfoCback_t) (dmConnId_t connId, uint8_t type, uint8_t value)
 This callback function notifies the application of a change in the protocol mode or control point from the host. More...
 

Functions

void HidSendInputReport (dmConnId_t connId, uint8_t reportId, uint16_t len, uint8_t *pValue)
 Sends an input report to the host. More...
 
void HidSetProtocolMode (uint8_t protocolMode)
 Sets the HID protocol mode for keyboard and mouse devices that support Boot Mode. More...
 
uint8_t HidGetProtocolMode (void)
 Gets the HID protocol mode value. More...
 
uint8_t HidGetControlPoint (void)
 Gets the HID control point value. More...
 
void HidInit (const hidConfig_t *pConfig)
 Initialize the HID profile. More...
 
uint8_t HidAttsWriteCback (dmConnId_t connId, uint16_t handle, uint8_t operation, uint16_t offset, uint16_t len, uint8_t *pValue, attsAttr_t *pAttr)
 Called on an ATTS Write to the HID Service. More...
 

Description

Human Interface Device Profile.

Copyright (c) 2015-2018 Arm Ltd. All Rights Reserved. Arm Ltd. confidential and proprietary.

IMPORTANT. Your use of this file is governed by a Software License Agreement ("Agreement") that must be accepted in order to download or otherwise receive a copy of this file. You may not use or copy this file for any purpose other than as described in the Agreement. If you do not agree to all of the terms of the Agreement do not use this file and delete all copies in your possession or control; if you do not have a copy of the Agreement, you must contact Arm Ltd. prior to any use, copying or further distribution of this software.

Definition in file hid_api.h.