X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/89a32baf585c8881fa972a2cb1963fb67e70d642..a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8:/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c diff --git a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c index c3e54ab3a..027400c7b 100644 --- a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c +++ b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c @@ -3,7 +3,7 @@ Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com + www.lufa-lib.org */ /* @@ -36,7 +36,7 @@ */ TMC_Capabilities_t Capabilities = { - .Status = TMC_REQUEST_STATUS_SUCCESS, + .Status = TMC_STATUS_SUCCESS, .TMCVersion = VERSION_BCD(1.00), .Interface = @@ -53,13 +53,16 @@ TMC_Capabilities_t Capabilities = }; /** Current TMC control request that is being processed */ -uint8_t RequestInProgess = 0; +uint8_t RequestInProgress = 0; /** Stream callback abort flag for bulk IN data */ -bool IsTMCBulkINReset = false; +bool IsTMCBulkINReset = false; /** Stream callback abort flag for bulk OUT data */ -bool IsTMCBulkOUTReset = false; +bool IsTMCBulkOUTReset = false; + +/** Last used tag value for data transfers */ +uint8_t CurrentTransferTag = 0; /** Main program entry point. This routine contains the overall program flow, including initial @@ -94,49 +97,63 @@ void SetupHardware(void) USB_Init(); } +/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and + * starts the library USB task to begin the enumeration and USB management process. + */ void EVENT_USB_Device_Connect(void) { LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); } +/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via + * the status LEDs and stops the USB management and CDC management tasks. + */ void EVENT_USB_Device_Disconnect(void) { LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); } +/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration + * of the USB device after enumeration - the device endpoints are configured and the CDC management task started. + */ void EVENT_USB_Device_ConfigurationChanged(void) { - LEDs_SetAllLEDs(LEDMASK_USB_READY); + bool ConfigSuccess = true; - /* Setup TMC In and Out Endpoints */ - if (!(Endpoint_ConfigureEndpoint(TMC_IN_EPNUM, EP_TYPE_BULK, - ENDPOINT_DIR_IN, TMC_IO_EPSIZE, - ENDPOINT_BANK_SINGLE))) - { - LEDs_SetAllLEDs(LEDMASK_USB_ERROR); - } + /* Setup TMC In, Out and Notification Endpoints */ + ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN, + TMC_IO_EPSIZE, ENDPOINT_BANK_SINGLE); + ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_IN_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_IN, + TMC_IO_EPSIZE, ENDPOINT_BANK_SINGLE); + ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_OUT_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT, + TMC_IO_EPSIZE, ENDPOINT_BANK_SINGLE); - if (!(Endpoint_ConfigureEndpoint(TMC_OUT_EPNUM, EP_TYPE_BULK, - ENDPOINT_DIR_OUT, TMC_IO_EPSIZE, - ENDPOINT_BANK_SINGLE))) - { - LEDs_SetAllLEDs(LEDMASK_USB_ERROR); - } + /* Indicate endpoint configuration success or failure */ + LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR); } -void EVENT_USB_Device_UnhandledControlRequest(void) +/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to + * the device from the USB host before passing along unhandled control requests to the library for processing + * internally. + */ +void EVENT_USB_Device_ControlRequest(void) { + uint8_t TMCRequestStatus = TMC_STATUS_SUCCESS; + + /* Process TMC specific control requests */ switch (USB_ControlRequest.bRequest) { case Req_InitiateAbortBulkOut: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT)) { - Endpoint_ClearSETUP(); - - /* Check to see if a split request is already being processed before starting a new one */ - if (RequestInProgess != 0) + /* Check that no split transaction is already in progress and the data transfer tag is valid */ + if (RequestInProgress != 0) { - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SPLIT_IN_PROGRESS); + TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS; + } + else if (USB_ControlRequest.wValue != CurrentTransferTag) + { + TMCRequestStatus = TMC_STATUS_TRANSFER_NOT_IN_PROGRESS; } else { @@ -144,11 +161,14 @@ void EVENT_USB_Device_UnhandledControlRequest(void) IsTMCBulkOUTReset = true; /* Save the split request for later checking when a new request is received */ - RequestInProgess = Req_InitiateAbortBulkOut; - - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SUCCESS); + RequestInProgress = Req_InitiateAbortBulkOut; } + + Endpoint_ClearSETUP(); + /* Write the request response byte */ + Endpoint_Write_Byte(TMCRequestStatus); + Endpoint_ClearIN(); Endpoint_ClearStatusStage(); } @@ -157,23 +177,21 @@ void EVENT_USB_Device_UnhandledControlRequest(void) case Req_CheckAbortBulkOutStatus: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT)) { - Endpoint_ClearSETUP(); - - /* Check to see the correct split request is in progress before the status can be retrieved */ - if (RequestInProgess != Req_InitiateAbortBulkOut) - { - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SPLIT_NOT_IN_PROGRESS); - } + /* Check that an ABORT BULK OUT transaction has been requested and that the request has completed */ + if (RequestInProgress != Req_InitiateAbortBulkOut) + TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS; + else if (IsTMCBulkOUTReset) + TMCRequestStatus = TMC_STATUS_PENDING; else - { - // TODO: CLEAR BULK OUT - - /* Clear the pending split request value so that a new request can be made */ - RequestInProgess = 0; + RequestInProgress = 0; + + Endpoint_ClearSETUP(); + + /* Write the request response bytes */ + Endpoint_Write_Byte(TMCRequestStatus); + Endpoint_Write_Word_LE(0); + Endpoint_Write_DWord_LE(0); // TODO - Last transfer length - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SUCCESS); - } - Endpoint_ClearIN(); Endpoint_ClearStatusStage(); } @@ -182,24 +200,30 @@ void EVENT_USB_Device_UnhandledControlRequest(void) case Req_InitiateAbortBulkIn: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT)) { - Endpoint_ClearSETUP(); - - /* Check to see if a split request is already being processed before starting a new one */ - if (RequestInProgess != 0) + /* Check that no split transaction is already in progress and the data transfer tag is valid */ + if (RequestInProgress != 0) { - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SPLIT_IN_PROGRESS); + TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS; + } + else if (USB_ControlRequest.wValue != CurrentTransferTag) + { + TMCRequestStatus = TMC_STATUS_TRANSFER_NOT_IN_PROGRESS; } else { /* Indicate that all in-progress/pending data IN requests should be aborted */ - IsTMCBulkINReset = true; + IsTMCBulkINReset = true; /* Save the split request for later checking when a new request is received */ - RequestInProgess = Req_InitiateAbortBulkIn; - - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SUCCESS); + RequestInProgress = Req_InitiateAbortBulkIn; } + + Endpoint_ClearSETUP(); + /* Write the request response bytes */ + Endpoint_Write_Byte(TMCRequestStatus); + Endpoint_Write_Byte(CurrentTransferTag); + Endpoint_ClearIN(); Endpoint_ClearStatusStage(); } @@ -208,37 +232,33 @@ void EVENT_USB_Device_UnhandledControlRequest(void) case Req_CheckAbortBulkInStatus: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT)) { - Endpoint_ClearSETUP(); - - /* Check to see the correct split request is in progress before the status can be retrieved */ - if (RequestInProgess != Req_InitiateAbortBulkIn) - { - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SPLIT_NOT_IN_PROGRESS); - } + /* Check that an ABORT BULK IN transaction has been requested and that the request has completed */ + if (RequestInProgress != Req_InitiateAbortBulkIn) + TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS; + else if (IsTMCBulkINReset) + TMCRequestStatus = TMC_STATUS_PENDING; else - { - // TODO: CLEAR BULK IN - - /* Clear the pending split request value so that a new request can be made */ - RequestInProgess = 0; + RequestInProgress = 0; + + Endpoint_ClearSETUP(); + + /* Write the request response bytes */ + Endpoint_Write_Byte(TMCRequestStatus); + Endpoint_Write_Word_LE(0); + Endpoint_Write_DWord_LE(0); // TODO - Last transfer length - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SUCCESS); - } - Endpoint_ClearIN(); - Endpoint_ClearStatusStage(); + Endpoint_ClearStatusStage(); } break; case Req_InitiateClear: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) { - Endpoint_ClearSETUP(); - - /* Check to see if a split request is already being processed before starting a new one */ - if (RequestInProgess != 0) + /* Check that no split transaction is already in progress */ + if (RequestInProgress != 0) { - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SPLIT_IN_PROGRESS); + Endpoint_Write_Byte(TMC_STATUS_SPLIT_IN_PROGRESS); } else { @@ -247,11 +267,14 @@ void EVENT_USB_Device_UnhandledControlRequest(void) IsTMCBulkOUTReset = true; /* Save the split request for later checking when a new request is received */ - RequestInProgess = Req_InitiateClear; - - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SUCCESS); + RequestInProgress = Req_InitiateClear; } + + Endpoint_ClearSETUP(); + /* Write the request response byte */ + Endpoint_Write_Byte(TMCRequestStatus); + Endpoint_ClearIN(); Endpoint_ClearStatusStage(); } @@ -260,22 +283,19 @@ void EVENT_USB_Device_UnhandledControlRequest(void) case Req_CheckClearStatus: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) { - Endpoint_ClearSETUP(); - - /* Check to see the correct split request is in progress before the status can be retrieved */ - if (RequestInProgess != Req_InitiateClear) - { - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SPLIT_NOT_IN_PROGRESS); - } + /* Check that a CLEAR transaction has been requested and that the request has completed */ + if (RequestInProgress != Req_InitiateClear) + TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS; + else if (IsTMCBulkINReset || IsTMCBulkOUTReset) + TMCRequestStatus = TMC_STATUS_PENDING; else - { - // TODO: CLEAR STATUS - - /* Clear the pending split request value so that a new request can be made */ - RequestInProgess = 0; + RequestInProgress = 0; - Endpoint_Write_Byte(TMC_REQUEST_STATUS_SUCCESS); - } + Endpoint_ClearSETUP(); + + /* Write the request response bytes */ + Endpoint_Write_Byte(TMCRequestStatus); + Endpoint_Write_Byte(0); Endpoint_ClearIN(); Endpoint_ClearStatusStage(); @@ -285,34 +305,103 @@ void EVENT_USB_Device_UnhandledControlRequest(void) case Req_GetCapabilities: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) { - /* Acknowledge the SETUP packet, ready for data transfer */ Endpoint_ClearSETUP(); /* Write the device capabilities to the control endpoint */ - Endpoint_Write_Control_Stream_LE(&Capabilities, sizeof(TMC_Capabilities_t)); - - /* Finalize the stream transfer to send the last packet or clear the host abort */ + Endpoint_Write_Control_Stream_LE(&Capabilities, sizeof(TMC_Capabilities_t)); Endpoint_ClearOUT(); } break; } } - + +/** Function to manage TMC data transmission and reception to and from the host. */ void TMC_Task(void) { /* Device must be connected and configured for the task to run */ if (USB_DeviceState != DEVICE_STATE_Configured) return; - - Endpoint_SelectEndpoint(TMC_OUT_EPNUM); - if (Endpoint_IsOUTReceived()) + TMC_MessageHeader_t MessageHeader; + + /* Try to read in a TMC message from the interface, process if one is available */ + if (ReadTMCHeader(&MessageHeader)) { - // TEMP - Indicate data received - LEDs_SetAllLEDs(LEDS_ALL_LEDS); - Endpoint_ClearOUT(); + /* Indicate busy */ + LEDs_SetAllLEDs(LEDMASK_USB_BUSY); + + switch (MessageHeader.MessageID) + { + case TMC_MESSAGEID_DEV_DEP_MSG_OUT: + Endpoint_Discard_Stream(MessageHeader.TransferSize, StreamCallback_AbortOUTOnRequest); + Endpoint_ClearOUT(); + break; + case TMC_MESSAGEID_DEV_DEP_MSG_IN: + Endpoint_ClearOUT(); + + MessageHeader.TransferSize = 3; + WriteTMCHeader(&MessageHeader); + + Endpoint_Write_Stream_LE("TMC", 3, StreamCallback_AbortINOnRequest); + Endpoint_ClearIN(); + break; + default: + Endpoint_StallTransaction(); + break; + } + + LEDs_SetAllLEDs(LEDMASK_USB_READY); } + + /* All pending data has been processed - reset the data abort flags */ + IsTMCBulkINReset = false; + IsTMCBulkOUTReset = false; +} + +/** Attempts to read in the TMC message header from the TMC interface. + * + * \param[out] MessageHeader Pointer to a location where the read header (if any) should be stored + * + * \return Boolean true if a header was read, false otherwise + */ +bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader) +{ + /* Select the Data Out endpoint */ + Endpoint_SelectEndpoint(TMC_OUT_EPNUM); + + /* Abort if no command has been sent from the host */ + if (!(Endpoint_IsOUTReceived())) + return false; + + /* Read in the header of the command from the host */ + Endpoint_Read_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), StreamCallback_AbortOUTOnRequest); + + /* Store the new command tag value for later use */ + CurrentTransferTag = MessageHeader->Tag; + + /* Indicate if the command has been aborted or not */ + return !(IsTMCBulkOUTReset); +} + +bool WriteTMCHeader(TMC_MessageHeader_t* const MessageHeader) +{ + /* Compute the next transfer tag value, must be between 1 and 254 */ + if (++CurrentTransferTag == 0xFF) + CurrentTransferTag = 1; + + /* Set the message tag of the command header */ + MessageHeader->Tag = CurrentTransferTag; + MessageHeader->InverseTag = ~CurrentTransferTag; + + /* Select the Data In endpoint */ + Endpoint_SelectEndpoint(TMC_IN_EPNUM); + + /* Send the command header to the host */ + Endpoint_Write_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), StreamCallback_AbortINOnRequest); + + /* Indicate if the command has been aborted or not */ + return !(IsTMCBulkINReset); } /** Stream callback function for the Endpoint stream write functions. This callback will abort the current stream transfer @@ -340,3 +429,4 @@ uint8_t StreamCallback_AbortOUTOnRequest(void) /* Continue with the current stream operation */ return STREAMCALLBACK_Continue; } +