BTD Class Reference

#include <BTD.h>

Inheritance diagram for BTD:

Collaboration diagram for BTD:

Public Member Functions
	BTD (USB *p)
void	disconnect ()
int8_t	registerServiceClass (BluetoothService *pService)
void	pairWithWiimote ()
uint8_t	readPollInterval ()
USBDeviceConfig implementation
virtual uint8_t	Init (uint8_t parent, uint8_t port, bool lowspeed)
virtual uint8_t	Release ()
virtual uint8_t	Poll ()
virtual uint8_t	GetAddress ()
virtual bool	isReady ()
UsbConfigXtracter implementation
virtual void	EndpointXtract (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep)
HCI Commands
void	HCI_Command (uint8_t *data, uint16_t nbytes)
void	hci_reset ()
void	hci_read_bdaddr ()
void	hci_read_local_version_information ()
void	hci_set_local_name (const char *name)
void	hci_write_scan_enable ()
void	hci_write_scan_disable ()
void	hci_remote_name ()
void	hci_accept_connection ()
void	hci_disconnect (uint16_t handle)
void	hci_pin_code_request_reply ()
void	hci_pin_code_negative_request_reply ()
void	hci_link_key_request_negative_reply ()
void	hci_authentication_request ()
void	hci_inquiry ()
void	hci_inquiry_cancel ()
void	hci_connect ()
void	hci_write_class_of_device ()
L2CAP Commands
void	L2CAP_Command (uint16_t handle, uint8_t *data, uint8_t nbytes, uint8_t channelLow=0x01, uint8_t channelHigh=0x00)
void	l2cap_connection_request (uint16_t handle, uint8_t rxid, uint8_t *scid, uint16_t psm)
void	l2cap_connection_response (uint16_t handle, uint8_t rxid, uint8_t *dcid, uint8_t *scid, uint8_t result)
void	l2cap_config_request (uint16_t handle, uint8_t rxid, uint8_t *dcid)
void	l2cap_config_response (uint16_t handle, uint8_t rxid, uint8_t *scid)
void	l2cap_disconnection_request (uint16_t handle, uint8_t rxid, uint8_t *dcid, uint8_t *scid)
void	l2cap_disconnection_response (uint16_t handle, uint8_t rxid, uint8_t *dcid, uint8_t *scid)
void	l2cap_information_response (uint16_t handle, uint8_t rxid, uint8_t infoTypeLow, uint8_t infoTypeHigh)

Public Attributes
bool	watingForConnection
bool	l2capConnectionClaimed
bool	sdpConnectionClaimed
bool	rfcommConnectionClaimed
const char *	btdName
const char *	btdPin
uint8_t	my_bdaddr [6]
uint16_t	hci_handle
uint8_t	disc_bdaddr [6]
uint8_t	remote_name [30]
uint8_t	hci_version
bool	connectToWii
bool	incomingWii
bool	pairWithWii
bool	motionPlusInside
bool	wiiUProController

Protected Member Functions
void	PrintEndpointDescriptor (const USB_ENDPOINT_DESCRIPTOR *ep_ptr)

Protected Attributes
USB *	pUsb
uint8_t	bAddress
EpInfo	epInfo [BTD_MAX_ENDPOINTS]
uint8_t	bConfNum
uint8_t	bNumEP
uint32_t	qNextPollTime

Static Protected Attributes
static const uint8_t	BTD_CONTROL_PIPE = 0
static const uint8_t	BTD_EVENT_PIPE = 1
static const uint8_t	BTD_DATAIN_PIPE = 2
static const uint8_t	BTD_DATAOUT_PIPE = 3

Detailed Description

The Bluetooth Dongle class will take care of all the USB communication and then pass the data to the BluetoothService classes.

Definition at line 154 of file BTD.h.

Constructor & Destructor Documentation

BTD::BTD

(

USB *

p

)

Constructor for the BTD class.

Parameters

p	Pointer to USB class instance.

Definition at line 27 of file BTD.cpp.

Member Function Documentation

uint8_t BTD::Init ( uint8_t  parent, uint8_t  port, bool  lowspeed  )

virtual

Initialize the Bluetooth dongle.

