Minor documentation enhancements.

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

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.h b/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.h
index 8d44c18..7b74f4f 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.h
@@ -47,15 +47,17 @@
                #include <LUFA/Drivers/Peripheral/SerialStream.h>
 
                #include "BluetoothStack.h"
                #include <LUFA/Drivers/Peripheral/SerialStream.h>
 
                #include "BluetoothStack.h"

+               #include "RFCOMMControl.h"

                
        /* Macros: */
                #define BT_RFCOMM_DEBUG(l, s, ...)              do { if (RFCOMM_DEBUG_LEVEL >= l) printf_P(PSTR("(RFCOMM) " s "\r\n"), ##__VA_ARGS__); } while (0)
                
        /* Macros: */
                #define BT_RFCOMM_DEBUG(l, s, ...)              do { if (RFCOMM_DEBUG_LEVEL >= l) printf_P(PSTR("(RFCOMM) " s "\r\n"), ##__VA_ARGS__); } while (0)

-               #define RFCOMM_DEBUG_LEVEL                      2
+               #define RFCOMM_DEBUG_LEVEL                      0

                
                #define FRAME_POLL_FINAL                        (1 << 4)
                
                #define RFCOMM_CONTROL_DLCI                     0
                
                #define FRAME_POLL_FINAL                        (1 << 4)
                
                #define RFCOMM_CONTROL_DLCI                     0

-       
+               #define RFCOMM_MAX_OPEN_CHANNELS                5
+

        /* Enums: */
                /** Enum for the types of RFCOMM frames which can be exchanged on a Bluetooth channel. */
                enum RFCOMM_Frame_Types_t
        /* Enums: */
                /** Enum for the types of RFCOMM frames which can be exchanged on a Bluetooth channel. */
                enum RFCOMM_Frame_Types_t


@@ -67,57 +69,81 @@
                        RFCOMM_Frame_UIH   = 0xEF, /**< Unnumbered Information with Header check Field */
                };
                
                        RFCOMM_Frame_UIH   = 0xEF, /**< Unnumbered Information with Header check Field */
                };
                

-               enum RFCOMM_Control_Commands_t
+               enum RFCOMM_Channel_States_t

                {
                {

-                       RFCOMM_Control_Test                    = (0x20 >> 2),
-                       RFCOMM_Control_FlowControlEnable       = (0xA0 >> 2),
-                       RFCOMM_Control_FlowControlDisable      = (0x60 >> 2),
-                       RFCOMM_Control_ModemStatus             = (0xE0 >> 2),
-                       RFCOMM_Control_RemotePortNegotiation   = (0x90 >> 2),
-                       RFCOMM_Control_RemoteLineStatus        = (0x50 >> 2),
-                       RFCOMM_Control_DLCParameterNegotiation = (0x80 >> 2),
-                       RFCOMM_Control_NonSupportedCommand     = (0x10 >> 2),
+                       RFCOMM_Channel_Closed      = 0,
+                       RFCOMM_Channel_Configure   = 1,
+                       RFCOMM_Channel_Open        = 2,

                };
                };

-       
+               

        /* Type Defines: */
                typedef struct
                {
        /* Type Defines: */
                typedef struct
                {

-                       unsigned char EA   : 1;
-                       unsigned char CR   : 1;
-                       unsigned char DLCI : 6;
-               } RFCOMM_Address_t;
-       
-               typedef struct
-               {
-                       RFCOMM_Address_t Address;
-                       uint8_t          Control;
-               } RFCOMM_Header_t;
+                       uint8_t  DLCI;
+                       uint8_t  State;
+                       uint8_t  Priority;
+                       uint16_t MTU;
+                       uint8_t  ConfigFlags;
+                       struct
+                       {
+                               uint8_t Signals;
+                               uint8_t BreakSignal;
+                       } Remote;
+                       struct
+                       {
+                               uint8_t Signals;
+                               uint8_t BreakSignal;
+                       } Local;
+               } RFCOMM_Channel_t;

                
                

-               typedef struct
-               {
-                       unsigned char EA      : 1;
-                       unsigned char CR      : 1;
-                       unsigned char Command : 6;
-               } RFCOMM_Command_t;             
+       /* External Variables: */
+               extern RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS];

 
        /* Function Prototypes: */
 
        /* Function Prototypes: */

