Improve commenting of the Dataflash stub board driver file, to prevent confusion...

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

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.c b/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.c
index e69a27e..e0446c0 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.c
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.c
@@ -61,85 +61,169 @@ const uint8_t CRC8_Table[256] PROGMEM =
                0xB4, 0x25, 0x57, 0xC6, 0xB3, 0x22, 0x50, 0xC1, 0xBA, 0x2B, 0x59, 0xC8, 0xBD, 0x2C, 0x5E, 0xCF
        };
 
                0xB4, 0x25, 0x57, 0xC6, 0xB3, 0x22, 0x50, 0xC1, 0xBA, 0x2B, 0x59, 0xC8, 0xBD, 0x2C, 0x5E, 0xCF
        };
 

+/** RFCOMM channel state structure, to retain information about each open channel in the RFCOMM multiplexer. */
+RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS];
+
+

 /** Initializes the RFCOMM service, ready for new connections from a SDP client. */
 void RFCOMM_Initialize(void)
 {
 /** Initializes the RFCOMM service, ready for new connections from a SDP client. */
 void RFCOMM_Initialize(void)
 {

-       /* Not currently used */
+       /* Reset the RFCOMM channel structures, to invalidate any confiured RFCOMM channels */
+       for (uint8_t i = 0; i < RFCOMM_MAX_OPEN_CHANNELS; i++)
+         RFCOMM_Channels[i].State = RFCOMM_Channel_Closed;
+}
+
+void RFCOMM_ServiceChannels(Bluetooth_Channel_t* const BluetoothChannel)
+{
+       for (uint8_t i = 0; i < RFCOMM_MAX_OPEN_CHANNELS; i++)
+       {
+               RFCOMM_Channel_t* RFCOMMChannel = &RFCOMM_Channels[i];
+
+               if (RFCOMMChannel->State == RFCOMM_Channel_Configure)
+               {
+                       /* Check if the local signals have not yet been sent on the current channel */
+                       if (!(RFCOMMChannel->ConfigFlags & RFCOMM_CONFIG_LOCALSIGNALSSENT))
+                       {
+                               /* Indicate that the local signals have been sent, transmit them to the remote device */
+                               RFCOMMChannel->ConfigFlags |= RFCOMM_CONFIG_LOCALSIGNALSSENT;
+                               RFCOMM_SendChannelSignals(RFCOMMChannel, BluetoothChannel);
+                       }
+
+                       /* If signals have been configured in both directions, progress to the open state */
+                       if ((RFCOMMChannel->ConfigFlags & (RFCOMM_CONFIG_REMOTESIGNALS | RFCOMM_CONFIG_LOCALSIGNALS)) ==
+                                                         (RFCOMM_CONFIG_REMOTESIGNALS | RFCOMM_CONFIG_LOCALSIGNALS))
+                       {
+                               RFCOMMChannel->State = RFCOMM_Channel_Open;
+                       }
+               }
+       }

 }
 
 void RFCOMM_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel)
 {
 }
 
 void RFCOMM_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel)
 {

-       const RFCOMM_Header_t* FrameHeader = (const RFCOMM_Header_t*)Data;
+       const RFCOMM_Header_t* FrameHeader  = (const RFCOMM_Header_t*)Data;
+       const uint8_t*         FrameData    = (const uint8_t*)Data + sizeof(RFCOMM_Header_t);
+       uint16_t               FrameDataLen = RFCOMM_GetVariableFieldValue(&FrameData);

        
        /* Decode the RFCOMM frame type from the header */
        switch (FrameHeader->Control & ~FRAME_POLL_FINAL)
        {
        
        /* Decode the RFCOMM frame type from the header */
        switch (FrameHeader->Control & ~FRAME_POLL_FINAL)
        {

-               case RFCOMM_Frame_SABM:
-                       RFCOMM_ProcessSABM(FrameHeader, Channel);
-                       break;
-               case RFCOMM_Frame_UA:
-                       RFCOMM_ProcessUA(FrameHeader, Channel);
-                       break;

                case RFCOMM_Frame_DM:
                case RFCOMM_Frame_DM:

-                       RFCOMM_ProcessDM(FrameHeader, Channel);
+                       RFCOMM_ProcessDM(&FrameHeader->Address, Channel);

                        break;
                case RFCOMM_Frame_DISC:
                        break;
                case RFCOMM_Frame_DISC:

-                       RFCOMM_ProcessDISC(FrameHeader, Channel);
+                       RFCOMM_ProcessDISC(&FrameHeader->Address, Channel);
+                       break;
+               case RFCOMM_Frame_SABM:
+                       RFCOMM_ProcessSABM(&FrameHeader->Address, Channel);
+                       break;
+               case RFCOMM_Frame_UA:
+                       RFCOMM_ProcessUA(&FrameHeader->Address, Channel);

                        break;
                case RFCOMM_Frame_UIH:
                        break;
                case RFCOMM_Frame_UIH:

-                       RFCOMM_ProcessUIH(FrameHeader, Channel);
+                       RFCOMM_ProcessUIH(&FrameHeader->Address, FrameDataLen, FrameData, Channel);

                        break;
                default:
                        break;
                default:

-                       BT_RFCOMM_DEBUG(1, "<< Unknown Frame Type");
+                       BT_RFCOMM_DEBUG(1, "<< Unknown Frame Received");

                        break;
        }
 }
 
                        break;
        }
 }
 