Parameters

parent	Hub number.
port	Port number on the hub.
lowspeed	Speed of the device.

Returns

0 on success.

Implements USBDeviceConfig.

Definition at line 45 of file BTD.cpp.

uint8_t BTD::Release ( )

virtual

Release the USB device.

Returns

0 on success.

Implements USBDeviceConfig.

Definition at line 300 of file BTD.cpp.

uint8_t BTD::Poll ( )

virtual

Poll the USB Input endpoins and run the state machines.

Returns

0 on success.

Implements USBDeviceConfig.

Definition at line 313 of file BTD.cpp.

virtual uint8_t BTD::GetAddress ( )

inlinevirtual

Get the device address.

Returns

The device address.

Implements USBDeviceConfig.

Definition at line 186 of file BTD.h.

virtual bool BTD::isReady ( )

inlinevirtual

Used to check if the dongle has been initialized.

Returns

True if it's ready.

Definition at line 194 of file BTD.h.

void BTD::EndpointXtract ( uint8_t  conf, uint8_t  iface, uint8_t  alt, uint8_t  proto, const USB_ENDPOINT_DESCRIPTOR *  ep  )

virtual

UsbConfigXtracter implementation, used to extract endpoint information.

Parameters

conf	Configuration value.
iface	Interface number.
alt	Alternate setting.
proto	Interface Protocol.
ep	Endpoint Descriptor.

Implements UsbConfigXtracter.

Definition at line 249 of file BTD.cpp.

void BTD::disconnect ( )

inline

Disconnects both the L2CAP Channel and the HCI Connection for all Bluetooth services.

Definition at line 212 of file BTD.h.

int8_t BTD::registerServiceClass ( BluetoothService *  pService )

inline

Register bluetooth dongle members/services.

Parameters

pService

Pointer to BluetoothService class instance.

Returns

The serice ID on succes or -1 on fail.

Definition at line 223 of file BTD.h.

void BTD::HCI_Command	(	uint8_t *	data,
		uint16_t	nbytes
	)

Used to send a HCI Command.

Parameters

data	Data to send.
nbytes	Number of bytes to send.

Definition at line 789 of file BTD.cpp.

void BTD::hci_reset

(

)

Reset the Bluetooth dongle.

Definition at line 794 of file BTD.cpp.

void BTD::hci_read_bdaddr

(

)

Read the Bluetooth address of the dongle.

Definition at line 825 of file BTD.cpp.

void BTD::hci_read_local_version_information

(

)

Read the HCI Version of the Bluetooth dongle.

Definition at line 833 of file BTD.cpp.

void BTD::hci_set_local_name

(

const char *

name

)

Set the local name of the Bluetooth dongle.

Parameters

name	Desired name.

Definition at line 876 of file BTD.cpp.

void BTD::hci_write_scan_enable

(

)

Enable visibility to other Bluetooth devices.

Definition at line 803 of file BTD.cpp.

void BTD::hci_write_scan_disable

(

)

Disable visibility to other Bluetooth devices.

Definition at line 816 of file BTD.cpp.

void BTD::hci_remote_name

(

)

Read the remote devices name.

Definition at line 857 of file BTD.cpp.

void BTD::hci_accept_connection

(

)

Accept the connection with the Bluetooth device.

Definition at line 841 of file BTD.cpp.

void BTD::hci_disconnect

(

uint16_t

handle

)

Disconnect the HCI connection.

Parameters

handle

The HCI Handle for the connection.

Definition at line 1007 of file BTD.cpp.

void BTD::hci_pin_code_request_reply

(

)

Respond with the pin for the connection. The pin is automatically set for the Wii library, but can be customized for the SPP library.

Definition at line 932 of file BTD.cpp.

void BTD::hci_pin_code_negative_request_reply

(

)

Respons when no pin was set.

Definition at line 969 of file BTD.cpp.

void BTD::hci_link_key_request_negative_reply

(

)

Command is used to reply to a Link Key Request event from the BR/EDR Controller if the Host does not have a stored Link Key for the connection.

Definition at line 983 of file BTD.cpp.

void BTD::hci_authentication_request

(

)

