Add some more documentation to the half-completed Bluetooth Host demo, fix the OpenChannel() command initialising the channel information structure to the wrong initial state once the CONNECTION REQUEST command has been sent to the remote device.

1 files changed, 22 insertions, 2 deletions

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.c b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.c
index ec1f637d7..d990ba02e 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.c
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.c
@@ -43,26 +43,46 @@ Bluetooth_Device_t Bluetooth_DeviceConfiguration =
 		Name:    "LUFA Bluetooth Demo"

 	};

 

+/** Bluetooth stack initialization function. This function must be called once to initialize the Bluetooth stack,

+ *  ready for connection to remote devices.

+ *

+ *  \note This function only begins the initialization process; the stack is initialized as the main Bluetooth stack

+ *        management task is repeatedly called. The initialization process ends when the \ref Bluetooth_HCIProcessingState

+ *        global enters the Bluetooth_ProcessEvents state.

+ */

 void Bluetooth_Stack_Init(void)

 {

+	/* Reset the HCI state machine - this will eventually reset the adapter and stack when the Bluetooth stack task is called */

 	Bluetooth_HCIProcessingState = Bluetooth_Init;

 }

 

+/** Bluetooth stack management task. This task must be repeatedly called to maintain the Bluetooth stack and any connection

+ *  to remote Bluetooth devices, including both the HCI control layer and the ACL channel layer.

+ */

 void Bluetooth_Stack_USBTask(void)

 {

 	Bluetooth_HCITask();

 	Bluetooth_ACLTask();

 }

 

+/** Retrieves the channel information structure with the given local or remote channel number from the channel list.

+ *

+ *  \param ChannelNumber          Channel number to search for in the channel list

+ *  \param SearchByRemoteChannel  Indicated whether to search for a channel information structure by the given remote channel

+ *                                or local channel number

+ *

+ *  \return Pointer to the matching channel information structure in the channel table if found, NULL otherwise

+ */

 Bluetooth_Channel_t* Bluetooth_GetChannelData(uint16_t ChannelNumber, bool SearchByRemoteChannel)

 {

 	for (uint8_t i = 0; i < BLUETOOTH_MAX_OPEN_CHANNELS; i++)

 	{

 		Bluetooth_Channel_t* ChannelData = &Bluetooth_Connection.Channels[i];

 	

-		uint16_t CurrentChannelNumber = (SearchByRemoteChannel) ? ChannelData->RemoteNumber : ChannelData->LocalNumber;

+		/* Fetch the channel number that is to be matched against from the current channel information struct */

+		uint16_t SearchChannelNumber = (SearchByRemoteChannel) ? ChannelData->RemoteNumber : ChannelData->LocalNumber;

 	

-		if (CurrentChannelNumber == ChannelNumber)

+		if (SearchChannelNumber == ChannelNumber)

 		  return ChannelData;

 	}