Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

[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 4de49b3..564a2ba 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
@@ -34,26 +34,24 @@
        /* Includes: */\r
                #include <LUFA/Drivers/USB/USB.h>\r
                \r
        /* Includes: */\r
                #include <LUFA/Drivers/USB/USB.h>\r
                \r

-               #include "BluetoothHost.h"\r
-               \r

        /* Macros: */\r
        /* Macros: */\r

-               #define BLUETOOTH_DATA_IN_PIPE                   1\r
-               #define BLUETOOTH_DATA_OUT_PIPE                  2\r
-               #define BLUETOOTH_EVENTS_PIPE                    3\r
+               #define BLUETOOTH_DATA_IN_PIPE         1\r
+               #define BLUETOOTH_DATA_OUT_PIPE        2\r
+               #define BLUETOOTH_EVENTS_PIPE          3\r

 \r
 \r

-               #define BLUETOOTH_MAX_OPEN_CHANNELS              6\r
+               #define BLUETOOTH_MAX_OPEN_CHANNELS    6\r

                \r
                \r

-               #define CHANNEL_PSM_SERVICEDISCOVERY             0x0001\r
-               #define CHANNEL_PSM_UDP                          0x0002\r
-               #define CHANNEL_PSM_RFCOMM                       0x0003\r
-               #define CHANNEL_PSM_TCP                          0x0004\r
-               #define CHANNEL_PSM_IP                           0x0009\r
-               #define CHANNEL_PSM_FTP                          0x000A\r
-               #define CHANNEL_PSM_HTTP                         0x000C\r
-               #define CHANNEL_PSM_UPNP                         0x0010\r
-               #define CHANNEL_PSM_HIDP                         0x0011\r
+               #define CHANNEL_PSM_SDP                0x0001\r
+               #define CHANNEL_PSM_UDP                0x0002\r
+               #define CHANNEL_PSM_RFCOMM             0x0003\r
+               #define CHANNEL_PSM_TCP                0x0004\r
+               #define CHANNEL_PSM_IP                 0x0009\r
+               #define CHANNEL_PSM_FTP                0x000A\r
+               #define CHANNEL_PSM_HTTP               0x000C\r
+               #define CHANNEL_PSM_UPNP               0x0010\r
+               #define CHANNEL_PSM_HIDP               0x0011\r

                \r
                \r

-               #define MAXIMUM_CHANNEL_MTU                      255\r
+               #define MAXIMUM_CHANNEL_MTU            255\r

                \r
        /* Enums: */\r
                /** Enum for the possible states for a bluetooth ACL channel. */\r
                \r
        /* Enums: */\r
                /** Enum for the possible states for a bluetooth ACL channel. */\r


@@ -101,19 +99,21 @@
                 */\r
                typedef struct\r
                {\r
                 */\r
                typedef struct\r
                {\r

-                       bool                IsConnected;\r
-                       uint16_t            ConnectionHandle;\r
-                       uint8_t             RemoteAddress[6];\r
-                       Bluetooth_Channel_t Channels[BLUETOOTH_MAX_OPEN_CHANNELS];\r
-                       uint8_t             SignallingIdentifier;\r
+                       bool                IsConnected; /**< Indicates if the stack is currently connected to a remote device - if this value is\r
+                                                         *   false, the remaining elements are invalid.\r
+                                                                                         */\r
+                       uint16_t            ConnectionHandle; /**< Connection handle to the remote device, used internally in the stack. */\r
+                       uint8_t             RemoteAddress[6]; /**< Bluetooth device address of the attached remote device. */\r
+                       Bluetooth_Channel_t Channels[BLUETOOTH_MAX_OPEN_CHANNELS]; /**< Channel information structures for the connection. */\r
+                       uint8_t             SignallingIdentifier; /**< Next Signalling Channel unique command sequence identifier. */\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
                } 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
-                       char     PINCode[16];\r
-                       char     Name[];\r
+                       uint32_t Class; /**< Class of the local device, a mask of DEVICE_CLASS_* masks. */\r
+                       char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */\r
+                       char     Name[]; /**< Name of the local bluetooth device, up to 248 characters. */\r

                } Bluetooth_Device_t;\r
        \r
        /* Includes: */\r
                } Bluetooth_Device_t;\r
        \r
        /* Includes: */\r


@@ -127,7 +127,7 @@
                bool                 Bluetooth_ConnectionRequest(uint8_t* RemoteAddress);\r
                void                 Bluetooth_ConnectionComplete(void);\r
                void                 Bluetooth_DisconnectionComplete(void);\r
                bool                 Bluetooth_ConnectionRequest(uint8_t* RemoteAddress);\r
                void                 Bluetooth_ConnectionComplete(void);\r
                void                 Bluetooth_DisconnectionComplete(void);\r

-               void                 Bluetooth_PacketReceived(uint16_t* PacketLength, Bluetooth_Channel_t* Channel);\r
+               void                 Bluetooth_PacketReceived(void* Data, uint16_t DataLen, Bluetooth_Channel_t* Channel);\r

                Bluetooth_Channel_t* Bluetooth_GetChannelData(uint16_t ChannelNumber, bool SearchByRemoteChannel);\r
                Bluetooth_Channel_t* Bluetooth_OpenChannel(uint16_t PSM);\r
                void                 Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel);\r
                Bluetooth_Channel_t* Bluetooth_GetChannelData(uint16_t ChannelNumber, bool SearchByRemoteChannel);\r
                Bluetooth_Channel_t* Bluetooth_OpenChannel(uint16_t PSM);\r
                void                 Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel);\r