Used to try to authenticate with the remote device.

Definition at line 997 of file BTD.cpp.

void BTD::hci_inquiry

(

)

Start a HCI inquiry.

Definition at line 888 of file BTD.cpp.

void BTD::hci_inquiry_cancel

(

)

Cancel a HCI inquiry.

Definition at line 902 of file BTD.cpp.

void BTD::hci_connect

(

)

Connect to a device.

Definition at line 910 of file BTD.cpp.

void BTD::hci_write_class_of_device

(

)

Used to a set the class of the device.

Definition at line 1019 of file BTD.cpp.

void BTD::L2CAP_Command	(	uint16_t	handle,
		uint8_t *	data,
		uint8_t	nbytes,
		uint8_t	channelLow = 0x01,
		uint8_t	channelHigh = 0x00
	)

Used to send L2CAP Commands.

Parameters

handle	HCI Handle.
data	Data to send.
nbytes	Number of bytes to send.
channelLow,channelHigh	Low and high byte of channel to send to. If argument is omitted then the Standard L2CAP header: Channel ID (0x01) for ACL-U will be used.

Definition at line 1055 of file BTD.cpp.

void BTD::l2cap_connection_request	(	uint16_t	handle,
		uint8_t	rxid,
		uint8_t *	scid,
		uint16_t	psm
	)

L2CAP Connection Request.

Parameters

handle	HCI handle.
rxid	Identifier.
scid	Source Channel Identifier.
psm	Protocol/Service Multiplexer - see: https://www.bluetooth.org/Technical/AssignedNumbers/logical_link.htm.

Definition at line 1083 of file BTD.cpp.

void BTD::l2cap_connection_response	(	uint16_t	handle,
		uint8_t	rxid,
		uint8_t *	dcid,
		uint8_t *	scid,
		uint8_t	result
	)

L2CAP Connection Response.

Parameters

handle	HCI handle.
rxid	Identifier.
dcid	Destination Channel Identifier.
scid	Source Channel Identifier.
result	Result - First send PENDING and then SUCCESSFUL.

Definition at line 1096 of file BTD.cpp.

void BTD::l2cap_config_request	(	uint16_t	handle,
		uint8_t	rxid,
		uint8_t *	dcid
	)

L2CAP Config Request.

Parameters

handle	HCI Handle.
rxid	Identifier.
dcid	Destination Channel Identifier.

Definition at line 1113 of file BTD.cpp.

void BTD::l2cap_config_response	(	uint16_t	handle,
		uint8_t	rxid,
		uint8_t *	scid
	)

L2CAP Config Response.

Parameters

handle	HCI Handle.
rxid	Identifier.
scid	Source Channel Identifier.

Definition at line 1130 of file BTD.cpp.

void BTD::l2cap_disconnection_request	(	uint16_t	handle,
		uint8_t	rxid,
		uint8_t *	dcid,
		uint8_t *	scid
	)

L2CAP Disconnection Request.

Parameters

handle	HCI Handle.
rxid	Identifier.
dcid	Device Channel Identifier.
scid	Source Channel Identifier.

Definition at line 1149 of file BTD.cpp.

void BTD::l2cap_disconnection_response	(	uint16_t	handle,
		uint8_t	rxid,
		uint8_t *	dcid,
		uint8_t *	scid
	)

L2CAP Disconnection Response.

Parameters

handle	HCI Handle.
rxid	Identifier.
dcid	Device Channel Identifier.
scid	Source Channel Identifier.

Definition at line 1162 of file BTD.cpp.

void BTD::l2cap_information_response	(	uint16_t	handle,
		uint8_t	rxid,
		uint8_t	infoTypeLow,
		uint8_t	infoTypeHigh
	)

L2CAP Information Response.

Parameters

handle	HCI Handle.
rxid	Identifier.
infoTypeLow,infoTypeHigh	Infotype.

Definition at line 1175 of file BTD.cpp.

void BTD::pairWithWiimote ( )

inline

Call this function to pair with a Wiimote

Definition at line 385 of file BTD.h.

uint8_t BTD::readPollInterval ( )

inline

Read the poll interval taken from the endpoint descriptors.

