More improvements to the incomplete BluetoothHost demo - add Disconnection Event...
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / Lib / BluetoothHCICommands.c
index 8fb7367..dd2a3e5 100644 (file)
 \r
 #include "BluetoothHCICommands.h"\r
 \r
-static   Bluetooth_HCICommand_Header_t HCICommandHeader;\r
-static   Bluetooth_HCIEvent_Header_t   HCIEventHeader;\r
+static Bluetooth_HCICommand_Header_t HCICommandHeader;\r
 \r
-         uint8_t                       Bluetooth_HCIProcessingState;\r
-                uint8_t                       Bluetooth_HCINextState;\r
-static   uint8_t                       Bluetooth_TempDeviceAddress[6];\r
+       uint8_t                       Bluetooth_HCIProcessingState;\r
+static uint8_t                       Bluetooth_HCINextState;\r
+static uint8_t                       Bluetooth_TempDeviceAddress[6];\r
 \r
-static uint8_t Bluetooth_SendHCICommand(void* Parameters, uint8_t ParamLength)\r
+static uint8_t Bluetooth_SendHCICommand(void* Parameters, uint16_t ParameterLength)\r
 {\r
+       /* Need to reserve the amount of bytes given in the header for the complete payload */\r
        uint8_t CommandBuffer[sizeof(HCICommandHeader) + HCICommandHeader.ParameterLength];\r
 \r
        USB_ControlRequest = (USB_Request_Header_t)\r
@@ -49,21 +49,23 @@ static uint8_t Bluetooth_SendHCICommand(void* Parameters, uint8_t ParamLength)
                        .wIndex        = 0,\r
                        .wLength       = sizeof(CommandBuffer)\r
                };\r
-               \r
-       memset(CommandBuffer, 0x00, sizeof(CommandBuffer));\r
+\r
+       /* Copy over the HCI command header to the allocated buffer */\r
        memcpy(CommandBuffer, &HCICommandHeader, sizeof(HCICommandHeader));\r
        \r
-       if (ParamLength)\r
-         memcpy(&CommandBuffer[sizeof(HCICommandHeader)], Parameters, ParamLength);\r
+       /* Zero out the parameter section of the response to ensure that any padding bytes do not expose private RAM contents */\r
+       memset(&CommandBuffer[sizeof(HCICommandHeader)], 0x00, HCICommandHeader.ParameterLength);\r
 \r