-               void RFCOMM_Initialize(void);
-               void RFCOMM_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);
+               void              RFCOMM_Initialize(void);
+               void              RFCOMM_ServiceChannels(Bluetooth_Channel_t* const ACLChannel);
+               void              RFCOMM_ProcessPacket(void* Data,
+                                                      Bluetooth_Channel_t* const ACLChannel);

                
                

+               void              RFCOMM_SendChannelSignals(const RFCOMM_Channel_t* const RFCOMMChannel,
+                                                           Bluetooth_Channel_t* const ACLChannel);
+               void              RFCOMM_SendData(const uint16_t DataLen,
+                                                 const uint8_t* Data,
+                                                 const RFCOMM_Channel_t* const RFCOMMChannel,
+                                                 Bluetooth_Channel_t* const ACLChannel);
+
+               void              RFCOMM_ChannelOpened(RFCOMM_Channel_t* const RFCOMMChannel);
+               void              RFCOMM_DataReceived(RFCOMM_Channel_t* const RFCOMMChannel,
+                                                     uint16_t DataLen,
+                                                     const uint8_t* Data);
+               void              RFCOMM_ChannelSignalsReceived(RFCOMM_Channel_t* const RFCOMMChannel);
+
+               RFCOMM_Channel_t* RFCOMM_GetFreeChannelEntry(const uint8_t DLCI);
+               RFCOMM_Channel_t* RFCOMM_GetChannelData(const uint8_t DLCI);
+               uint16_t          RFCOMM_GetVariableFieldValue(const uint8_t** BufferPos);
+               void              RFCOMM_SendFrame(const uint8_t DLCI,
+                                                  const bool CommandResponse,
+                                                  const uint8_t Control,
+                                                      const uint16_t DataLen,
+                                                  const void* Data,
+                                                  Bluetooth_Channel_t* const ACLChannel);
+

                #if defined(INCLUDE_FROM_RFCOMM_C)
                #if defined(INCLUDE_FROM_RFCOMM_C)

-                       static void RFCOMM_ProcessDM(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
-                       static void RFCOMM_ProcessDISC(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
-                       static void RFCOMM_ProcessSABM(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
-                       static void RFCOMM_ProcessUA(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
-                       static void RFCOMM_ProcessUIH(const RFCOMM_Address_t* const FrameAddress, const uint16_t FrameLength, 
-                                          const uint8_t* FrameData, Bluetooth_Channel_t* const Channel);
+                       static uint8_t RFCOMM_GetFCSValue(const void* FrameStart,
+                                                         uint8_t Length);

 
 

-                       static void RFCOMM_ProcessControlCommand(const RFCOMM_Command_t* CommandHeader, Bluetooth_Channel_t* const Channel);
-                       
-                       static void RFCOMM_SendFrame(const uint8_t DLCI, const bool CommandResponse, const uint8_t Control,
-                                                    const uint16_t DataLen, const void* Data, Bluetooth_Channel_t* const Channel);
-                       static uint8_t  RFCOMM_GetFCSValue(const void* FrameStart, uint8_t Length);
-                       static uint16_t RFCOMM_GetFrameDataLength(const uint8_t* const BufferPos);
+                       static void RFCOMM_ProcessDM(const RFCOMM_Address_t* const FrameAddress,
+                                                    Bluetooth_Channel_t* const ACLChannel);
+                       static void RFCOMM_ProcessDISC(const RFCOMM_Address_t* const FrameAddress,
+                                                      Bluetooth_Channel_t* const ACLChannel);
+                       static void RFCOMM_ProcessSABM(const RFCOMM_Address_t* const FrameAddress,
+                                                      Bluetooth_Channel_t* const ACLChannel);
+                       static void RFCOMM_ProcessUA(const RFCOMM_Address_t* const FrameAddress,
+                                                    Bluetooth_Channel_t* const ACLChannel);
+                       static void RFCOMM_ProcessUIH(const RFCOMM_Address_t* const FrameAddress,
+                                                     const uint16_t FrameLength, 
+                                          const uint8_t* FrameData,
+                                                     Bluetooth_Channel_t* const ACLChannel);

                #endif
                
 #endif
                #endif
                
 #endif