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

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

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
index fa30524..4de49b3 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
@@ -56,28 +56,36 @@
                #define MAXIMUM_CHANNEL_MTU                      255\r
                \r
        /* Enums: */\r
+               /** Enum for the possible states for a bluetooth ACL channel. */\r
                enum BT_ChannelStates_t\r
                {\r
-                       Channel_Closed                = 0,\r
-                       Channel_WaitConnect           = 1,\r
-                       Channel_WaitConnectRsp        = 2,\r
-                       Channel_Config_WaitConfig     = 3,\r
-                       Channel_Config_WaitSendConfig = 4,\r
-                       Channel_Config_WaitReqResp    = 5,\r
-                       Channel_Config_WaitResp       = 6,\r
-                       Channel_Config_WaitReq        = 7,\r
-                       Channel_Open                  = 8,\r
-                       Channel_WaitDisconnect        = 9,\r
+                       Channel_Closed                = 0, /**< Channel is closed and inactive. No data may be sent or received. */\r
+                       Channel_WaitConnect           = 1, /**< A connection request has been received, but a response has not been sent. */\r
+                       Channel_WaitConnectRsp        = 2, /**< A connection request has been sent, but a response has not been received. */\r
+                       Channel_Config_WaitConfig     = 3, /**< Channel has been connected, but not yet configured on either end. */\r
+                       Channel_Config_WaitSendConfig = 4, /**< Channel configuration has been received and accepted, but not yet sent. */\r
+                       Channel_Config_WaitReqResp    = 5, /**< Channel configuration has been sent but not responded to, and a configuration\r
+                                                               request from the remote end has not yet been received. */\r
+                       Channel_Config_WaitResp       = 6, /**< Channel configuration has been sent but not accepted, but a configuration request\r
+                                                               from the remote end has been accepted. */\r
+                       Channel_Config_WaitReq        = 7, /**< Channel configuration has been sent and accepted, but a configuration request\r
+                                                               from the remote end has not yet been accepted. */\r
+                       Channel_Open                  = 8, /**< Channel is open and ready to send or receive data */\r
+                       Channel_WaitDisconnect        = 9, /**< A disconnection request has been sent, but not yet acknowledged. */\r
                };\r
 \r
-               enum Endpoint_ControlStream_RW_ErrorCodes_t\r
+               /** Enum for the possible error codes returned by the \ref Bluetooth_SendPacket() function. */\r
+               enum BT_SendPacket_ErrorCodes_t\r
                {\r
-                       BT_SENDPACKET_NoError            = 0,\r
-                       BT_SENDPACKET_NotConnected       = 1,\r
-                       BT_SENDPACKET_ChannelNotOpen     = 2,\r
+                       BT_SENDPACKET_NoError            = 0, /**< The packet was sent sucessfully. */\r
+                       BT_SENDPACKET_NotConnected       = 1, /**< The bluetooth stack is not currently connected to a remote device. */\r
+                       BT_SENDPACKET_ChannelNotOpen     = 2, /**< The given channel is not currently in the Open state. */\r
                };\r
 \r
        /* Type Defines: */\r
+               /** Type define for a Bluetooth ACL channel information structure. This structure contains all the relevent\r
+                *  information on an ACL channel for data transmission and reception by the stack.\r
+                */\r
                typedef struct\r
                {\r
                        uint8_t  State;\r
@@ -88,6 +96,9 @@
                        uint16_t RemoteMTU;\r
                } Bluetooth_Channel_t;\r
 \r
+               /** Type define for a Bluetooth device connection information structure. This structure contains all the\r
+                *  information needed to maintain a connection to a remote Bluetooth device via the Bluetooth stack.\r
+                */\r
                typedef struct\r
                {\r
                        bool                IsConnected;\r
@@ -97,6 +108,7 @@
                        uint8_t             SignallingIdentifier;\r
                } Bluetooth_Connection_t;\r
                \r
+               /** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */\r
                typedef struct\r
                {\r
                        uint32_t Class;\r