-static void RFCOMM_ProcessSABM(const RFCOMM_Header_t* const FrameHeader, Bluetooth_Channel_t* const Channel)
+RFCOMM_Channel_t* RFCOMM_OpenChannel(Bluetooth_Channel_t* const BluetoothChannel)

 {
 {

-       BT_RFCOMM_DEBUG(1, "<< SABM Received");
-       BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameHeader->Address.DLCI);
-       
-       // TODO: Reset channel send/receive state here
-       
-       BT_RFCOMM_DEBUG(1, ">> UA Sent");
-       RFCOMM_SendFrame(FrameHeader->Address.DLCI, true, (RFCOMM_Frame_UA | FRAME_POLL_FINAL), 0, NULL, Channel);
+       return NULL;

 }
 
 }
 

-static void RFCOMM_ProcessUA(const RFCOMM_Header_t* const FrameHeader, Bluetooth_Channel_t* const Channel)
+void RFCOMM_SendChannelSignals(const RFCOMM_Channel_t* const RFCOMMChannel, Bluetooth_Channel_t* const BluetoothChannel)

 {
 {

-       const uint8_t* CurrBufferPos = ((const uint8_t*)FrameHeader + sizeof(RFCOMM_Header_t));
+       BT_RFCOMM_DEBUG(1, ">> MSC Command");
+       BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", RFCOMMChannel->DLCI);

 
 

-       BT_RFCOMM_DEBUG(1, "<< UA Received");
-       BT_RFCOMM_DEBUG(2, "-- Address 0x%02X", FrameHeader->Address);
+       struct
+       {
+               RFCOMM_Command_t        CommandHeader;
+               uint8_t                 Length;
+               RFCOMM_MSC_Parameters_t Params;
+       } MSCommand;
+       
+       MSCommand.CommandHeader      = (RFCOMM_Command_t){.Command = RFCOMM_Control_ModemStatus, .EA = true, .CR = true};
+       MSCommand.Length             = (sizeof(MSCommand.Params) << 1) | 0x01;
+       MSCommand.Params.Channel     = (RFCOMM_Address_t){.DLCI = RFCOMMChannel->DLCI, .EA = true, .CR = true};
+       MSCommand.Params.Signals     = RFCOMMChannel->Local.Signals;
+       MSCommand.Params.BreakSignal = RFCOMMChannel->Local.BreakSignal;
+
+       /* Send the MSC command to the remote device */
+       RFCOMM_SendFrame(RFCOMM_CONTROL_DLCI, true, RFCOMM_Frame_UIH, sizeof(MSCommand), &MSCommand, BluetoothChannel); 

 }
 
 }
 

