HCI_INTERFACE (Compact 2013)
3/26/2014
This structure contains pointers to the functions in the Host Controller Interface (HCI).
Syntax
struct _HCI_INTERFACE {
HCI_Inquiry_In hci_Inquiry_In;
HCI_InquiryCancel_In hci_InquiryCancel_In;
HCI_PeriodicInquiryMode_In hci_PeriodicInquiryMode_In;
HCI_ExitPeriodicInquiryMode_In hci_ExitPeriodicInquiryMode_In;
HCI_CreateConnection_In hci_CreateConnection_In;
HCI_Disconnect_In hci_Disconnect_In;
HCI_AddSCOConnection_In hci_AddSCOConnection_In;
HCI_AcceptConnectionRequest_In hci_AcceptConnectionRequest_In;
HCI_RejectConnectionRequest_In hci_RejectConnectionRequest_In;
HCI_LinkKeyRequestReply_In hci_LinkKeyRequestReply_In;
HCI_LinkKeyRequestNegativeReply_In hci_LinkKeyRequestNegativeReply_In;
HCI_PINCodeRequestReply_In hci_PINCodeRequestReply_In;
HCI_PINCodeRequestNegativeReply_In hci_PINCodeRequestNegativeReply_In;
HCI_ChangeConnectionPacketType_In hci_ChangeConnectionPacketType_In;
HCI_AuthenticationRequested_In hci_AuthenticationRequested_In;
HCI_SetConnectionEncryption_In hci_SetConnectionEncryption_In;
HCI_ChangeConnectionLinkKey_In hci_ChangeConnectionLinkKey_In;
HCI_MasterLinkKey_In hci_MasterLinkKey_In;
HCI_RemoteNameRequest_In hci_RemoteNameRequest_In;
HCI_ReadRemoteSupportedFeatures_In hci_ReadRemoteSupportedFeatures_In;
HCI_ReadRemoteVersionInformation_In hci_ReadRemoteVersionInformation_In;
HCI_ReadClockOffset_In hci_ReadClockOffset_In;
HCI_HoldMode_In hci_HoldMode_In;
HCI_SniffMode_In hci_SniffMode_In;
HCI_ExitSniffMode_In hci_ExitSniffMode_In;
HCI_SSRMode_In hci_SSRMode_In;
HCI_ParkMode_In hci_ParkMode_In;
HCI_ExitParkMode_In hci_ExitParkMode_In;
HCI_QoSSetup_In hci_QoSSetup_In;
HCI_RoleDiscovery_In hci_RoleDiscovery_In;
HCI_SwitchRole_In hci_SwitchRole_In;
HCI_ReadLinkPolicySettings_In hci_ReadLinkPolicySettings_In;
HCI_WriteLinkPolicySettings_In hci_WriteLinkPolicySettings_In;
HCI_SetEventMask_In hci_SetEventMask_In;
HCI_Reset_In hci_Reset_In;
HCI_SetEventFilter_In hci_SetEventFilter_In;
HCI_Flush_In hci_Flush_In;
HCI_EnhancedFlush_In hci_EnhancedFlush_In;
HCI_ReadPINType_In hci_ReadPINType_In;
HCI_WritePINType_In hci_WritePINType_In;
HCI_CreateNewUnitKey_In hci_CreateNewUnitKey_In;
HCI_ReadStoredLinkKey_In hci_ReadStoredLinkKey_In;
HCI_WriteStoredLinkKey_In hci_WriteStoredLinkKey_In;
HCI_DeleteStoredLinkKey_In hci_DeleteStoredLinkKey_In;
HCI_ChangeLocalName_In hci_ChangeLocalName_In;
HCI_ReadLocalName_In hci_ReadLocalName_In;
HCI_ReadConnectionAcceptTimeout_In hci_ReadConnectionAcceptTimeout_In;
HCI_WriteConnectionAcceptTimeout_In hci_WriteConnectionAcceptTimeout_In;
HCI_ReadPageTimeout_In hci_ReadPageTimeout_In;
HCI_WritePageTimeout_In hci_WritePageTimeout_In;
HCI_ReadScanEnable_In hci_ReadScanEnable_In;
HCI_WriteScanEnable_In hci_WriteScanEnable_In;
HCI_ReadPageScanActivity_In hci_ReadPageScanActivity_In;
HCI_WritePageScanActivity_In hci_WritePageScanActivity_In;
HCI_ReadInquiryScanActivity_In hci_ReadInquiryScanActivity_In;
HCI_WriteInquiryScanActivity_In hci_WriteInquiryScanActivity_In;
HCI_ReadAuthenticationEnable_In hci_ReadAuthenticationEnable_In;
HCI_WriteAuthenticationEnable_In hci_WriteAuthenticationEnable_In;
HCI_ReadEncryptionMode_In hci_ReadEncryptionMode_In;
HCI_WriteEncryptionMode_In hci_WriteEncryptionMode_In;
HCI_ReadClassOfDevice_In hci_ReadClassOfDevice_In;
HCI_WriteClassOfDevice_In hci_WriteClassOfDevice_In;
HCI_ReadVoiceSetting_In hci_ReadVoiceSetting_In;
HCI_WriteVoiceSetting_In hci_WriteVoiceSetting_In;
HCI_ReadAutomaticFlushTimeout_In hci_ReadAutomaticFlushTimeout_In;
HCI_WriteAutomaticFlushTimeout_In hci_WriteAutomaticFlushTimeout_In;
HCI_ReadNumBroadcastRetransmissions_In hci_ReadNumBroadcastRetransmissions_In;
HCI_WriteNumBroadcastRetransmissions_In hci_WriteNumBroadcastRetransmissions_In;
HCI_ReadHoldModeActivity_In hci_ReadHoldModeActivity_In;
HCI_WriteHoldModeActivity_In hci_WriteHoldModeActivity_In;
HCI_ReadTransmitPowerLevel_In hci_ReadTransmitPowerLevel_In;
HCI_ReadSCOFlowControlEnable_In hci_ReadSCOFlowControlEnable_In;
HCI_WriteSCOFlowControlEnable_In hci_WriteSCOFlowControlEnable_In;
HCI_SetHostControllerToHostFlowControl_In hci_SetHostControllerToHostFlowControl_In;
HCI_HostBufferSize_In hci_HostBufferSize_In;
HCI_HostNumberOfCompletedPackets hci_HostNumberOfCompletedPackets;
HCI_ReadLinkSupervisionTimeout_In hci_ReadLinkSupervisionTimeout_In;
HCI_WriteLinkSupervisionTimeout_In hci_WriteLinkSupervisionTimeout_In;
HCI_ReadNumberOfSupportedIAC_In hci_ReadNumberOfSupportedIAC_In;
HCI_ReadCurrentIACLAP_In hci_ReadCurrentIACLAP_In;
HCI_WriteCurrentIACLAP_In hci_WriteCurrentIACLAP_In;
HCI_ReadPageScanPeriodMode_In hci_ReadPageScanPeriodMode_In;
HCI_WritePageScanPeriodMode_In hci_WritePageScanPeriodMode_In;
HCI_ReadPageScanMode_In hci_ReadPageScanMode_In;
HCI_WritePageScanMode_In hci_WritePageScanMode_In;
HCI_ReadLocalVersionInformation_In hci_ReadLocalVersionInformation_In;
HCI_ReadLocalSupportedFeatures_In hci_ReadLocalSupportedFeatures_In;
HCI_ReadBufferSize_In hci_ReadBufferSize_In;
HCI_ReadCountryCode_In hci_ReadCountryCode_In;
HCI_ReadBDADDR_In hci_ReadBDADDR_In;
HCI_ReadFailedContactCounter_In hci_ReadFailedContactCounter_In;
HCI_ResetFailedContactCounter_In hci_ResetFailedContactCounter_In;
HCI_GetLinkQuality_In hci_GetLinkQuality_In;
HCI_ReadRSSI_In hci_ReadRSSI_In;
HCI_ReadLoopbackMode_In hci_ReadLoopbackMode_In;
HCI_WriteLoopbackMode_In hci_WriteLoopbackMode_In;
HCI_EnableDeviceUnderTestMode_In hci_EnableDeviceUnderTestMode_In;
HCI_CustomCode_In hci_CustomCode_In;
HCI_DataPacketDown_In hci_DataPacketDown_In;
BT_LAYER_IO_CONTROL hci_ioctl;
BT_LAYER_ABORT_CALL hci_AbortCall;
// V2 members
HCI_WritePageScanType_In hci_WritePageScanType_In;
HCI_WriteInquiryScanType_In hci_WriteInquiryScanType_In;
HCI_ReadPageScanType_In hci_ReadPageScanType_In;
HCI_ReadInquiryScanType_In hci_ReadInquiryScanType_In;
HCI_SetupSynchronousConnection_In hci_SetupSynchronousConnection_In;
HCI_AcceptSynchronousConnectionRequest_In hci_AcceptSynchronousConnectionRequest_In;
HCI_RejectSynchronousConnectionRequest_In hci_RejectSynchronousConnectionRequest_In;
// V3 members
HCI_WriteExtendedInquiryResponse_In hci_WriteExtendedInquiryResponse_In;
HCI_ReadExtendedInquiryResponse_In hci_ReadExtendedInquiryResponse_In;
HCI_WriteInquiryMode_In hci_WriteInquiryMode_In;
HCI_ReadInquiryMode_In hci_ReadInquiryMode_In;
HCI_DataPacketDownEx_In hci_DataPacketDownEx_In;
};
Members
- hci_Inquiry_In
Pointer to the hci_Inquiry_In function.
- hci_InquiryCancel_In
Pointer to the hci_InquiryCancel_In function.
- hci_PeriodicInquiryMode_In
Pointer to the hci_PeriodicInquiryMode_In function.
- hci_ExitPeriodicInquiryMode_In
Pointer to the hci_ExitPeriodicInquiryMode_In function.
- hci_CreateConnection_In
Pointer to the hci_CreateConnection_In function.
- hci_Disconnect_In
Pointer to the hci_Disconnect_In function.
- hci_AddSCOConnection_In
Pointer to the hci_AddSCOConnection_In function.
- hci_AcceptConnectionRequest_In
Pointer to the hci_AcceptConnectionRequest_In function.
- hci_RejectConnectionRequest_In
Pointer to the hci_RejectConnectionRequest_In function.
- hci_LinkKeyRequestReply_In
Pointer to the hci_LinkKeyRequestReply_In function.
- hci_LinkKeyRequestNegativeReply_In
Pointer to the hci_LinkKeyRequestNegativeReply_In function.
- hci_PINCodeRequestReply_In
Pointer to the hci_PINCodeRequestReply_In function.
- hci_PINCodeRequestNegativeReply_In
Pointer to the hci_PINCodeRequestNegativeReply_In function.
- hci_ChangeConnectionPacketType_In
Pointer to the hci_ChangeConnectionPacketType_In function.
- hci_AuthenticationRequested_In
Pointer to the hci_AuthenticationRequested_In function.
- hci_SetConnectionEncryption_In
Pointer to the hci_SetConnectionEncryption_In function.
- hci_ChangeConnectionLinkKey_In
Pointer to the hci_ChangeConnectionLinkKey_In function.
- hci_MasterLinkKey_In
Pointer to the hci_MasterLinkKey_In function.
- hci_RemoteNameRequest_In
Pointer to the hci_RemoteNameRequest_In function.
- hci_ReadRemoteSupportedFeatures_In
Pointer to the hci_ReadRemoteSupportedFeatures_In function.
- hci_ReadRemoteVersionInformation_In
Pointer to the hci_ReadRemoteVersionInformation_In function.
- hci_ReadClockOffset_In
Pointer to the hci_ReadClockOffset_In function.
- hci_HoldMode_In
Pointer to the hci_HoldMode_In function.
- hci_SniffMode_In
Pointer to the hci_SniffMode_In function.
- hci_ExitSniffMode_In
Pointer to the hci_ExitSniffMode_In function.
- hci_SSRMode_In
Pointer to the hci_SSRMode_In function.
- hci_ParkMode_In
Pointer to the hci_ParkMode_In function.
- hci_ExitParkMode_In
Pointer to the hci_ExitParkMode_In function.
- hci_QoSSetup_In
Pointer to the hci_QoSSetup_In function.
- hci_RoleDiscovery_In
Pointer to the hci_RoleDiscovery_In function.
- hci_SwitchRole_In
Pointer to the hci_SwitchRole_In function.
- hci_ReadLinkPolicySettings_In
Pointer to the hci_ReadLinkPolicySettings_In function.
- hci_WriteLinkPolicySettings_In
Pointer to the hci_WriteLinkPolicySettings_In function.
- hci_SetEventMask_In
Pointer to the hci_SetEventMask_In function.
- hci_Reset_In
Pointer to the hci_Reset_In function.
- hci_SetEventFilter_In
Pointer to the hci_SetEventFilter_In function.
- hci_Flush_In
Pointer to the hci_Flush_In function.
- hci_EnhancedFlush_In
Pointer to the hci_EnhancedFlush_In function.
- hci_ReadPINType_In
Pointer to the hci_ReadPINType_In function.
- hci_WritePINType_In
Pointer to the hci_WritePINType_In function.
- hci_CreateNewUnitKey_In
Pointer to the hci_CreateNewUnitKey_In function.
- hci_ReadStoredLinkKey_In
Pointer to the hci_ReadStoredLinkKey_In function.
- hci_WriteStoredLinkKey_In
Pointer to the hci_WriteStoredLinkKey_In function.
- hci_DeleteStoredLinkKey_In
Pointer to the hci_DeleteStoredLinkKey_In function.
- hci_ChangeLocalName_In
Pointer to the hci_ChangeLocalName_In function.
- hci_ReadLocalName_In
Pointer to the hci_ReadLocalName_In function.
- hci_ReadConnectionAcceptTimeout_In
Pointer to the hci_ReadConnectionAcceptTimeout_In function.
- hci_WriteConnectionAcceptTimeout_In
Pointer to the hci_WriteConnectionAcceptTimeout_In function.
- hci_ReadPageTimeout_In
Pointer to the hci_ReadPageTimeout_In function.
- hci_WritePageTimeout_In
Pointer to the hci_WritePageTimeout_In function.
- hci_ReadScanEnable_In
Pointer to the hci_ReadScanEnable_In function.
- hci_WriteScanEnable_In
Pointer to the hci_WriteScanEnable_In function.
- hci_ReadPageScanActivity_In
Pointer to the hci_ReadPageScanActivity_In function.
- hci_WritePageScanActivity_In
Pointer to the hci_WritePageScanActivity_In function.
- hci_ReadInquiryScanActivity_In
Pointer to the hci_ReadInquiryScanActivity_In function.
- hci_WriteInquiryScanActivity_In
Pointer to the hci_WriteInquiryScanActivity_In function.
- hci_ReadAuthenticationEnable_In
Pointer to the hci_ReadAuthenticationEnable_In function.
- hci_WriteAuthenticationEnable_In
Pointer to the hci_WriteAuthenticationEnable_In function.
- hci_ReadEncryptionMode_In
Pointer to the hci_ReadEncryptionMode_In function.
- hci_WriteEncryptionMode_In
Pointer to the hci_WriteEncryptionMode_In function.
- hci_ReadClassOfDevice_In
Pointer to the hci_ReadClassOfDevice_In function.
- hci_WriteClassOfDevice_In
Pointer to the hci_WriteClassOfDevice_In function.
- hci_ReadVoiceSetting_In
Pointer to the hci_ReadVoiceSetting_In function.
- hci_WriteVoiceSetting_In
Pointer to the hci_WriteVoiceSetting_In function.
- hci_ReadAutomaticFlushTimeout_In
Pointer to the hci_ReadAutomaticFlushTimeout_In function.
- hci_WriteAutomaticFlushTimeout_In
Pointer to the hci_WriteAutomaticFlushTimeout_In function.
- hci_ReadNumBroadcastRetransmissions_In
Pointer to the hci_ReadNumBroadcastRetransmissions_In function.
- hci_WriteNumBroadcastRetransmissions_In
Pointer to the hci_WriteNumBroadcastRetransmissions_In function.
- hci_ReadHoldModeActivity_In
Pointer to the hci_ReadHoldModeActivity_In function.
- hci_WriteHoldModeActivity_In
Pointer to the hci_WriteHoldModeActivity_In function.
- hci_ReadTransmitPowerLevel_In
Pointer to the hci_ReadTransmitPowerLevel_In function.
- hci_ReadSCOFlowControlEnable_In
Pointer to the hci_ReadSCOFlowControlEnable_In function.
- hci_WriteSCOFlowControlEnable_In
Pointer to the hci_WriteSCOFlowControlEnable_In function.
- hci_SetHostControllerToHostFlowControl_In
Pointer to the hci_SetHostControllerToHostFlowControl_In function.
- hci_HostBufferSize_In
Pointer to the hci_HostBufferSize_In function.
- hci_HostNumberOfCompletedPackets
Pointer to the hci_HostNumberOfCompletedPackets function.
- hci_ReadLinkSupervisionTimeout_In
Pointer to the hci_ReadLinkSupervisionTimeout_In function.
- hci_WriteLinkSupervisionTimeout_In
Pointer to the hci_WriteLinkSupervisionTimeout_In function.
- hci_ReadNumberOfSupportedIAC_In
Pointer to the hci_ReadNumberOfSupportedIAC_In function.
- hci_ReadCurrentIACLAP_In
Pointer to the hci_ReadCurrentIACLAP_In function.
- hci_WriteCurrentIACLAP_In
Pointer to the hci_WriteCurrentIACLAP_In function.
- hci_ReadPageScanPeriodMode_In
Pointer to the hci_ReadPageScanPeriodMode_In function.
- hci_WritePageScanPeriodMode_In
Pointer to the hci_WritePageScanPeriodMode_In function.
- hci_ReadPageScanMode_In
Pointer to the hci_ReadPageScanMode_In function.
- hci_WritePageScanMode_In
Pointer to the hci_WritePageScanMode_In function.
- hci_ReadLocalVersionInformation_In
Pointer to the hci_ReadLocalVersionInformation_In function.
- hci_ReadLocalSupportedFeatures_In
Pointer to the hci_ReadLocalSupportedFeatures_In function.
- hci_ReadBufferSize_In
Pointer to the hci_ReadBufferSize_In function.
- hci_ReadCountryCode_In
Pointer to the hci_ReadCountryCode_In function.
- hci_ReadBDADDR_In
Pointer to the hci_ReadBDADDR_In function.
- hci_ReadFailedContactCounter_In
Pointer to the hci_ReadFailedContactCounter_In function.
- hci_ResetFailedContactCounter_In
Pointer to the hci_ResetFailedContactCounter_In function.
- hci_GetLinkQuality_In
Pointer to the hci_GetLinkQuality_In function.
- hci_ReadRSSI_In
Pointer to the hci_ReadRSSI_In function.
- hci_ReadLoopbackMode_In
Pointer to the hci_ReadLoopbackMode_In function.
- hci_WriteLoopbackMode_In
Pointer to the hci_WriteLoopbackMode_In function.
- hci_EnableDeviceUnderTestMode_In
Pointer to the hci_EnableDeviceUnderTestMode_In function.
- hci_CustomCode_In
Pointer to the hci_CustomCode_In function.
- hci_DataPacketDown_In
Pointer to the hci_DataPacketDown_In function.
- hci_ioctl
Pointer to the hci_ioctl function.
- hci_AbortCall
Pointer to the hci_AbortCall function.
- hci_WritePageScanType_In
Pointer to the hci_WritePageScanType_In function. Added for version 2.
- hci_WriteInquiryScanType_In
Pointer to the hci_WriteInquiryScanType_In function. Added for version 2.
- hci_ReadPageScanType_In
Pointer to the hci_ReadPageScanType_In function. Added for version 2.
- hci_ReadInquiryScanType_In
Pointer to the hci_ReadInquiryScanType_In function. Added for version 2.
- hci_SetupSynchronousConnection_In
Pointer to the hci_SetupSynchronousConnection_In function. Added for version 2.
- hci_AcceptSynchronousConnectionRequest_In
Pointer to the hci_AcceptSynchronousConnectionRequest_In function. Added for version 2.
- hci_RejectSynchronousConnectionRequest_In
Pointer to the hci_RejectSynchronousConnectionRequest_In function. Added for version 2.
- hci_WriteExtendedInquiryResponse_In
Pointer to the hci_WriteExtendedInquiryResponse_In function. Added for version 3.
- hci_ReadExtendedInquiryResponse_In
Pointer to the hci_ReadExtendedInquiryResponse_In function. Added for version 3.
- hci_WriteInquiryMode_In
Pointer to the hci_WriteInquiryMode_In function. Added for version 3.
- hci_ReadInquiryMode_In
Pointer to the hci_ReadInquiryMode_In function. Added for version 3.
- hci_DataPacketDownEx_In
Pointer to the hci_DataPacketDownEx_In function. Added for version 3.
Remarks
This structure is an output parameter of the HCI_EstablishDeviceContext function. The private function assigned to each member depends on the implementation of HCI_EstablishDeviceContext. Not all HCI commands are implemented. Unimplemented commands are declared with NULL pointers in HCI_INTERFACE.
Each function pointer that is declared in HCI_INTERFACE takes a void pointer cookie that uniquely identifies the call context of the layer that calls the command.
Function pointers for commands are named with an _In suffix. Every _In command declared in HCI_INTERFACE has a corresponding _Out function declared in HCI_CALLBACKS. If the call to an HCI command is successfully completed, the HCI layer calls one of the callbacks provided by the upper layer. Some commands like HCI_CreateConnection raise events to inform the caller that the command execution is complete. These events are declared in the HCI_EVENT_INDICATION structure.
Requirements
Header |
bt_ddi.h |