Skip to content

extmod/machine_usb_device: Add optional data length parameters to usb_device_submit_xfer() #16785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

extmod/machine_usb_device: Add optional data length parameters to usb_device_submit_xfer() #16785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a98ba0d
machine_usb_device: Add optional data length parameters to submit_xfer.
XIVN1987 Feb 19, 2025
e277f57
docs/machine: Document USBDevice.submit_xfer optional nbytes parameter.
XIVN1987 Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/library/machine.USBDevice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,12 +223,15 @@ Methods
and on the host. Returns ``True`` if remote wakeup was enabled and
active and the host was woken up.

.. method:: USBDevice.submit_xfer(self, ep, buffer /)
.. method:: USBDevice.submit_xfer(self, ep, buffer, [nbytes] /)

Submit a USB transfer on endpoint number ``ep``. ``buffer`` must be
an object implementing the buffer interface, with read access for
``IN`` endpoints and write access for ``OUT`` endpoints.

The optional ``nbytes`` parameter can be used to specify the number
of bytes to submit from the buffer.

.. note:: ``ep`` cannot be the control Endpoint number 0. Control
transfers are built up through successive executions of
``control_xfer_cb``, see above.
Expand Down
15 changes: 8 additions & 7 deletions extmod/machine_usb_device.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,17 @@ static void usb_device_check_active(mp_obj_usb_device_t *usbd) {
}
}

static mp_obj_t usb_device_submit_xfer(mp_obj_t self, mp_obj_t ep, mp_obj_t buffer) {
mp_obj_usb_device_t *usbd = (mp_obj_usb_device_t *)MP_OBJ_TO_PTR(self);
static mp_obj_t usb_device_submit_xfer(size_t n_args, const mp_obj_t *args) {
mp_obj_usb_device_t *usbd = (mp_obj_usb_device_t *)MP_OBJ_TO_PTR(args[0]);
int ep_addr;
mp_buffer_info_t buf_info = { 0 };
bool result;

usb_device_check_active(usbd);

// Unmarshal arguments, raises TypeError if invalid
ep_addr = mp_obj_get_int(ep);
mp_get_buffer_raise(buffer, &buf_info, ep_addr & TUSB_DIR_IN_MASK ? MP_BUFFER_READ : MP_BUFFER_RW);
ep_addr = mp_obj_get_int(args[1]);
mp_get_buffer_raise(args[2], &buf_info, ep_addr & TUSB_DIR_IN_MASK ? MP_BUFFER_READ : MP_BUFFER_RW);

uint8_t ep_num = tu_edpt_number(ep_addr);
uint8_t ep_dir = tu_edpt_dir(ep_addr);
Expand All @@ -115,16 +115,17 @@ static mp_obj_t usb_device_submit_xfer(mp_obj_t self, mp_obj_t ep, mp_obj_t buff
mp_raise_OSError(MP_EBUSY);
}

result = usbd_edpt_xfer(USBD_RHPORT, ep_addr, buf_info.buf, buf_info.len);
uint len = (n_args == 3) ? buf_info.len : mp_obj_get_int(args[3]);
result = usbd_edpt_xfer(USBD_RHPORT, ep_addr, buf_info.buf, len);

if (result) {
// Store the buffer object until the transfer completes
usbd->xfer_data[ep_num][ep_dir] = buffer;
usbd->xfer_data[ep_num][ep_dir] = args[2];
}

return mp_obj_new_bool(result);
}
static MP_DEFINE_CONST_FUN_OBJ_3(usb_device_submit_xfer_obj, usb_device_submit_xfer);
static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(usb_device_submit_xfer_obj, 3, 4, usb_device_submit_xfer);

static mp_obj_t usb_device_active(size_t n_args, const mp_obj_t *args) {
mp_obj_usb_device_t *usbd = (mp_obj_usb_device_t *)MP_OBJ_TO_PTR(args[0]);
Expand Down
Loading