andy/tinyUSB
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #3173 from HiFiPhile/feature/usbtmc_vendor-specific

Browse Source 
feature(usbtmc): add support for usbtmc vendor-spicific command messages
This commit is contained in:
Ha Thach
2025-07-26 20:57:22 +07:00
committed by GitHub
parent e1509ba0bb be114549c4
commit a72f0396c7
1 changed files with 344 additions and 412 deletions
Download Patch File Download Diff File Expand all files Collapse all files

260
src/class/usbtmc/usbtmc_device.c
View File

@@ -45,7 +45,7 @@
*/
//Limitations:
// "vendor-specific" commands are not handled.
// "vendor-specific" commands are handled similar to normal messages, except that the MsgID is changed to "vendor-specific".
// Dealing with "termchar" must be handled by the application layer,
// though additional error checking is does in this module.
// talkOnly and listenOnly are NOT supported. They're not permitted
@@ -76,11 +76,6 @@
#include "usbtmc_device.h"
#ifdef xDEBUG
#include "uart_util.h"
tu_static char logMsg[150];
#endif
// Buffer size must be an exact multiple of the max packet size for both
// bulk (up to 64 bytes for FS, 512 bytes for HS). In addation, this driver
// imposes a minimum buffer size of 32 bytes.
@@ -96,8 +91,7 @@ tu_static char logMsg[150];
* consistent with USBTMC.
*/
typedef enum
{
typedef enum {
STATE_CLOSED,// Endpoints have not yet been opened since USB reset
STATE_NAK, // Bulk-out endpoint is in NAK state.
STATE_IDLE, // Bulk-out endpoint is waiting for CMD.
@@ -171,26 +165,26 @@ tu_static uint8_t termChar;
tu_static uint8_t termCharRequested = false;
tu_static bool usbtmcVendorSpecificRequested = false;
#if OSAL_MUTEX_REQUIRED
static OSAL_MUTEX_DEF(usbtmcLockBuffer);
#endif
osal_mutex_t usbtmcLock;
// Our own private lock, mostly for the state variable.
#define criticalEnter() do { (void) osal_mutex_lock(usbtmcLock,OSAL_TIMEOUT_WAIT_FOREVER); } while (0)
#define criticalLeave() do { (void) osal_mutex_unlock(usbtmcLock); } while (0)
#define criticalEnter() \
do { (void) osal_mutex_lock(usbtmcLock, OSAL_TIMEOUT_WAIT_FOREVER); } while (0)
#define criticalLeave() \
do { (void) osal_mutex_unlock(usbtmcLock); } while (0)
static bool atomicChangeState(usbtmcd_state_enum expectedState, usbtmcd_state_enum newState)
{
static bool atomicChangeState(usbtmcd_state_enum expectedState, usbtmcd_state_enum newState) {
bool ret = true;
criticalEnter();
usbtmcd_state_enum oldState = usbtmc_state.state;
if (oldState == expectedState)
{
if (oldState == expectedState) {
usbtmc_state.state = newState;
}
else
{
} else {
ret = false;
}
criticalLeave();
@@ -207,16 +201,14 @@ static bool atomicChangeState(usbtmcd_state_enum expectedState, usbtmcd_state_en
bool tud_usbtmc_transmit_dev_msg_data(
const void *data, size_t len,
bool endOfMessage,
bool usingTermChar)
{
bool usingTermChar) {
const unsigned int txBufLen = USBTMCD_BUFFER_SIZE;
#ifndef NDEBUG
TU_ASSERT(len > 0u);
TU_ASSERT(len <= usbtmc_state.transfer_size_remaining);
TU_ASSERT(usbtmc_state.transfer_size_sent == 0u);
if(usingTermChar)
{
if (usingTermChar) {
TU_ASSERT(usbtmc_state.capabilities->bmDevCapabilities.canEndBulkInOnTermChar);
TU_ASSERT(termCharRequested);
TU_ASSERT(((uint8_t const *) data)[len - 1u] == termChar);
@@ -226,7 +218,11 @@ bool tud_usbtmc_transmit_dev_msg_data(
TU_VERIFY(usbtmc_state.state == STATE_TX_REQUESTED);
usbtmc_msg_dev_dep_msg_in_header_t *hdr = (usbtmc_msg_dev_dep_msg_in_header_t *) usbtmc_epbuf.epin;
tu_varclr(hdr);
if (usbtmcVendorSpecificRequested) {
hdr->header.MsgID = USBTMC_MSGID_VENDOR_SPECIFIC_IN;
} else {
hdr->header.MsgID = USBTMC_MSGID_DEV_DEP_MSG_IN;
}
hdr->header.bTag = usbtmc_state.lastBulkInTag;
hdr->header.bTagInverse = (uint8_t) ~(usbtmc_state.lastBulkInTag);
hdr->TransferSize = len;
@@ -235,8 +231,7 @@ bool tud_usbtmc_transmit_dev_msg_data(
// Copy in the header
const size_t headerLen = sizeof(*hdr);
const size_t dataLen = ((headerLen + hdr->TransferSize) <= txBufLen) ?
len : (txBufLen - headerLen);
const size_t dataLen = ((headerLen + hdr->TransferSize) <= txBufLen) ? len : (txBufLen - headerLen);
const size_t packetLen = headerLen + dataLen;
memcpy((uint8_t *) (usbtmc_epbuf.epin) + headerLen, data, dataLen);
@@ -251,8 +246,7 @@ bool tud_usbtmc_transmit_dev_msg_data(
return true;
}
bool tud_usbtmc_transmit_notification_data(const void * data, size_t len)
{
bool tud_usbtmc_transmit_notification_data(const void *data, size_t len) {
#ifndef NDEBUG
TU_ASSERT(len > 0);
TU_ASSERT(usbtmc_state.ep_int_in != 0);
@@ -264,8 +258,7 @@ bool tud_usbtmc_transmit_notification_data(const void * data, size_t len)
return true;
}
void usbtmcd_init_cb(void)
{
void usbtmcd_init_cb(void) {
usbtmc_state.capabilities = tud_usbtmc_get_capabilities_cb();
#ifndef NDEBUG
#if CFG_TUD_USBTMC_ENABLE_488
@@ -291,8 +284,7 @@ bool usbtmcd_deinit(void) {
return true;
}
uint16_t usbtmcd_open_cb(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len)
{
uint16_t usbtmcd_open_cb(uint8_t rhport, tusb_desc_interface_t const *itf_desc, uint16_t max_len) {
(void) rhport;
uint16_t drv_len;
@@ -316,17 +308,14 @@ uint16_t usbtmcd_open_cb(uint8_t rhport, tusb_desc_interface_t const * itf_desc,
usbtmc_state.itf_id = itf_desc->bInterfaceNumber;
usbtmc_state.rhport = rhport;
while (found_endpoints < itf_desc->bNumEndpoints && drv_len <= max_len)
{
if ( TUSB_DESC_ENDPOINT == p_desc[DESC_OFFSET_TYPE])
{
while (found_endpoints < itf_desc->bNumEndpoints && drv_len <= max_len) {
if (TUSB_DESC_ENDPOINT == p_desc[DESC_OFFSET_TYPE]) {
tusb_desc_endpoint_t const *ep_desc = (tusb_desc_endpoint_t const *) p_desc;
switch (ep_desc->bmAttributes.xfer) {
case TUSB_XFER_BULK:
// Ensure buffer is an exact multiple of the maxPacketSize
TU_ASSERT((USBTMCD_BUFFER_SIZE % tu_edpt_packet_size(ep_desc)) == 0, 0);
if (tu_edpt_dir(ep_desc->bEndpointAddress) == TUSB_DIR_IN)
{
if (tu_edpt_dir(ep_desc->bEndpointAddress) == TUSB_DIR_IN) {
usbtmc_state.ep_bulk_in = ep_desc->bEndpointAddress;
usbtmc_state.ep_bulk_in_wMaxPacketSize = tu_edpt_packet_size(ep_desc);
} else {
@@ -357,18 +346,14 @@ uint16_t usbtmcd_open_cb(uint8_t rhport, tusb_desc_interface_t const * itf_desc,
#ifndef NDEBUG
TU_ASSERT(usbtmc_state.ep_bulk_in != 0, 0);
TU_ASSERT(usbtmc_state.ep_bulk_out != 0, 0);
if (itf_desc->bNumEndpoints == 2)
{
if (itf_desc->bNumEndpoints == 2) {
TU_ASSERT(usbtmc_state.ep_int_in == 0, 0);
}
else if (itf_desc->bNumEndpoints == 3)
{
} else if (itf_desc->bNumEndpoints == 3) {
TU_ASSERT(usbtmc_state.ep_int_in != 0, 0);
}
#if (CFG_TUD_USBTMC_ENABLE_488)
if (usbtmc_state.capabilities->bmIntfcCapabilities488.is488_2 ||
usbtmc_state.capabilities->bmDevCapabilities488.SR1)
{
usbtmc_state.capabilities->bmDevCapabilities488.SR1) {
TU_ASSERT(usbtmc_state.ep_int_in != 0, 0);
}
#endif
@@ -384,11 +369,9 @@ uint16_t usbtmcd_open_cb(uint8_t rhport, tusb_desc_interface_t const * itf_desc,
// processing a command (such as a clear). Returns true if it was
// in the NAK state and successfully transitioned to the ACK wait
// state.
bool tud_usbtmc_start_bus_read(void)
{
bool tud_usbtmc_start_bus_read(void) {
usbtmcd_state_enum oldState = usbtmc_state.state;
switch(oldState)
{
switch (oldState) {
// These may transition to IDLE
case STATE_NAK:
case STATE_ABORTING_BULK_IN_ABORTED:
@@ -404,8 +387,7 @@ bool tud_usbtmc_start_bus_read(void)
return true;
}
void usbtmcd_reset_cb(uint8_t rhport)
{
void usbtmcd_reset_cb(uint8_t rhport) {
(void) rhport;
usbtmc_capabilities_specific_t const *capabilities = tud_usbtmc_get_capabilities_cb();
@@ -416,8 +398,7 @@ void usbtmcd_reset_cb(uint8_t rhport)
criticalLeave();
}
static bool handle_devMsgOutStart(uint8_t rhport, void *data, size_t len)
{
static bool handle_devMsgOutStart(uint8_t rhport, void *data, size_t len) {
(void) rhport;
// return true upon failure, as we can assume error is being handled elsewhere.
TU_VERIFY(atomicChangeState(STATE_IDLE, STATE_RCV), true);
@@ -433,8 +414,7 @@ static bool handle_devMsgOutStart(uint8_t rhport, void *data, size_t len)
return true;
}
static bool handle_devMsgOut(uint8_t rhport, void *data, size_t len, size_t packetLen)
{
static bool handle_devMsgOut(uint8_t rhport, void *data, size_t len, size_t packetLen) {
(void) rhport;
// return true upon failure, as we can assume error is being handled elsewhere.
TU_VERIFY(usbtmc_state.state == STATE_RCV, true);
@@ -443,8 +423,7 @@ static bool handle_devMsgOut(uint8_t rhport, void *data, size_t len, size_t pack
// Packet is to be considered complete when we get enough data or at a short packet.
bool atEnd = false;
if(len >= usbtmc_state.transfer_size_remaining || shortPacket)
{
if (len >= usbtmc_state.transfer_size_remaining || shortPacket) {
atEnd = true;
TU_VERIFY(atomicChangeState(STATE_RCV, STATE_NAK));
}
@@ -455,8 +434,7 @@ static bool handle_devMsgOut(uint8_t rhport, void *data, size_t len, size_t pack
usbtmc_state.transfer_size_sent += len;
// App may (should?) call the wait_for_bus() command at this point
if(!tud_usbtmc_msg_data_cb(data, len, atEnd))
{
if (!tud_usbtmc_msg_data_cb(data, len, atEnd)) {
// TODO: Go to an error state upon failure other than just stalling the EP?
return false;
}
@@ -465,8 +443,7 @@ static bool handle_devMsgOut(uint8_t rhport, void *data, size_t len, size_t pack
return true;
}
static bool handle_devMsgIn(void *data, size_t len)
{
static bool handle_devMsgIn(void *data, size_t len) {
TU_VERIFY(len == sizeof(usbtmc_msg_request_dev_dep_in));
usbtmc_msg_request_dev_dep_in *msg = (usbtmc_msg_request_dev_dep_in *) data;
bool stateChanged = atomicChangeState(STATE_IDLE, STATE_TX_REQUESTED);
@@ -488,22 +465,18 @@ static bool handle_devMsgIn(void *data, size_t len)
return true;
}
bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes)
{
bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
TU_VERIFY(result == XFER_RESULT_SUCCESS);
//uart_tx_str_sync("TMC XFER CB\r\n");
if (usbtmc_state.state == STATE_CLEARING) {
return true; /* I think we can ignore everything here */
}
if(ep_addr == usbtmc_state.ep_bulk_out)
{
if (ep_addr == usbtmc_state.ep_bulk_out) {
usbtmc_msg_generic_t *msg = NULL;
switch(usbtmc_state.state)
{
case STATE_IDLE:
{
switch (usbtmc_state.state) {
case STATE_IDLE: {
TU_VERIFY(xferred_bytes >= sizeof(usbtmc_msg_generic_t));
msg = (usbtmc_msg_generic_t *) (usbtmc_epbuf.epout);
uint8_t invInvTag = (uint8_t) ~(msg->header.bTagInverse);
@@ -512,14 +485,15 @@ bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint
switch (msg->header.MsgID) {
case USBTMC_MSGID_DEV_DEP_MSG_OUT:
if(!handle_devMsgOutStart(rhport, msg, xferred_bytes))
{
usbtmcVendorSpecificRequested = false;
if (!handle_devMsgOutStart(rhport, msg, xferred_bytes)) {
usbd_edpt_stall(rhport, usbtmc_state.ep_bulk_out);
return false;
}
break;
case USBTMC_MSGID_DEV_DEP_MSG_IN:
usbtmcVendorSpecificRequested = false;
TU_VERIFY(handle_devMsgIn(msg, xferred_bytes));
break;
@@ -532,7 +506,18 @@ bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint
break;
#endif
case USBTMC_MSGID_VENDOR_SPECIFIC_MSG_OUT:
usbtmcVendorSpecificRequested = true;
if (!handle_devMsgOutStart(rhport, msg, xferred_bytes)) {
usbd_edpt_stall(rhport, usbtmc_state.ep_bulk_out);
return false;
}
break;
case USBTMC_MSGID_VENDOR_SPECIFIC_IN:
usbtmcVendorSpecificRequested = true;
TU_VERIFY(handle_devMsgIn(msg, xferred_bytes));
break;
default:
usbd_edpt_stall(rhport, usbtmc_state.ep_bulk_out);
return false;
@@ -540,8 +525,7 @@ bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint
return true;
}
case STATE_RCV:
if(!handle_devMsgOut(rhport, usbtmc_epbuf.epout, xferred_bytes, xferred_bytes))
{
if (!handle_devMsgOut(rhport, usbtmc_epbuf.epout, xferred_bytes, xferred_bytes)) {
usbd_edpt_stall(rhport, usbtmc_state.ep_bulk_out);
return false;
}
@@ -559,9 +543,7 @@ bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint
default:
return false;
}
}
else if(ep_addr == usbtmc_state.ep_bulk_in)
{
} else if (ep_addr == usbtmc_state.ep_bulk_in) {
switch (usbtmc_state.state) {
case STATE_TX_SHORTED:
TU_VERIFY(atomicChangeState(STATE_TX_SHORTED, STATE_NAK));
@@ -569,25 +551,22 @@ bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint
break;
case STATE_TX_INITIATED:
if(usbtmc_state.transfer_size_remaining >= USBTMCD_BUFFER_SIZE)
{
if (usbtmc_state.transfer_size_remaining >= USBTMCD_BUFFER_SIZE) {
// Copy buffer to ensure alignment correctness
memcpy(usbtmc_epbuf.epin, usbtmc_state.devInBuffer, USBTMCD_BUFFER_SIZE);
TU_VERIFY(usbd_edpt_xfer(rhport, usbtmc_state.ep_bulk_in, usbtmc_epbuf.epin, USBTMCD_BUFFER_SIZE));
usbtmc_state.devInBuffer += USBTMCD_BUFFER_SIZE;
usbtmc_state.transfer_size_remaining -= USBTMCD_BUFFER_SIZE;
usbtmc_state.transfer_size_sent += USBTMCD_BUFFER_SIZE;
}
else // last packet
} else// last packet
{
size_t packetLen = usbtmc_state.transfer_size_remaining;
memcpy(usbtmc_epbuf.epin, usbtmc_state.devInBuffer, usbtmc_state.transfer_size_remaining);
usbtmc_state.transfer_size_sent += sizeof(usbtmc_state.transfer_size_remaining);
usbtmc_state.transfer_size_sent += packetLen;
usbtmc_state.transfer_size_remaining = 0;
usbtmc_state.devInBuffer = NULL;
TU_VERIFY(usbd_edpt_xfer(rhport, usbtmc_state.ep_bulk_in, usbtmc_epbuf.epin, (uint16_t) packetLen));
if(((packetLen % usbtmc_state.ep_bulk_in_wMaxPacketSize) != 0) || (packetLen == 0 ))
{
if (((packetLen % usbtmc_state.ep_bulk_in_wMaxPacketSize) != 0) || (packetLen == 0)) {
usbtmc_state.state = STATE_TX_SHORTED;
}
}
@@ -607,8 +586,7 @@ bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint
default:
TU_ASSERT(false);
}
}
else if (ep_addr == usbtmc_state.ep_int_in) {
} else if (ep_addr == usbtmc_state.ep_int_in) {
if (tud_usbtmc_notification_complete_cb) {
TU_VERIFY(tud_usbtmc_notification_complete_cb());
}
@@ -620,8 +598,7 @@ bool usbtmcd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint
// Invoked when a control transfer occurred on an interface of this class
// Driver response accordingly to the request and the transfer stage (setup/data/ack)
// return false to stall control endpoint (e.g unsupported request)
bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
{
bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const *request) {
// nothing to do with DATA and ACK stage
if (stage != CONTROL_STAGE_SETUP) return true;
@@ -633,54 +610,43 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
if ((request->bmRequestType_bit.type == TUSB_REQ_TYPE_STANDARD) &&
(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_ENDPOINT) &&
(request->bRequest == TUSB_REQ_CLEAR_FEATURE) &&
(request->wValue == TUSB_REQ_FEATURE_EDPT_HALT))
{
(request->wValue == TUSB_REQ_FEATURE_EDPT_HALT)) {
uint32_t ep_addr = (request->wIndex);
// At this point, a transfer MAY be in progress. Based on USB spec, when clearing bulk EP HALT,
// the EP transfer buffer needs to be cleared and DTOG needs to be reset, even if
// the EP is not halted. The only USBD API interface to do this is to stall and then un-stall the EP.
if(ep_addr == usbtmc_state.ep_bulk_out)
{
if (ep_addr == usbtmc_state.ep_bulk_out) {
criticalEnter();
usbd_edpt_stall(rhport, (uint8_t) ep_addr);
usbd_edpt_clear_stall(rhport, (uint8_t) ep_addr);
usbtmc_state.state = STATE_NAK;// USBD core has placed EP in NAK state for us
criticalLeave();
tud_usbtmc_bulkOut_clearFeature_cb();
}
else if (ep_addr == usbtmc_state.ep_bulk_in)
{
} else if (ep_addr == usbtmc_state.ep_bulk_in) {
usbd_edpt_stall(rhport, (uint8_t) ep_addr);
usbd_edpt_clear_stall(rhport, (uint8_t) ep_addr);
tud_usbtmc_bulkIn_clearFeature_cb();
}
else if ((usbtmc_state.ep_int_in != 0) && (ep_addr == usbtmc_state.ep_int_in))
{
} else if ((usbtmc_state.ep_int_in != 0) && (ep_addr == usbtmc_state.ep_int_in)) {
// Clearing interrupt in EP
usbd_edpt_stall(rhport, (uint8_t) ep_addr);
usbd_edpt_clear_stall(rhport, (uint8_t) ep_addr);
}
else
{
} else {
return false;
}
return true;
}
// Otherwise, we only handle class requests.
if(request->bmRequestType_bit.type != TUSB_REQ_TYPE_CLASS)
{
if (request->bmRequestType_bit.type != TUSB_REQ_TYPE_CLASS) {
return false;
}
// Verification that we own the interface is unneeded since it's been routed to us specifically.
switch(request->bRequest)
{
switch (request->bRequest) {
// USBTMC required requests
case USBTMC_bREQUEST_INITIATE_ABORT_BULK_OUT:
{
case USBTMC_bREQUEST_INITIATE_ABORT_BULK_OUT: {
usbtmc_initiate_abort_rsp_t rsp = {
.bTag = usbtmc_state.lastBulkOutTag,
};
@@ -689,16 +655,11 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
TU_VERIFY(request->wIndex == usbtmc_state.ep_bulk_out);
// wValue is the requested bTag to abort
if(usbtmc_state.state != STATE_RCV)
{
if (usbtmc_state.state != STATE_RCV) {
rsp.USBTMC_status = USBTMC_STATUS_FAILED;
}
else if(usbtmc_state.lastBulkOutTag == (request->wValue & 0x7Fu))
{
} else if (usbtmc_state.lastBulkOutTag == (request->wValue & 0x7Fu)) {
rsp.USBTMC_status = USBTMC_STATUS_TRANSFER_NOT_IN_PROGRESS;
}
else
{
} else {
rsp.USBTMC_status = USBTMC_STATUS_SUCCESS;
// Check if we've queued a short packet
criticalEnter();
@@ -711,12 +672,10 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
return true;
}
case USBTMC_bREQUEST_CHECK_ABORT_BULK_OUT_STATUS:
{
case USBTMC_bREQUEST_CHECK_ABORT_BULK_OUT_STATUS: {
usbtmc_check_abort_bulk_rsp_t rsp = {
.USBTMC_status = USBTMC_STATUS_SUCCESS,
.NBYTES_RXD_TXD = usbtmc_state.transfer_size_sent
};
.NBYTES_RXD_TXD = usbtmc_state.transfer_size_sent};
TU_VERIFY(request->bmRequestType == 0xA2);// in,class,EP
TU_VERIFY(request->wLength == sizeof(rsp));
TU_VERIFY(request->wIndex == usbtmc_state.ep_bulk_out);
@@ -725,8 +684,7 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
return true;
}
case USBTMC_bREQUEST_INITIATE_ABORT_BULK_IN:
{
case USBTMC_bREQUEST_INITIATE_ABORT_BULK_IN: {
usbtmc_initiate_abort_rsp_t rsp = {
.bTag = usbtmc_state.lastBulkInTag,
};
@@ -735,37 +693,29 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
TU_VERIFY(request->wIndex == usbtmc_state.ep_bulk_in);
// wValue is the requested bTag to abort
if ((usbtmc_state.state == STATE_TX_REQUESTED || usbtmc_state.state == STATE_TX_INITIATED) &&
usbtmc_state.lastBulkInTag == (request->wValue & 0x7Fu))
{
usbtmc_state.lastBulkInTag == (request->wValue & 0x7Fu)) {
rsp.USBTMC_status = USBTMC_STATUS_SUCCESS;
usbtmc_state.transfer_size_remaining = 0u;
// Check if we've queued a short packet
criticalEnter();
usbtmc_state.state = ((usbtmc_state.transfer_size_sent % usbtmc_state.ep_bulk_in_wMaxPacketSize) == 0) ?
STATE_ABORTING_BULK_IN : STATE_ABORTING_BULK_IN_SHORTED;
usbtmc_state.state = ((usbtmc_state.transfer_size_sent % usbtmc_state.ep_bulk_in_wMaxPacketSize) == 0) ? STATE_ABORTING_BULK_IN : STATE_ABORTING_BULK_IN_SHORTED;
criticalLeave();
if(usbtmc_state.transfer_size_sent == 0)
{
if (usbtmc_state.transfer_size_sent == 0) {
// Send short packet, nothing is in the buffer yet
TU_VERIFY(usbd_edpt_xfer(rhport, usbtmc_state.ep_bulk_in, usbtmc_epbuf.epin, (uint16_t) 0u));
usbtmc_state.state = STATE_ABORTING_BULK_IN_SHORTED;
}
TU_VERIFY(tud_usbtmc_initiate_abort_bulk_in_cb(&(rsp.USBTMC_status)));
}
else if((usbtmc_state.state == STATE_TX_REQUESTED || usbtmc_state.state == STATE_TX_INITIATED))
{ // FIXME: Unsure how to check if the OUT endpoint fifo is non-empty....
} else if ((usbtmc_state.state == STATE_TX_REQUESTED || usbtmc_state.state == STATE_TX_INITIATED)) {// FIXME: Unsure how to check if the OUT endpoint fifo is non-empty....
rsp.USBTMC_status = USBTMC_STATUS_TRANSFER_NOT_IN_PROGRESS;
}
else
{
} else {
rsp.USBTMC_status = USBTMC_STATUS_FAILED;
}
TU_VERIFY(tud_control_xfer(rhport, request, (void *) &rsp, sizeof(rsp)));
return true;
}
case USBTMC_bREQUEST_CHECK_ABORT_BULK_IN_STATUS:
{
case USBTMC_bREQUEST_CHECK_ABORT_BULK_IN_STATUS: {
TU_VERIFY(request->bmRequestType == 0xA2);// in,class,EP
TU_VERIFY(request->wLength == 8u);
@@ -774,14 +724,12 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
.USBTMC_status = USBTMC_STATUS_FAILED,
.bmAbortBulkIn =
{
.BulkInFifoBytes = (usbtmc_state.state != STATE_ABORTING_BULK_IN_ABORTED)
},
.BulkInFifoBytes = (usbtmc_state.state != STATE_ABORTING_BULK_IN_ABORTED)},
.NBYTES_RXD_TXD = usbtmc_state.transfer_size_sent,
};
TU_VERIFY(tud_usbtmc_check_abort_bulk_in_cb(&rsp));
criticalEnter();
switch(usbtmc_state.state)
{
switch (usbtmc_state.state) {
case STATE_ABORTING_BULK_IN_ABORTED:
rsp.USBTMC_status = USBTMC_STATUS_SUCCESS;
usbtmc_state.state = STATE_IDLE;
@@ -799,8 +747,7 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
return true;
}
case USBTMC_bREQUEST_INITIATE_CLEAR:
{
case USBTMC_bREQUEST_INITIATE_CLEAR: {
TU_VERIFY(request->bmRequestType == 0xA1);// in,class,interface
TU_VERIFY(request->wLength == sizeof(tmcStatusCode));
// After receiving an INITIATE_CLEAR request, the device must Halt the Bulk-OUT endpoint, queue the
@@ -815,25 +762,20 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
return true;
}
case USBTMC_bREQUEST_CHECK_CLEAR_STATUS:
{
case USBTMC_bREQUEST_CHECK_CLEAR_STATUS: {
TU_VERIFY(request->bmRequestType == 0xA1);// in,class,interface
usbtmc_get_clear_status_rsp_t clearStatusRsp = {0};
TU_VERIFY(request->wLength == sizeof(clearStatusRsp));
if(usbd_edpt_busy(rhport, usbtmc_state.ep_bulk_in))
{
if (usbd_edpt_busy(rhport, usbtmc_state.ep_bulk_in)) {
// Stuff stuck in TX buffer?
clearStatusRsp.bmClear.BulkInFifoBytes = 1;
clearStatusRsp.USBTMC_status = USBTMC_STATUS_PENDING;
}
else
{
} else {
// Let app check if it's clear
TU_VERIFY(tud_usbtmc_check_clear_cb(&clearStatusRsp));
}
if(clearStatusRsp.USBTMC_status == USBTMC_STATUS_SUCCESS)
{
if (clearStatusRsp.USBTMC_status == USBTMC_STATUS_SUCCESS) {
criticalEnter();
usbtmc_state.state = STATE_IDLE;
criticalLeave();
@@ -842,8 +784,7 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
return true;
}
case USBTMC_bREQUEST_GET_CAPABILITIES:
{
case USBTMC_bREQUEST_GET_CAPABILITIES: {
TU_VERIFY(request->bmRequestType == 0xA1);// in,class,interface
TU_VERIFY(request->wLength == sizeof(*(usbtmc_state.capabilities)));
TU_VERIFY(tud_control_xfer(rhport, request, (void *) (uintptr_t) usbtmc_state.capabilities, sizeof(*usbtmc_state.capabilities)));
@@ -863,8 +804,7 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
#if (CFG_TUD_USBTMC_ENABLE_488)
// USB488 required requests
case USB488_bREQUEST_READ_STATUS_BYTE:
{
case USB488_bREQUEST_READ_STATUS_BYTE: {
usbtmc_read_stb_rsp_488_t rsp;
TU_VERIFY(request->bmRequestType == 0xA1); // in,class,interface
TU_VERIFY(request->wLength == sizeof(rsp));// in,class,interface
@@ -876,15 +816,11 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
TU_VERIFY(request->wIndex == usbtmc_state.itf_id);
TU_VERIFY(request->wLength == 0x0003);
rsp.bTag = (uint8_t) bTag;
if(usbtmc_state.ep_int_in != 0)
{
if (usbtmc_state.ep_int_in != 0) {
rsp.statusByte = 0x00;// Use interrupt endpoint, instead. Must be 0x00 (USB488v1.0 4.3.1.2)
if(usbd_edpt_busy(rhport, usbtmc_state.ep_int_in))
{
if (usbd_edpt_busy(rhport, usbtmc_state.ep_int_in)) {
rsp.USBTMC_status = USB488_STATUS_INTERRUPT_IN_BUSY;
}
else
{
} else {
rsp.USBTMC_status = USBTMC_STATUS_SUCCESS;
usbtmc_read_stb_interrupt_488_t intMsg =
{
@@ -892,14 +828,11 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
.one = 1,
.bTag = bTag & 0x7Fu,
},
.StatusByte = tud_usbtmc_get_stb_cb(&(rsp.USBTMC_status))
};
.StatusByte = tud_usbtmc_get_stb_cb(&(rsp.USBTMC_status))};
// Must be queued before control request response sent (USB488v1.0 4.3.1.2)
usbd_edpt_xfer(rhport, usbtmc_state.ep_int_in, (void *) &intMsg, sizeof(intMsg));
}
}
else
{
} else {
rsp.statusByte = tud_usbtmc_get_stb_cb(&(rsp.USBTMC_status));
}
TU_VERIFY(tud_control_xfer(rhport, request, (void *) &rsp, sizeof(rsp)));
@@ -908,8 +841,7 @@ bool usbtmcd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
// USB488 optional requests
case USB488_bREQUEST_REN_CONTROL:
case USB488_bREQUEST_GO_TO_LOCAL:
case USB488_bREQUEST_LOCAL_LOCKOUT:
{
case USB488_bREQUEST_LOCAL_LOCKOUT: {
TU_VERIFY(request->bmRequestType == 0xA1);// in,class,interface
return false;
}