X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/ac0ece0141fe9470539380fb5e5f069a0ff701ff..77a9df36a77d2523dd2bc24fa17f9f04c6c175c5:/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c diff --git a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c index 6a2cff409..08c50c736 100644 --- a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c +++ b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com + www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted @@ -30,6 +30,43 @@ #include "TestAndMeasurement.h" +/** Contains the (usually static) capabilities of the TMC device. This table is requested by the + * host upon enumeration to give it information on what features of the Test and Measurement USB + * Class the device supports. + */ +TMC_Capabilities_t Capabilities = + { + .Status = TMC_STATUS_SUCCESS, + .TMCVersion = VERSION_BCD(1.00), + + .Interface = + { + .ListenOnly = false, + .TalkOnly = false, + .PulseIndicateSupported = false, + }, + + .Device = + { + .SupportsAbortINOnMatch = false, + }, + }; + +/** Current TMC control request that is being processed */ +static uint8_t RequestInProgress = 0; + +/** Stream callback abort flag for bulk IN data */ +static bool IsTMCBulkINReset = false; + +/** Stream callback abort flag for bulk OUT data */ +static bool IsTMCBulkOUTReset = false; + +/** Last used tag value for data transfers */ +static uint8_t CurrentTransferTag = 0; + +/** Length of last data transfer, for reporting to the host in case an in-progress transfer is aborted */ +static uint32_t LastTransferLength = 0; + /** Main program entry point. This routine contains the overall program flow, including initial * setup of all components and the main program loop. */ @@ -62,95 +99,343 @@ 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)) { - + /* Check that no split transaction is already in progress and the data transfer tag is valid */ + if (RequestInProgress != 0) + { + 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 OUT requests should be aborted */ + IsTMCBulkOUTReset = true; + + /* Save the split request for later checking when a new request is received */ + RequestInProgress = Req_InitiateAbortBulkOut; + } + + Endpoint_ClearSETUP(); + + /* Write the request response byte */ + Endpoint_Write_8(TMCRequestStatus); + + Endpoint_ClearIN(); + Endpoint_ClearStatusStage(); } break; case Req_CheckAbortBulkOutStatus: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT)) { - + /* 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 + RequestInProgress = 0; + + Endpoint_ClearSETUP(); + + /* Write the request response bytes */ + Endpoint_Write_8(TMCRequestStatus); + Endpoint_Write_16_LE(0); + Endpoint_Write_32_LE(LastTransferLength); + + Endpoint_ClearIN(); + Endpoint_ClearStatusStage(); } break; case Req_InitiateAbortBulkIn: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT)) { - + /* Check that no split transaction is already in progress and the data transfer tag is valid */ + if (RequestInProgress != 0) + { + 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; + + /* Save the split request for later checking when a new request is received */ + RequestInProgress = Req_InitiateAbortBulkIn; + } + + Endpoint_ClearSETUP(); + + /* Write the request response bytes */ + Endpoint_Write_8(TMCRequestStatus); + Endpoint_Write_8(CurrentTransferTag); + + Endpoint_ClearIN(); + Endpoint_ClearStatusStage(); } break; case Req_CheckAbortBulkInStatus: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT)) { - + /* 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 + RequestInProgress = 0; + + Endpoint_ClearSETUP(); + + /* Write the request response bytes */ + Endpoint_Write_8(TMCRequestStatus); + Endpoint_Write_16_LE(0); + Endpoint_Write_32_LE(LastTransferLength); + + Endpoint_ClearIN(); + Endpoint_ClearStatusStage(); } break; case Req_InitiateClear: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) { - + /* Check that no split transaction is already in progress */ + if (RequestInProgress != 0) + { + Endpoint_Write_8(TMC_STATUS_SPLIT_IN_PROGRESS); + } + else + { + /* Indicate that all in-progress/pending data IN and OUT requests should be aborted */ + IsTMCBulkINReset = true; + IsTMCBulkOUTReset = true; + + /* Save the split request for later checking when a new request is received */ + RequestInProgress = Req_InitiateClear; + } + + Endpoint_ClearSETUP(); + + /* Write the request response byte */ + Endpoint_Write_8(TMCRequestStatus); + + Endpoint_ClearIN(); + Endpoint_ClearStatusStage(); } break; case Req_CheckClearStatus: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) { - + /* 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 + RequestInProgress = 0; + + Endpoint_ClearSETUP(); + + /* Write the request response bytes */ + Endpoint_Write_8(TMCRequestStatus); + Endpoint_Write_8(0); + + Endpoint_ClearIN(); + Endpoint_ClearStatusStage(); } break; case Req_GetCapabilities: if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) { - + Endpoint_ClearSETUP(); + + /* Write the device capabilities to the control endpoint */ + 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; + + TMC_MessageHeader_t MessageHeader; + uint16_t BytesTransferred; + + /* Try to read in a TMC message from the interface, process if one is available */ + if (ReadTMCHeader(&MessageHeader)) + { + /* Indicate busy */ + LEDs_SetAllLEDs(LEDMASK_USB_BUSY); + + switch (MessageHeader.MessageID) + { + case TMC_MESSAGEID_DEV_DEP_MSG_OUT: + BytesTransferred = 0; + while (Endpoint_Discard_Stream(MessageHeader.TransferSize, &BytesTransferred) == + ENDPOINT_RWSTREAM_IncompleteTransfer) + { + if (IsTMCBulkOUTReset) + break; + } + LastTransferLength = BytesTransferred; + + Endpoint_ClearOUT(); + break; + case TMC_MESSAGEID_DEV_DEP_MSG_IN: + Endpoint_ClearOUT(); + + char MessageData[] = "TMC Class Test"; + + MessageHeader.TransferSize = strlen(MessageData); + MessageHeader.MessageIDSpecific.DeviceOUT.LastMessageTransaction = true; + WriteTMCHeader(&MessageHeader); + + BytesTransferred = 0; + while (Endpoint_Write_Stream_LE(MessageData, MessageHeader.TransferSize, &BytesTransferred) == + ENDPOINT_RWSTREAM_IncompleteTransfer) + { + if (IsTMCBulkINReset) + break; + } + LastTransferLength = BytesTransferred; + + 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) +{ + uint16_t BytesTransferred; + uint8_t ErrorCode; + + /* 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 */ + BytesTransferred = 0; + while ((ErrorCode = Endpoint_Read_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), &BytesTransferred)) == + ENDPOINT_RWSTREAM_IncompleteTransfer) + { + if (IsTMCBulkOUTReset) + break; + } + + /* Store the new command tag value for later use */ + CurrentTransferTag = MessageHeader->Tag; + + /* Indicate if the command has been aborted or not */ + return (!(IsTMCBulkOUTReset) && (ErrorCode == ENDPOINT_RWSTREAM_NoError)); +} + +bool WriteTMCHeader(TMC_MessageHeader_t* const MessageHeader) +{ + uint16_t BytesTransferred; + uint8_t ErrorCode; + + /* 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 */ + BytesTransferred = 0; + while ((ErrorCode = Endpoint_Write_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), &BytesTransferred)) == + ENDPOINT_RWSTREAM_IncompleteTransfer) + { + if (IsTMCBulkINReset) + break; + } + + /* Indicate if the command has been aborted or not */ + return (!(IsTMCBulkINReset) && (ErrorCode == ENDPOINT_RWSTREAM_NoError)); }