projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Minor documentation fixes.
[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 131c4aa..8e515a5 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -38,14 +38,12 @@
 
        /* Includes: */
                #include <LUFA/Drivers/USB/USB.h>
 
        /* Includes: */
                #include <LUFA/Drivers/USB/USB.h>
-               
-       /* Macros: */
-               #define BLUETOOTH_DATA_IN_PIPE         1
-               #define BLUETOOTH_DATA_OUT_PIPE        2
-               #define BLUETOOTH_EVENTS_PIPE          3
 
 
+               #include "../ConfigDescriptor.h"
+
+       /* Macros: */
                #define BLUETOOTH_MAX_OPEN_CHANNELS    6
                #define BLUETOOTH_MAX_OPEN_CHANNELS    6
-               
+
                #define CHANNEL_PSM_SDP                0x0001
                #define CHANNEL_PSM_UDP                0x0002
                #define CHANNEL_PSM_RFCOMM             0x0003
                #define CHANNEL_PSM_SDP                0x0001
                #define CHANNEL_PSM_UDP                0x0002
                #define CHANNEL_PSM_RFCOMM             0x0003
@@ -55,13 +53,13 @@
                #define CHANNEL_PSM_HTTP               0x000C
                #define CHANNEL_PSM_UPNP               0x0010
                #define CHANNEL_PSM_HIDP               0x0011
                #define CHANNEL_PSM_HTTP               0x000C
                #define CHANNEL_PSM_UPNP               0x0010
                #define CHANNEL_PSM_HIDP               0x0011
-               
+
                #define CHANNEL_SEARCH_LOCALNUMBER     0
                #define CHANNEL_SEARCH_REMOTENUMBER    1
                #define CHANNEL_SEARCH_PSM             2
                #define CHANNEL_SEARCH_LOCALNUMBER     0
                #define CHANNEL_SEARCH_REMOTENUMBER    1
                #define CHANNEL_SEARCH_PSM             2
-               
+
                #define MAXIMUM_CHANNEL_MTU            255
                #define MAXIMUM_CHANNEL_MTU            255
-               
+
        /* Enums: */
                /** Enum for the possible states for a Bluetooth ACL channel. */
                enum BT_ChannelStates_t
        /* Enums: */
                /** Enum for the possible states for a Bluetooth ACL channel. */
                enum BT_ChannelStates_t
@@ -87,13 +85,13 @@
                /** Enum for the possible error codes returned by the \ref Bluetooth_SendPacket() function. */
                enum BT_SendPacket_ErrorCodes_t
                {
                /** Enum for the possible error codes returned by the \ref Bluetooth_SendPacket() function. */
                enum BT_SendPacket_ErrorCodes_t
                {
-                       BT_SENDPACKET_NoError            = 0, /**< The packet was sent sucessfully. */
+                       BT_SENDPACKET_NoError            = 0, /**< The packet was sent successfully. */
                        BT_SENDPACKET_NotConnected       = 1, /**< The Bluetooth stack is not currently connected to a remote device. */
                        BT_SENDPACKET_ChannelNotOpen     = 2, /**< The given channel is not currently in the Open state. */
                };
 
        /* Type Defines: */
                        BT_SENDPACKET_NotConnected       = 1, /**< The Bluetooth stack is not currently connected to a remote device. */
                        BT_SENDPACKET_ChannelNotOpen     = 2, /**< The given channel is not currently in the Open state. */
                };
 
        /* Type Defines: */
-               /** Type define for a Bluetooth ACL channel information structure. This structure contains all the relevent
+               /** Type define for a Bluetooth ACL channel information structure. This structure contains all the relevant
                 *  information on an ACL channel for data transmission and reception by the stack.
                 */
                typedef struct
                 *  information on an ACL channel for data transmission and reception by the stack.
                 */
                typedef struct
@@ -117,9 +115,9 @@
                        uint16_t            ConnectionHandle; /**< Connection handle to the remote device, used internally in the stack. */
                        uint8_t             RemoteAddress[6]; /**< Bluetooth device address of the attached remote device. */
                        Bluetooth_Channel_t Channels[BLUETOOTH_MAX_OPEN_CHANNELS]; /**< Channel information structures for the connection. */
                        uint16_t            ConnectionHandle; /**< Connection handle to the remote device, used internally in the stack. */
                        uint8_t             RemoteAddress[6]; /**< Bluetooth device address of the attached remote device. */
                        Bluetooth_Channel_t Channels[BLUETOOTH_MAX_OPEN_CHANNELS]; /**< Channel information structures for the connection. */
-                       uint8_t             SignallingIdentifier; /**< Next Signalling Channel unique command sequence identifier. */
+                       uint8_t             SignalingIdentifier; /**< Next Signaling Channel unique command sequence identifier. */
                } Bluetooth_Connection_t;
                } Bluetooth_Connection_t;