-static void RFCOMM_ProcessDM(const RFCOMM_Header_t* const FrameHeader, Bluetooth_Channel_t* const Channel)
+RFCOMM_Channel_t* RFCOMM_GetFreeChannelEntry(const uint8_t DLCI)

 {
 {

-       const uint8_t* CurrBufferPos = ((const uint8_t*)FrameHeader + sizeof(RFCOMM_Header_t));
+       /* Find a free entry in the RFCOMM channel multiplexer state array */
+       for (uint8_t i = 0; i < RFCOMM_MAX_OPEN_CHANNELS; i++)
+       {
+               RFCOMM_Channel_t* RFCOMMChannel = &RFCOMM_Channels[i];

 
 

-       BT_RFCOMM_DEBUG(1, "<< DM Received");
-       BT_RFCOMM_DEBUG(2, "-- Address 0x%02X", FrameHeader->Address);
+               /* If the channel's state is closed, the channel state entry is free */
+               if (RFCOMMChannel->State == RFCOMM_Channel_Closed)
+               {
+                       RFCOMMChannel->DLCI               = DLCI;
+                       RFCOMMChannel->State              = RFCOMM_Channel_Configure;
+                       RFCOMMChannel->Priority           = 7 + (RFCOMMChannel->DLCI & 0xF8);
+                       RFCOMMChannel->MTU                = 0xFFFF;
+                       RFCOMMChannel->Remote.Signals     = 0 | (1 << 0);
+                       RFCOMMChannel->Remote.BreakSignal = 0 | (1 << 0);
+                       RFCOMMChannel->Local.Signals      = RFCOMM_SIGNAL_RTC | RFCOMM_SIGNAL_RTR | RFCOMM_SIGNAL_DV | (1 << 0);
+                       RFCOMMChannel->Local.BreakSignal  = 0 | (1 << 0);
+                       RFCOMMChannel->ConfigFlags        = 0;
+                       
+                       return RFCOMMChannel;
+               }
+       }
+       
+       return NULL;

 }
 
 }
 

-static void RFCOMM_ProcessDISC(const RFCOMM_Header_t* const FrameHeader, Bluetooth_Channel_t* const Channel)
+RFCOMM_Channel_t* RFCOMM_GetChannelData(const uint8_t DLCI)

 {
 {

-       const uint8_t* CurrBufferPos = ((const uint8_t*)FrameHeader + sizeof(RFCOMM_Header_t));
+       /* Search through the RFCOMM channel list, looking for the specified channel */
+       for (uint8_t i = 0; i < RFCOMM_MAX_OPEN_CHANNELS; i++)
+       {
+               RFCOMM_Channel_t* CurrRFCOMMChannel = &RFCOMM_Channels[i];
+       
+               /* If the current non-closed channel's DLCI matches the search DLCI, return it to the caller */
+               if ((CurrRFCOMMChannel->State != RFCOMM_Channel_Closed) && (CurrRFCOMMChannel->DLCI == DLCI))
+                 return CurrRFCOMMChannel;
+       }

 
 

-       BT_RFCOMM_DEBUG(1, "<< DISC Received");
-       BT_RFCOMM_DEBUG(2, "-- Address 0x%02X", FrameHeader->Address);
+       /* Channel not found in the channel state table, return failure */
+       return NULL;

 }
 
 }
 

-static void RFCOMM_ProcessUIH(const RFCOMM_Header_t* const FrameHeader, Bluetooth_Channel_t* const Channel)
+uint16_t RFCOMM_GetVariableFieldValue(const uint8_t** BufferPos)

 {
 {

-       const uint8_t* CurrBufferPos = ((const uint8_t*)FrameHeader + sizeof(RFCOMM_Header_t));
+       uint8_t FirstOctet;
+       uint8_t SecondOctet = 0;
+       
+       FirstOctet = **BufferPos;
+       (*BufferPos)++;
+       
+       /* If the field size is more than a single byte, fetch the next byte in the variable length field */
+       if (!(FirstOctet & 0x01))
+       {
+               SecondOctet = **BufferPos;
+               (*BufferPos)++;

 
 

-       BT_RFCOMM_DEBUG(1, "<< UIH Received");
-       BT_RFCOMM_DEBUG(2, "-- Address 0x%02X", FrameHeader->Address);
+               /* Discard any remaining bytes in the variable length field that won't fit in the return value */
+               while (!(**BufferPos & 0x01))
+                 (*BufferPos)++;
+       }
+
+       /* Bitshift the bytes that comprise the variable length field so that they form a single integer */
+       return (((uint16_t)SecondOctet << 7) | FirstOctet >> 1);

 }
 
 }
 