Returns

The poll interval in ms.

Definition at line 404 of file BTD.h.

void BTD::PrintEndpointDescriptor ( const USB_ENDPOINT_DESCRIPTOR *  ep_ptr )

protected

Used to print the USB Endpoint Descriptor.

Parameters

ep_ptr

Pointer to USB Endpoint Descriptor.

Definition at line 281 of file BTD.cpp.

Member Data Documentation

bool BTD::watingForConnection

Use this to see if it is waiting for a incoming connection.

Definition at line 356 of file BTD.h.

bool BTD::l2capConnectionClaimed

This is used by the service to know when to store the device information.

Definition at line 358 of file BTD.h.

bool BTD::sdpConnectionClaimed

This is used by the SPP library to claim the current SDP incoming request.

Definition at line 360 of file BTD.h.

bool BTD::rfcommConnectionClaimed

This is used by the SPP library to claim the current RFCOMM incoming request.

Definition at line 362 of file BTD.h.

const char* BTD::btdName

The name you wish to make the dongle show up as. It is set automatically by the SPP library.

Definition at line 365 of file BTD.h.

const char* BTD::btdPin

The pin you wish to make the dongle use for authentication. It is set automatically by the SPP library.

Definition at line 367 of file BTD.h.

uint8_t BTD::my_bdaddr[6]

The bluetooth dongles Bluetooth address.

Definition at line 370 of file BTD.h.

uint16_t BTD::hci_handle

HCI handle for the last connection.

Definition at line 372 of file BTD.h.

uint8_t BTD::disc_bdaddr[6]

Last incoming devices Bluetooth address.

Definition at line 374 of file BTD.h.

uint8_t BTD::remote_name[30]

First 30 chars of last remote name.

Definition at line 376 of file BTD.h.

uint8_t BTD::hci_version

The supported HCI Version read from the Bluetooth dongle. Used by the PS3BT library to check the HCI Version of the Bluetooth dongle, it should be at least 3 to work properly with the library.

Definition at line 382 of file BTD.h.

bool BTD::connectToWii

Used to only send the ACL data to the wiimote.

Definition at line 388 of file BTD.h.

bool BTD::incomingWii

True if a Wiimote is connecting.

Definition at line 392 of file BTD.h.

bool BTD::pairWithWii

True when it should pair with the incoming Wiimote.

Definition at line 394 of file BTD.h.

bool BTD::motionPlusInside

True if it's the new Wiimote with the Motion Plus Inside or a Wii U Pro Controller.

Definition at line 396 of file BTD.h.

bool BTD::wiiUProController

True if it's a Wii U Pro Controller.

Definition at line 398 of file BTD.h.

USB* BTD::pUsb

protected

Pointer to USB class instance.

Definition at line 406 of file BTD.h.

uint8_t BTD::bAddress

protected

Device address.

Definition at line 412 of file BTD.h.

EpInfo BTD::epInfo[BTD_MAX_ENDPOINTS]

protected

Endpoint info structure.

Definition at line 414 of file BTD.h.

uint8_t BTD::bConfNum

protected

Configuration number.

Definition at line 417 of file BTD.h.

uint8_t BTD::bNumEP

protected

Total number of endpoints in the configuration.

Definition at line 419 of file BTD.h.

uint32_t BTD::qNextPollTime

protected

Next poll time based on poll interval taken from the USB descriptor.

Definition at line 421 of file BTD.h.

const uint8_t BTD::BTD_CONTROL_PIPE = 0

staticprotected

Bluetooth dongle control endpoint.

Definition at line 424 of file BTD.h.

const uint8_t BTD::BTD_EVENT_PIPE = 1

staticprotected

HCI event endpoint index.

Definition at line 426 of file BTD.h.

const uint8_t BTD::BTD_DATAIN_PIPE = 2

staticprotected

ACL In endpoint index.

Definition at line 428 of file BTD.h.

const uint8_t BTD::BTD_DATAOUT_PIPE = 3

staticprotected

ACL Out endpoint index.

Definition at line 430 of file BTD.h.

---

The documentation for this class was generated from the following files:

• BTD.h
• BTD.cpp