-               
+
                /** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */
                typedef struct
                {
                /** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */
                typedef struct
                {
@@ -127,7 +125,7 @@
                        char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */
                        char     Name[]; /**< Name of the local Bluetooth device, up to 248 characters. */
                } Bluetooth_Device_t;
                        char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */
                        char     Name[]; /**< Name of the local Bluetooth device, up to 248 characters. */
                } Bluetooth_Device_t;
-               
+
                /** Bluetooth stack state information structure, for the containment of the Bluetooth stack state. The values in
                 *  this structure are set by the Bluetooth stack internally, and should all be treated as read only by the user
                 *  application.
                /** Bluetooth stack state information structure, for the containment of the Bluetooth stack state. The values in
                 *  this structure are set by the Bluetooth stack internally, and should all be treated as read only by the user
                 *  application.
@@ -141,12 +139,12 @@
                                                */
                        uint8_t LocalBDADDR[6]; /**< Local Bluetooth adapter's BDADDR, valid when the stack is fully initialized. */
                } Bluetooth_Stack_State_t;
                                                */
                        uint8_t LocalBDADDR[6]; /**< Local Bluetooth adapter's BDADDR, valid when the stack is fully initialized. */
                } Bluetooth_Stack_State_t;
-       
+
        /* Includes: */
                #include "BluetoothHCICommands.h"
        /* Includes: */
                #include "BluetoothHCICommands.h"
-               #include "BluetoothACLPackets.h"                
-               
-       /* Function Prototypes: */              
+               #include "BluetoothACLPackets.h"
+
+       /* Function Prototypes: */
                void Bluetooth_Stack_Init(void);
                void Bluetooth_Stack_USBTask(void);
 
                void Bluetooth_Stack_Init(void);
                void Bluetooth_Stack_USBTask(void);
 
@@ -155,11 +153,17 @@
                void                 Bluetooth_ConnectionComplete(void);
                void                 Bluetooth_DisconnectionComplete(void);
                bool                 Bluetooth_ChannelConnectionRequest(const uint16_t PSM);
                void                 Bluetooth_ConnectionComplete(void);
                void                 Bluetooth_DisconnectionComplete(void);
                bool                 Bluetooth_ChannelConnectionRequest(const uint16_t PSM);
-               void                 Bluetooth_PacketReceived(void* Data, uint16_t DataLen, Bluetooth_Channel_t* const Channel);
-               Bluetooth_Channel_t* Bluetooth_GetChannelData(const uint16_t SearchValue, const uint8_t SearchKey);
+               void                 Bluetooth_PacketReceived(void* Data, uint16_t DataLen,
+                                                             Bluetooth_Channel_t* const ACLChannel);
+               void                 Bluetooth_ChannelOpened(Bluetooth_Channel_t* const ACLChannel);
+
+               Bluetooth_Channel_t* Bluetooth_GetChannelData(const uint16_t SearchValue,
+                                                             const uint8_t SearchKey);
                Bluetooth_Channel_t* Bluetooth_OpenChannel(const uint16_t PSM);
                Bluetooth_Channel_t* Bluetooth_OpenChannel(const uint16_t PSM);
-               void                 Bluetooth_CloseChannel(Bluetooth_Channel_t* const Channel);
-               uint8_t              Bluetooth_SendPacket(void* Data, uint16_t DataLen, Bluetooth_Channel_t* const Channel);
+               void                 Bluetooth_CloseChannel(Bluetooth_Channel_t* const ACLChannel);
+               uint8_t              Bluetooth_SendPacket(void* Data,
+                                                         uint16_t DataLen,
+                                                         Bluetooth_Channel_t* const ACLChannel);
 
        /* External Variables: */
                extern Bluetooth_Device_t      Bluetooth_DeviceConfiguration;
 
        /* External Variables: */
                extern Bluetooth_Device_t      Bluetooth_DeviceConfiguration;
@@ -167,3 +171,4 @@
                extern Bluetooth_Stack_State_t Bluetooth_State;
 
 #endif
                extern Bluetooth_Stack_State_t Bluetooth_State;
 
 #endif
+
USB isp AVR programmer