RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS];
-/** Initializes the RFCOMM service, ready for new connections from a SDP client. */
+/** Initialises the RFCOMM service, ready for new connections from a SDP client. */
void RFCOMM_Initialize(void)
{
- /* Reset the RFCOMM channel structures, to invalidate any confiured RFCOMM channels */
+ /* Reset the RFCOMM channel structures, to invalidate any configured RFCOMM channels */
for (uint8_t i = 0; i < RFCOMM_MAX_OPEN_CHANNELS; i++)
RFCOMM_Channels[i].State = RFCOMM_Channel_Closed;
}
+/** Services all the logical RFCOMM channels on the given ACL channel, sending any RFCOMM control requests to
+ * the remote device as needed to establish new logical RFCOMM channels. This function should be called repeatedly
+ * in the main program loop when an ACL channel with an RFCOMM PSM has been established between the local and remote
+ * device.
+ *
+ * \param[in] ACLChannel ACL channel which has been previously opened to handle RFCOMM traffic between devices
+ */
void RFCOMM_ServiceChannels(Bluetooth_Channel_t* const ACLChannel)
{
/* Abort if the RFCOMM ACL channel is not currently open */
}
}
-void RFCOMM_ProcessPacket(void* Data, Bluetooth_Channel_t* const ACLChannel)
+/** Processes an incoming RFCOMM packet on an ACL channel which has been previously opened between the local and
+ * a remote device to handle RFCOMM traffic.
+ *
+ * \param[in] Data Incoming packet data containing the RFCOMM packet
+ * \param[in] ACLChannel ACL channel the request was issued to by the remote device
+ */
+void RFCOMM_ProcessPacket(void* Data,
+ Bluetooth_Channel_t* const ACLChannel)
{
const RFCOMM_Header_t* FrameHeader = (const RFCOMM_Header_t*)Data;
const uint8_t* FrameData = (const uint8_t*)Data + sizeof(RFCOMM_Header_t);
}
}
-void RFCOMM_SendChannelSignals(const RFCOMM_Channel_t* const RFCOMMChannel, Bluetooth_Channel_t* const ACLChannel)
+/** Sends an RFCOMM notification to the remote device that the local terminal control signals (located in the
+ * "Local" structure of the RFCOMM channel) have changed, pushing the new signals to the remote device.
+ *
+ * \param[in] RFCOMMChannel RFCOMM logical channel whose local terminal signals have changed
+ * \param[in] ACLChannel ACL channel which has been opened to carry RFCOMM traffic between devices
+ */
+void RFCOMM_SendChannelSignals(const RFCOMM_Channel_t* const RFCOMMChannel,
+ Bluetooth_Channel_t* const ACLChannel)
{
BT_RFCOMM_DEBUG(1, ">> MSC Command");
BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", RFCOMMChannel->DLCI);
RFCOMM_SendFrame(RFCOMM_CONTROL_DLCI, true, RFCOMM_Frame_UIH, sizeof(MSCommand), &MSCommand, ACLChannel);
}
-void RFCOMM_SendData(const uint16_t DataLen, const uint8_t* Data, const RFCOMM_Channel_t* const RFCOMMChannel,
+/** Sends new data through an open logical RFCOMM channel. This should be used to transmit data through a
+ * RFCOMM channel once it has been opened.
+ *
+ * \param[in] DataLen Length of the RFCOMM data to send, in bytes
+ * \param[in] Data Pointer to a buffer where the data to send is located
+ * \param[in] RFCOMMChannel RFCOMM logical channel which is to be transmitted to
+ * \param[in] ACLChannel ACL channel which has been opened to carry RFCOMM traffic between devices
+ */
+void RFCOMM_SendData(const uint16_t DataLen,
+ const uint8_t* Data,
+ const RFCOMM_Channel_t* const RFCOMMChannel,
Bluetooth_Channel_t* const ACLChannel)
{
if (RFCOMMChannel->State != RFCOMM_Channel_Open)
(*BufferPos)++;
}
- /* Bitshift the bytes that comprise the variable length field so that they form a single integer */
+ /* Bit-shift the bytes that comprise the variable length field so that they form a single integer */
return (((uint16_t)SecondOctet << 7) | FirstOctet >> 1);
}
-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)
+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)
{
struct
{
Bluetooth_SendPacket(&ResponsePacket, sizeof(ResponsePacket), ACLChannel);
}
-static uint8_t RFCOMM_GetFCSValue(const void* FrameStart, uint8_t Length)
+static uint8_t RFCOMM_GetFCSValue(const void* FrameStart,
+ uint8_t Length)
{
uint8_t FCS = 0xFF;
return ~FCS;
}
-static void RFCOMM_ProcessDM(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const ACLChannel)
+static void RFCOMM_ProcessDM(const RFCOMM_Address_t* const FrameAddress,
+ Bluetooth_Channel_t* const ACLChannel)
{
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 ACLChannel)
+static void RFCOMM_ProcessDISC(const RFCOMM_Address_t* const FrameAddress,
+ Bluetooth_Channel_t* const ACLChannel)
{
BT_RFCOMM_DEBUG(1, "<< DISC Received");
BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameAddress->DLCI);
RFCOMM_SendFrame(FrameAddress->DLCI, true, (RFCOMM_Frame_UA | FRAME_POLL_FINAL), 0, NULL, ACLChannel);
}
-static void RFCOMM_ProcessSABM(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)
{
BT_RFCOMM_DEBUG(1, "<< SABM Received");
BT_RFCOMM_DEBUG(2, "-- DLCI 0x%02X", FrameAddress->DLCI);
}
}
-static void RFCOMM_ProcessUA(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)
{
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 ACLChannel)
+static void RFCOMM_ProcessUIH(const RFCOMM_Address_t* const FrameAddress,
+ const uint16_t FrameLength,
+ const uint8_t* FrameData,
+ Bluetooth_Channel_t* const ACLChannel)
{
if (FrameAddress->DLCI == RFCOMM_CONTROL_DLCI)
{
projects / pub / USBasp.git / blobdiff