+       /* Copy over the command parameters (if any) to the command buffer - note, the number of actual source parameter bytes\r
+          may differ to those in the header; any difference in length is filled with 0x00 padding bytes */\r
+       memcpy(&CommandBuffer[sizeof(HCICommandHeader)], Parameters, ParameterLength);\r
+       \r
        Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
        return USB_Host_SendControlRequest(CommandBuffer);\r
 }\r
 \r
 void Bluetooth_ProcessHCICommands(void)\r
 {\r
-       uint8_t ErrorCode;\r
-\r
        switch (Bluetooth_HCIProcessingState)\r
        {\r
                case Bluetooth_ProcessEvents:\r
@@ -72,68 +74,87 @@ void Bluetooth_ProcessHCICommands(void)
                        \r
                        if (Pipe_IsReadWriteAllowed())\r
                        {\r
+                               Bluetooth_HCIEvent_Header_t HCIEventHeader;\r
+\r
+                               /* Read in the event header to fetch the event code and payload length */\r
                                Pipe_Read_Stream_LE(&HCIEventHeader, sizeof(HCIEventHeader));\r
                                \r
+                               /* Create a temporary buffer for the event parameters */\r
                                uint8_t EventParams[HCIEventHeader.ParameterLength];\r
 \r
+                               /* Read in the event parameters into the temporary buffer */\r
                                Pipe_Read_Stream_LE(&EventParams, HCIEventHeader.ParameterLength);\r
                                Pipe_ClearIN();\r
 \r
-                               BT_DEBUG("(HCI) Event Code: 0x%02X", HCIEventHeader.EventCode);\r
+                               BT_HCI_DEBUG("Event Code: 0x%02X", HCIEventHeader.EventCode);\r
                                \r
                                switch (HCIEventHeader.EventCode)\r
                                {\r
                                        case EVENT_COMMAND_COMPLETE:\r
                                                Bluetooth_HCIProcessingState = Bluetooth_HCINextState;\r
 \r
-                                               BT_DEBUG("(HCI) >> Command Complete (Opcode 0x%04x)", \r
+                                               BT_HCI_DEBUG(">> Command Complete (Opcode 0x%04x)", \r
                                                         ((Bluetooth_HCIEvent_CommandComplete_t*)&EventParams)->Opcode);\r
                                                break;\r
                                        case EVENT_COMMAND_STATUS:\r
+                                               /* If the execution of a command failed, reset the stack */\r
                                                if (((Bluetooth_HCIEvent_CommandStatus_t*)&EventParams)->Status)\r
                                                  Bluetooth_HCIProcessingState = Bluetooth_Init;\r
 \r
-                                               BT_DEBUG("(HCI) >> Command Status: 0x%02X",\r
+                                               BT_HCI_DEBUG(">> Command Status: 0x%02X",\r
                                                         ((Bluetooth_HCIEvent_CommandStatus_t*)&EventParams)->Status);                                  \r
                                                break;\r
                                        case EVENT_CONNECTION_REQUEST:\r
+                                               /* Need to store the remote device's BT address in a temporary buffer for later use */\r
                                                memcpy(Bluetooth_TempDeviceAddress,\r
                                                       &((Bluetooth_HCIEvent_ConnectionRequest_t*)&EventParams)->RemoteAddress,\r
                                                       sizeof(Bluetooth_TempDeviceAddress));\r
                                        \r
+                                               /* Only accept the connection if it is a ACL (data) connection */\r
                                                Bluetooth_HCIProcessingState = (Bluetooth_Connection.IsConnected ||\r
                                                                               (((Bluetooth_HCIEvent_ConnectionRequest_t*)&EventParams)->LinkType != 0x01)) ?\r
                                                                                                           Bluetooth_Conn_RejectConnection : Bluetooth_Conn_AcceptConnection;\r
 \r
-                                               BT_DEBUG("(HCI) >> Connection Request from Device %02X:%02X:%02X:%02X:%02X:%02X",\r
+                                               BT_HCI_DEBUG(">> Connection Request from Device %02X:%02X:%02X:%02X:%02X:%02X",\r
                                                                 Bluetooth_TempDeviceAddress[5], Bluetooth_TempDeviceAddress[4], Bluetooth_TempDeviceAddress[3],\r
                                                                 Bluetooth_TempDeviceAddress[2], Bluetooth_TempDeviceAddress[1], Bluetooth_TempDeviceAddress[0]);\r
                                                break;\r
                                        case EVENT_PIN_CODE_REQUEST:\r
+                                               /* Need to store the remote device's BT address in a temporary buffer for later use */\r
                                                memcpy(Bluetooth_TempDeviceAddress,\r
                                                       &((Bluetooth_HCIEvent_PinCodeRequest_t*)&EventParams)->RemoteAddress,\r
                                                       sizeof(Bluetooth_TempDeviceAddress));\r
 \r
                                                Bluetooth_HCIProcessingState = Bluetooth_Conn_SendPINCode;\r
 \r
-                                               BT_DEBUG("(HCI) >> PIN Request from Device %02X:%02X:%02X:%02X:%02X:%02X", \r
+                                               BT_HCI_DEBUG(">> PIN Request from Device %02X:%02X:%02X:%02X:%02X:%02X", \r
                                                                 Bluetooth_TempDeviceAddress[5], Bluetooth_TempDeviceAddress[4], Bluetooth_TempDeviceAddress[3],\r
                                                                 Bluetooth_TempDeviceAddress[2], Bluetooth_TempDeviceAddress[1], Bluetooth_TempDeviceAddress[0]);\r
                                                break;\r
                                        case EVENT_CONNECTION_COMPLETE:\r
+                                               /* Need to store the remote device's BT address in a temporary buffer for later use */\r
                                                memcpy(Bluetooth_Connection.RemoteAddress,\r
                                                       &((Bluetooth_HCIEvent_ConnectionComplete_t*)&EventParams)->RemoteAddress,\r
                                                       sizeof(Bluetooth_TempDeviceAddress));\r
 \r
+                                               /* Store the created connection handle and indicate that the connection has been established */\r
                                                Bluetooth_Connection.ConnectionHandle = ((Bluetooth_HCIEvent_ConnectionComplete_t*)&EventParams)->ConnectionHandle;\r
                                                Bluetooth_Connection.IsConnected      = true;\r
 \r
-                                               BT_DEBUG("(HCI) >> Connection Complete to Device %02X:%02X:%02X:%02X:%02X:%02X, Handle 0x%04x", \r
+                                               BT_HCI_DEBUG(">> Connection Complete to Device %02X:%02X:%02X:%02X:%02X:%02X, Handle 0x%04x", \r
                                                                 Bluetooth_Connection.RemoteAddress[5], Bluetooth_Connection.RemoteAddress[4],\r
                                                                 Bluetooth_Connection.RemoteAddress[3], Bluetooth_Connection.RemoteAddress[2],\r
                                                                 Bluetooth_Connection.RemoteAddress[1], Bluetooth_Connection.RemoteAddress[0],\r
                                                                 Bluetooth_Connection.ConnectionHandle);\r
                                                break;\r
+                                       case EVENT_DISCONNECTION_COMPLETE:\r
+                                               BT_HCI_DEBUG(">> Disconnection Complete", NULL);\r
+\r
+                                               /* Device disconnected, indicate connection information no longer valid */\r
+                                               Bluetooth_Connection.IsConnected = false;\r
+                                               \r
+                                               Bluetooth_HCIProcessingState = Bluetooth_Init;\r
+                                               break;                                  \r
                                }\r
                        }\r
                        \r
@@ -141,6 +162,7 @@ void Bluetooth_ProcessHCICommands(void)
                        \r
                        break;\r
                case Bluetooth_Init:\r
+                       /* Reset the connection information structure to destroy any previous connection state */\r
                        memset(&Bluetooth_Connection, 0x00, sizeof(Bluetooth_Connection));\r
 \r
                        Bluetooth_HCIProcessingState = Bluetooth_Init_Reset; \r
@@ -152,24 +174,11 @@ void Bluetooth_ProcessHCICommands(void)
                                ParameterLength: 0,\r
                        };\r
                        \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Init_Reset", NULL);\r
+                       BT_HCI_DEBUG("Enter State: Bluetooth_Init_Reset", NULL);\r
 \r
-                       ErrorCode = Bluetooth_SendHCICommand(NULL, 0);\r
+                       /* Send the command to reset the bluetooth dongle controller */\r
+                       Bluetooth_SendHCICommand(NULL, 0);\r
                        \r
-                       Bluetooth_HCINextState       = Bluetooth_Init_ReadBufferSize;\r
-                       Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
-                       break;\r
-               case Bluetooth_Init_ReadBufferSize:\r
-                       HCICommandHeader = (Bluetooth_HCICommand_Header_t)\r
-                       {\r
-                               OpCode: {OGF: OGF_CTRLR_INFORMATIONAL, OCF: OGF_CTRLR_INFORMATIONAL_READBUFFERSIZE},\r
-                               ParameterLength: 0,\r
-                       };\r
-               \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Init_ReadBufferSize", NULL);\r
-\r
-                       ErrorCode = Bluetooth_SendHCICommand(NULL, 0);\r
-\r
                        Bluetooth_HCINextState       = Bluetooth_Init_SetLocalName;\r
                        Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
                        break;\r
@@ -180,10 +189,11 @@ void Bluetooth_ProcessHCICommands(void)
                                        ParameterLength: 248,\r
                                };\r
 \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Init_SetLocalName", NULL);\r
-                       BT_DEBUG("(HCI)  -- Name: %s", Bluetooth_DeviceConfiguration.Name);\r
+                       BT_HCI_DEBUG("Enter State: Bluetooth_Init_SetLocalName", NULL);\r
+                       BT_HCI_DEBUG("-- Name: %s", Bluetooth_DeviceConfiguration.Name);\r
 \r
-                       ErrorCode = Bluetooth_SendHCICommand(Bluetooth_DeviceConfiguration.Name, strlen(Bluetooth_DeviceConfiguration.Name));\r
+                       /* Send the command to set the bluetooth dongle's name for other devices to see */\r
+                       Bluetooth_SendHCICommand(Bluetooth_DeviceConfiguration.Name, strlen(Bluetooth_DeviceConfiguration.Name));\r
 \r
                        Bluetooth_HCINextState       = Bluetooth_Init_SetDeviceClass;\r
                        Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
@@ -195,9 +205,10 @@ void Bluetooth_ProcessHCICommands(void)
                                        ParameterLength: 3,\r
                                };\r
 \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Init_SetDeviceClass", NULL);\r
+                       BT_HCI_DEBUG("Enter State: Bluetooth_Init_SetDeviceClass", NULL);\r
 \r
-                       ErrorCode = Bluetooth_SendHCICommand(&Bluetooth_DeviceConfiguration.Class, 3);\r
+                       /* Send the command to set the class of the device for other devices to see */\r
+                       Bluetooth_SendHCICommand(&Bluetooth_DeviceConfiguration.Class, 3);\r
 \r
                        Bluetooth_HCINextState       = Bluetooth_Init_WriteScanEnable;\r
                        Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
@@ -209,10 +220,12 @@ void Bluetooth_ProcessHCICommands(void)
                                ParameterLength: 1,\r
                        };\r
                        \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Init_WriteScanEnable", NULL);\r
+                       BT_HCI_DEBUG("Enter State: Bluetooth_Init_WriteScanEnable", NULL);\r
 \r
-                       uint8_t Interval = InquiryAndPageScans;\r
-                       ErrorCode = Bluetooth_SendHCICommand(&Interval, 1);\r
+                       uint8_t Interval = BT_SCANMODE_InquiryAndPageScans;\r
+                       \r
+                       /* Send the command to set the remote device scanning mode */\r
+                       Bluetooth_SendHCICommand(&Interval, 1);\r
                        \r
                        Bluetooth_HCINextState       = Bluetooth_ProcessEvents;\r
                        Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
@@ -224,14 +237,17 @@ void Bluetooth_ProcessHCICommands(void)
                                        ParameterLength: sizeof(Bluetooth_HCICommand_AcceptConnectionRequest_t),\r
                                };\r
                        \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Conn_AcceptConnection", NULL);\r
+                       BT_HCI_DEBUG("Enter State: Bluetooth_Conn_AcceptConnection", NULL);\r
 \r
+                       /* Copy over the temporary BT device address saved from the Connection Request event, indicate slave\r
+                          connection role */\r
                        Bluetooth_HCICommand_AcceptConnectionRequest_t AcceptConnectionParams;\r
-\r
-                       memcpy(AcceptConnectionParams.RemoteAddress, Bluetooth_TempDeviceAddress, sizeof(Bluetooth_TempDeviceAddress));\r
+                       memcpy(AcceptConnectionParams.RemoteAddress, Bluetooth_TempDeviceAddress,\r
+                              sizeof(AcceptConnectionParams.RemoteAddress));\r
                        AcceptConnectionParams.SlaveRole = true;\r
 \r
-                       ErrorCode = Bluetooth_SendHCICommand(&AcceptConnectionParams, sizeof(AcceptConnectionParams));\r
+                       /* Send the command to accept the remote connection request */\r
+                       Bluetooth_SendHCICommand(&AcceptConnectionParams, sizeof(Bluetooth_HCICommand_AcceptConnectionRequest_t));\r
                        \r
                        Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
                        break;\r
@@ -242,14 +258,16 @@ void Bluetooth_ProcessHCICommands(void)
                                        ParameterLength: sizeof(Bluetooth_HCICommand_RejectConnectionRequest_t),\r
                                };\r
                        \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Conn_RejectConnection", NULL);\r
+                       BT_HCI_DEBUG("Enter State: Bluetooth_Conn_RejectConnection", NULL);\r
 \r
+                       /* Copy over the temporary BT device address saved from the Connection Request event, indicate failure\r
+                          to accept the connection due to limited device resources */\r
                        Bluetooth_HCICommand_RejectConnectionRequest_t RejectConnectionParams;\r
-\r
                        memcpy(RejectConnectionParams.RemoteAddress, Bluetooth_TempDeviceAddress, sizeof(RejectConnectionParams.RemoteAddress));\r
                        RejectConnectionParams.Reason = ERROR_LIMITED_RESOURCES;\r
 \r
-                       ErrorCode = Bluetooth_SendHCICommand(&RejectConnectionParams, sizeof(RejectConnectionParams));\r
+                       /* Send the command to reject the remote connection request */\r
+                       Bluetooth_SendHCICommand(&RejectConnectionParams, sizeof(Bluetooth_HCICommand_RejectConnectionRequest_t));\r
                \r
                        Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
                        break;\r
@@ -260,16 +278,18 @@ void Bluetooth_ProcessHCICommands(void)
                                        ParameterLength: sizeof(Bluetooth_HCICommand_PinCodeResponse_t),\r
                                };\r
                        \r
