usbd_vreq_node Struct Reference

USBD vendor request node. More...

#include <zephyr/usb/usbd.h>

Data Fields
sys_dnode_t	node
	Node information for the dlist.
const uint8_t	code
	Vendor code (bRequest value).
struct net_buf *(*	to_host )(const struct usbd_context *const ctx, const struct usb_setup_packet *const setup)
	Vendor request callback for device-to-host direction.
int(*	to_dev )(const struct usbd_context *const ctx, const struct usb_setup_packet *const setup, const struct net_buf *const buf)
	Vendor request callback for host-to-device direction.

Detailed Description

USBD vendor request node.

Vendor request node is identified by the vendor code and is used to register callbacks to handle the vendor request with the receiving device. When the device stack receives a request with type Vendor and recipient Device, and bRequest value equal to the vendor request code, it will call the vendor callbacks depending on the direction of the request.

Example callback code fragment:

static struct net_buf *foo_to_host_cb(const struct usbd_context *const ctx,
                                      const struct usb_setup_packet *const setup)
{
    if (setup->wIndex == WEBUSB_REQ_GET_URL) {
        struct net_buf *buf;
        uint16_t len;
        uint8_t index = USB_GET_DESCRIPTOR_INDEX(setup->wValue);
 
        if (index != SAMPLE_WEBUSB_LANDING_PAGE) {
            return NULL;
        }
 
        len = MIN(setup->wLength, sizeof(webusb_origin_url));
        buf = usbd_ep_ctrl_data_in_alloc(ctx, len);
        if (buf == NULL) {
            return NULL;
        }
 
        net_buf_add_mem(buf, &webusb_origin_url, len);
 
        return buf;
    }
 
    return NULL;
}

Field Documentation

code

const uint8_t usbd_vreq_node::code

Vendor code (bRequest value).

node

sys_dnode_t usbd_vreq_node::node

Node information for the dlist.

to_dev

int(* usbd_vreq_node::to_dev) (const struct usbd_context *const ctx, const struct usb_setup_packet *const setup, const struct net_buf *const buf)

Vendor request callback for host-to-device direction.

For requests with Data OUT stage (wLength != 0), the callback will be called first with NULL buf before Data OUT stage is received to check if data should be received. The callback will be called second time, with non-NULL buf, after data is received.

For requests without Data Stage (wLength == 0), the callback is called just once with NULL buf.

to_host

struct net_buf *(* usbd_vreq_node::to_host) (const struct usbd_context *const ctx, const struct usb_setup_packet *const setup)

Vendor request callback for device-to-host direction.

---

The documentation for this struct was generated from the following file:

• zephyr/usb/usbd.h