-static void RFCOMM_SendFrame(const uint8_t DLCI, const bool CommandResponse, const uint8_t Control, const uint16_t DataLen, const uint8_t* Data,
-                             Bluetooth_Channel_t* const Channel)
+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)

 {
        struct
        {
 {
        struct
        {


@@ -151,12 +235,7 @@ static void RFCOMM_SendFrame(const uint8_t DLCI, const bool CommandResponse, con
        
        /* Set the frame header values to the specified address and frame type */
        ResponsePacket.FrameHeader.Control = Control;
        
        /* Set the frame header values to the specified address and frame type */
        ResponsePacket.FrameHeader.Control = Control;

-       ResponsePacket.FrameHeader.Address = (RFCOMM_Address_t)
-               {
-                       .EA   = true,
-                       .CR   = CommandResponse,
-                       .DLCI = DLCI,
-               };
+       ResponsePacket.FrameHeader.Address = (RFCOMM_Address_t){.DLCI = DLCI, .EA   = true, .CR = CommandResponse};

        
        /* Set the lower 7 bits of the packet length */
        ResponsePacket.Size[0] = (DataLen << 1);
        
        /* Set the lower 7 bits of the packet length */
        ResponsePacket.Size[0] = (DataLen << 1);


@@ -170,38 +249,114 @@ static void RFCOMM_SendFrame(const uint8_t DLCI, const bool CommandResponse, con
        /* Copy over the packet data from the source buffer to the response packet buffer */
        memcpy(ResponsePacket.Data, Data, DataLen);
        
        /* Copy over the packet data from the source buffer to the response packet buffer */
        memcpy(ResponsePacket.Data, Data, DataLen);
        

+       /* Determine the length of the frame which is to be used to calculate the CRC value */
+       uint8_t CRCLength = sizeof(ResponsePacket.FrameHeader);
+
+       /* UIH frames do not have the CRC calculated on the Size field in the response, all other frames do */
+       if ((Control & ~FRAME_POLL_FINAL) != RFCOMM_Frame_UIH)
+         CRCLength += sizeof(ResponsePacket.Size);
+       

        /* Calculate the frame checksum from the appropriate fields */
        /* Calculate the frame checksum from the appropriate fields */

-       if ((Control & ~FRAME_POLL_FINAL) == RFCOMM_Frame_UIH)
-         ResponsePacket.FCS = RFCOMM_GetFCSValue(&ResponsePacket, sizeof(ResponsePacket.FrameHeader));
-       else
-         ResponsePacket.FCS = RFCOMM_GetFCSValue(&ResponsePacket, sizeof(ResponsePacket.FrameHeader) + sizeof(ResponsePacket.Size));
+       ResponsePacket.FCS = RFCOMM_GetFCSValue(&ResponsePacket, CRCLength);

 
        /* Send the completed response packet to the sender */
        Bluetooth_SendPacket(&ResponsePacket, sizeof(ResponsePacket), Channel);
 }
 
 
        /* Send the completed response packet to the sender */
        Bluetooth_SendPacket(&ResponsePacket, sizeof(ResponsePacket), Channel);
 }
 

-static uint8_t RFCOMM_GetFCSValue(const void* FrameStart, uint16_t Length)
+static uint8_t RFCOMM_GetFCSValue(const void* FrameStart, uint8_t Length)
+{
+       uint8_t FCS = 0xFF;
+       
+       /* Calculate new Frame CRC value via the given data bytes and the CRC table */
+       for (uint8_t i = 0; i < Length; i++)
+         FCS = pgm_read_byte(&CRC8_Table[FCS ^ ((uint8_t*)FrameStart)[i]]);
+
+       return ~FCS;
+}
+
+static void RFCOMM_ProcessDM(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel)
+{
+       BT_RFCOMM_DEBUG(1, "<< DM Received");
+       BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameAddress->DLCI);
+}
+
+static void RFCOMM_ProcessDISC(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel)

 {
 {

-       const uint8_t* CurrPos = FrameStart;
-       uint8_t        FCS     = 0xFF;
+       BT_RFCOMM_DEBUG(1, "<< DISC Received");
+       BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameAddress->DLCI);
+
+       RFCOMM_Channel_t* RFCOMMChannel = RFCOMM_GetChannelData(FrameAddress->DLCI);

        
        

-       while (Length--)
+       /* If the requested channel is currently open, destroy it */
+       if (RFCOMMChannel != NULL)
+         RFCOMMChannel->State = RFCOMM_Channel_Closed;
+
+       BT_RFCOMM_DEBUG(1, ">> UA Sent");
+       RFCOMM_SendFrame(FrameAddress->DLCI, true, (RFCOMM_Frame_UA | FRAME_POLL_FINAL), 0, NULL, Channel);
+}
+
+static void RFCOMM_ProcessSABM(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel)
+{
+       BT_RFCOMM_DEBUG(1, "<< SABM Received");
+       BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameAddress->DLCI);
+
+       if (FrameAddress->DLCI == RFCOMM_CONTROL_DLCI)

        {
        {

-               FCS = pgm_read_byte(&CRC8_Table[FCS ^ *CurrPos]);
-               CurrPos++;
+               BT_RFCOMM_DEBUG(1, ">> UA Sent");
+               
+               /* Free channel found, or request was to the control channel - accept SABM by sending a UA frame */
+               RFCOMM_SendFrame(FrameAddress->DLCI, true, (RFCOMM_Frame_UA | FRAME_POLL_FINAL), 0, NULL, Channel);
+
+               return;

        }
 
        }
 

-       return (0xFF - FCS);
+       /* Find the existing channel's entry in the channel table */
+       RFCOMM_Channel_t* RFCOMMChannel = RFCOMM_GetChannelData(FrameAddress->DLCI);
+       
+       /* Existing entry not found, create a new entry for the channel */
+       if (RFCOMMChannel == NULL)
+         RFCOMMChannel = RFCOMM_GetFreeChannelEntry(FrameAddress->DLCI);
+
+       /* If space was found in the channel table for the new channel, ACK the request */
+       if (RFCOMMChannel != NULL)
+       {
+               BT_RFCOMM_DEBUG(1, ">> UA Sent");
+               
+               /* Free channel found, or request was to the control channel - accept SABM by sending a UA frame */
+               RFCOMM_SendFrame(FrameAddress->DLCI, true, (RFCOMM_Frame_UA | FRAME_POLL_FINAL), 0, NULL, Channel);
+       }
+       else
+       {
+               BT_RFCOMM_DEBUG(1, ">> DM Sent");
+
+               /* No free channel in the multiplexer - decline the SABM by sending a DM frame */
+               RFCOMM_SendFrame(FrameAddress->DLCI, true, (RFCOMM_Frame_DM | FRAME_POLL_FINAL), 0, NULL, Channel);
+       }

 }
 
 }
 

-static uint16_t RFCOMM_GetFrameDataLength(const uint8_t** BufferPos)
+static void RFCOMM_ProcessUA(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel)

 {
 {

-       uint8_t FirstOctet  = *((*BufferPos)++);
-       uint8_t SecondOctet = 0;
+       BT_RFCOMM_DEBUG(1, "<< UA Received");
+       BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameAddress->DLCI);
+}
+
+static void RFCOMM_ProcessUIH(const RFCOMM_Address_t* const FrameAddress, const uint16_t FrameLength, 
+                              const uint8_t* FrameData, Bluetooth_Channel_t* const Channel)
+{
+       if (FrameAddress->DLCI == RFCOMM_CONTROL_DLCI)
+       {
+               RFCOMM_ProcessControlCommand(FrameData, Channel);
+               return;
+       }
+
+       BT_RFCOMM_DEBUG(1, "<< UIH Received");
+       BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameAddress->DLCI);
+       BT_RFCOMM_DEBUG(2, "-- Length 0x%02X", FrameLength);
+               
+       puts("RFCOMM Data: ");

        
        

-       if (!(FirstOctet & 0x01))
-         SecondOctet = *((*BufferPos)++);
+       for (uint8_t i = 0; i < FrameLength; i++)
+         printf("0x%02X (%c) ", FrameData[i], FrameData[i]);

        
        

-       return (((uint16_t)SecondOctet << 7) | (FirstOctet >> 1));
+       printf("\r\n");

 }
 }

-