-                       BT_DEBUG("(HCI) Enter State: Bluetooth_Conn_SendPINCode", NULL);\r
-                       BT_DEBUG("(HCI) -- PIN: %s", Bluetooth_DeviceConfiguration.PINCode);\r
+                       BT_HCI_DEBUG("Enter State: Bluetooth_Conn_SendPINCode", NULL);\r
+                       BT_HCI_DEBUG("-- PIN: %s", Bluetooth_DeviceConfiguration.PINCode);\r
 \r
+                       /* Copy over the temporary BT device address saved from the PIN Code Request event, copy over the\r
+                          local PIN authentication code to the response */\r
                        Bluetooth_HCICommand_PinCodeResponse_t PINCodeRequestParams;\r
-               \r
-                       memcpy(PINCodeRequestParams.RemoteAddress, Bluetooth_TempDeviceAddress, sizeof(Bluetooth_TempDeviceAddress));\r
+                       memcpy(PINCodeRequestParams.RemoteAddress, Bluetooth_TempDeviceAddress, sizeof(PINCodeRequestParams.RemoteAddress));\r
                        PINCodeRequestParams.PINCodeLength = strlen(Bluetooth_DeviceConfiguration.PINCode);\r
                        memcpy(PINCodeRequestParams.PINCode, Bluetooth_DeviceConfiguration.PINCode, sizeof(PINCodeRequestParams.PINCode));\r
                        \r
-                       ErrorCode = Bluetooth_SendHCICommand(&PINCodeRequestParams, sizeof(PINCodeRequestParams));\r
+                       /* Send the command to transmit the device's local PIN number for authentication */\r
+                       Bluetooth_SendHCICommand(&PINCodeRequestParams, sizeof(Bluetooth_HCICommand_PinCodeResponse_t));\r
 \r
                        Bluetooth_HCIProcessingState = Bluetooth_ProcessEvents;\r
                        break;\r