Add some more documentation to the half-completed Bluetooth Host demo, fix the OpenCh...

[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / Lib / BluetoothStack.c

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.c b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.c
index ec1f637..d990ba0 100644 (file)
--- 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"\r
        };\r
 \r
+/** Bluetooth stack initialization function. This function must be called once to initialize the Bluetooth stack,\r
+ *  ready for connection to remote devices.\r
+ *\r
+ *  \note This function only begins the initialization process; the stack is initialized as the main Bluetooth stack\r
+ *        management task is repeatedly called. The initialization process ends when the \ref Bluetooth_HCIProcessingState\r
+ *        global enters the Bluetooth_ProcessEvents state.\r
+ */\r
 void Bluetooth_Stack_Init(void)\r
 {\r
+       /* Reset the HCI state machine - this will eventually reset the adapter and stack when the Bluetooth stack task is called */\r
        Bluetooth_HCIProcessingState = Bluetooth_Init;\r
 }\r
 \r
+/** Bluetooth stack management task. This task must be repeatedly called to maintain the Bluetooth stack and any connection\r
+ *  to remote Bluetooth devices, including both the HCI control layer and the ACL channel layer.\r
+ */\r
 void Bluetooth_Stack_USBTask(void)\r
 {\r
        Bluetooth_HCITask();\r
        Bluetooth_ACLTask();\r
 }\r
 \r
+/** Retrieves the channel information structure with the given local or remote channel number from the channel list.\r
+ *\r
+ *  \param ChannelNumber          Channel number to search for in the channel list\r
+ *  \param SearchByRemoteChannel  Indicated whether to search for a channel information structure by the given remote channel\r
+ *                                or local channel number\r
+ *\r
+ *  \return Pointer to the matching channel information structure in the channel table if found, NULL otherwise\r
+ */\r
 Bluetooth_Channel_t* Bluetooth_GetChannelData(uint16_t ChannelNumber, bool SearchByRemoteChannel)\r
 {\r
        for (uint8_t i = 0; i < BLUETOOTH_MAX_OPEN_CHANNELS; i++)\r
        {\r
                Bluetooth_Channel_t* ChannelData = &Bluetooth_Connection.Channels[i];\r
        \r
-               uint16_t CurrentChannelNumber = (SearchByRemoteChannel) ? ChannelData->RemoteNumber : ChannelData->LocalNumber;\r
+               /* Fetch the channel number that is to be matched against from the current channel information struct */\r
+               uint16_t SearchChannelNumber = (SearchByRemoteChannel) ? ChannelData->RemoteNumber : ChannelData->LocalNumber;\r
        \r
-               if (CurrentChannelNumber == ChannelNumber)\r
+               if (SearchChannelNumber == ChannelNumber)\r
                  return ChannelData;\r
        }\r
 \r