blackmagic-esp32-s2/components/tinyusb/drivers/dap-link/vendor_device.c

257 lines
8.4 KiB
C

/* SPDX-License-Identifier: MIT
*
* Copyright (c) 2022 Koji KITAYAMA
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE. */
#include "tusb_option.h"
#include "device/usbd.h"
#include "device/usbd_pvt.h"
#include "vendor_device.h"
// #include "DAP_config.h"
// #include "DAP.h"
#define DAP_PACKET_SIZE 64U
#define DAP_PACKET_COUNT 8U
#define ID_DAP_QueueCommands 0x7EU
#define ID_DAP_ExecuteCommands 0x7FU
#define ID_DAP_TransferAbort 0x07U
//--------------------------------------------------------------------+
// MACRO CONSTANT TYPEDEF
//--------------------------------------------------------------------+
typedef struct {
uint8_t itf_num;
uint8_t ep_in;
uint8_t ep_out;
/*------------- From this point, data is not cleared by bus reset -------------*/
uint8_t request_wp;
uint8_t request_rp;
uint8_t response_wp;
uint8_t response_rp;
uint8_t epout_sz[DAP_PACKET_COUNT];
uint8_t epin_sz[DAP_PACKET_COUNT];
// Endpoint Transfer buffer
CFG_TUSB_MEM_ALIGN uint8_t epout_buf[DAP_PACKET_COUNT][CFG_TUD_VENDOR_EPSIZE];
CFG_TUSB_MEM_ALIGN uint8_t epin_buf[DAP_PACKET_COUNT][CFG_TUD_VENDOR_EPSIZE];
} vendord_interface_t;
CFG_TUSB_MEM_SECTION static vendord_interface_t _vendord_itf[CFG_TUD_VENDOR];
#define ITF_MEM_RESET_SIZE offsetof(vendord_interface_t, epout_sz)
bool tud_vendor_n_mounted(uint8_t itf) {
return _vendord_itf[itf].ep_in && _vendord_itf[itf].ep_out;
}
//--------------------------------------------------------------------+
// Read API
//--------------------------------------------------------------------+
static void _prep_out_transaction(vendord_interface_t* p_itf) {
uint8_t const rhport = 0;
// skip if previous transfer not complete
if(usbd_edpt_busy(rhport, p_itf->ep_out)) return;
unsigned occupancy = p_itf->request_wp - p_itf->request_rp;
if(occupancy < DAP_PACKET_COUNT) {
unsigned idx = p_itf->request_wp % DAP_PACKET_COUNT;
usbd_edpt_xfer(rhport, p_itf->ep_out, p_itf->epout_buf[idx], CFG_TUD_VENDOR_EPSIZE);
}
}
uint32_t tud_vendor_n_acquire_request_buffer(uint8_t itf, const uint8_t** pbuf) {
TU_ASSERT(pbuf, 0);
vendord_interface_t* p_itf = &_vendord_itf[itf];
uint8_t rp = p_itf->request_rp;
uint8_t wp = p_itf->request_wp;
if(wp == rp) return 0;
unsigned idx = rp % DAP_PACKET_COUNT;
unsigned n = idx;
// Check if the last packet was received.
while((wp != rp) && (p_itf->epout_buf[n][0] == ID_DAP_QueueCommands)) {
++rp;
++n;
if(n == DAP_PACKET_COUNT) n = 0U;
}
if(wp == rp) // not received
return 0;
// Replace consecutive QueueCommands to ExecuteCommands
rp = p_itf->request_rp;
n = idx;
while((wp != rp) && (p_itf->epout_buf[n][0] == ID_DAP_QueueCommands)) {
p_itf->epout_buf[n][0] = ID_DAP_ExecuteCommands;
++rp;
++n;
if(n == DAP_PACKET_COUNT) n = 0U;
}
*pbuf = p_itf->epout_buf[idx];
return p_itf->epout_sz[idx];
}
void tud_vendor_n_release_request_buffer(uint8_t itf) {
vendord_interface_t* p_itf = &_vendord_itf[itf];
++p_itf->request_rp;
_prep_out_transaction(p_itf);
}
//--------------------------------------------------------------------+
// Write API
//--------------------------------------------------------------------+
static void maybe_transmit(vendord_interface_t* p_itf) {
uint8_t const rhport = 0;
// skip if previous transfer not complete
TU_VERIFY(!usbd_edpt_busy(rhport, p_itf->ep_in), );
if(p_itf->response_wp != p_itf->response_rp) {
unsigned idx = p_itf->response_rp % DAP_PACKET_COUNT;
TU_ASSERT(
usbd_edpt_xfer(rhport, p_itf->ep_in, p_itf->epin_buf[idx], p_itf->epin_sz[idx]), );
++p_itf->response_rp;
}
}
uint32_t tud_vendor_n_acquire_response_buffer(uint8_t itf, uint8_t** pbuf) {
TU_ASSERT(pbuf, 0);
vendord_interface_t* p_itf = &_vendord_itf[itf];
unsigned occupancy = p_itf->response_wp - p_itf->response_rp;
if(occupancy < DAP_PACKET_COUNT) {
unsigned idx = p_itf->response_wp % DAP_PACKET_COUNT;
*pbuf = p_itf->epin_buf[idx];
return DAP_PACKET_SIZE;
}
return 0;
}
void tud_vendor_n_release_response_buffer(uint8_t itf, uint32_t bufsize) {
vendord_interface_t* p_itf = &_vendord_itf[itf];
unsigned idx = p_itf->response_wp % DAP_PACKET_COUNT;
p_itf->epin_sz[idx] = bufsize;
++p_itf->response_wp;
maybe_transmit(p_itf);
}
//--------------------------------------------------------------------+
// USBD Driver API
//--------------------------------------------------------------------+
void vendord_init(void) {
tu_memclr(_vendord_itf, sizeof(_vendord_itf));
}
void vendord_reset(uint8_t rhport) {
(void)rhport;
for(uint8_t i = 0; i < CFG_TUD_VENDOR; i++) {
vendord_interface_t* p_itf = &_vendord_itf[i];
tu_memclr(p_itf, ITF_MEM_RESET_SIZE);
}
}
uint16_t vendord_open(uint8_t rhport, tusb_desc_interface_t const* desc_itf, uint16_t max_len) {
TU_VERIFY(TUSB_CLASS_VENDOR_SPECIFIC == desc_itf->bInterfaceClass, 0);
uint8_t const* p_desc = tu_desc_next(desc_itf);
uint8_t const* desc_end = p_desc + max_len;
// Find available interface
vendord_interface_t* p_vendor = NULL;
for(uint8_t i = 0; i < CFG_TUD_VENDOR; i++) {
if(_vendord_itf[i].ep_in == 0 && _vendord_itf[i].ep_out == 0) {
p_vendor = &_vendord_itf[i];
break;
}
}
TU_VERIFY(p_vendor, 0);
p_vendor->itf_num = desc_itf->bInterfaceNumber;
if(desc_itf->bNumEndpoints) {
// skip non-endpoint descriptors
while((TUSB_DESC_ENDPOINT != tu_desc_type(p_desc)) && (p_desc < desc_end)) {
p_desc = tu_desc_next(p_desc);
}
// Open endpoint pair with usbd helper
TU_ASSERT(
usbd_open_edpt_pair(
rhport,
p_desc,
desc_itf->bNumEndpoints,
TUSB_XFER_BULK,
&p_vendor->ep_out,
&p_vendor->ep_in),
0);
p_desc += desc_itf->bNumEndpoints * sizeof(tusb_desc_endpoint_t);
// Prepare for incoming data
if(p_vendor->ep_out) {
TU_ASSERT(
usbd_edpt_xfer(
rhport, p_vendor->ep_out, p_vendor->epout_buf[0], sizeof(p_vendor->epout_buf)),
0);
}
if(p_vendor->ep_in) maybe_transmit(p_vendor);
}
return (uint16_t)((uintptr_t)p_desc - (uintptr_t)desc_itf);
}
bool vendord_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
(void)rhport;
(void)result;
uint8_t itf = 0;
vendord_interface_t* p_itf = _vendord_itf;
for(;; itf++, p_itf++) {
if(itf >= TU_ARRAY_SIZE(_vendord_itf)) return false;
if((ep_addr == p_itf->ep_out) || (ep_addr == p_itf->ep_in)) break;
}
if(ep_addr == p_itf->ep_out) {
if(xferred_bytes) {
unsigned idx = p_itf->request_wp % DAP_PACKET_COUNT;
p_itf->epout_sz[idx] = xferred_bytes;
if(ID_DAP_TransferAbort == p_itf->epout_buf[idx][0]) {
if(tud_vendor_transfer_abort_cb) tud_vendor_transfer_abort_cb(itf);
} else {
++p_itf->request_wp;
}
}
_prep_out_transaction(p_itf);
} else if(ep_addr == p_itf->ep_in) {
// Send complete, try to send more if possible
maybe_transmit(p_itf);
}
return true;
}