Re: [PATCH v30 02/30] xhci: sec-intr: add initial api to register a secondary interrupter entity

[Mathias Nyman <mathias.nyman@linux.intel.com>]

On 6.11.2024 21.33, Wesley Cheng wrote:
> From: Mathias Nyman <mathias.nyman@linux.intel.com>
> 
> Introduce XHCI sec intr, which manages the USB endpoints being requested by
> a client driver.  This is used for when client drivers are attempting to
> offload USB endpoints to another entity for handling USB transfers.  XHCI
> sec intr will allow for drivers to fetch the required information about the
> transfer ring, so the user can submit transfers independently.  Expose the
> required APIs for drivers to register and request for a USB endpoint and to
> manage XHCI secondary interrupters.
> 
> Driver renaming, multiple ring segment page linking, proper endpoint clean
> up, and allowing module compilation added by Wesley Cheng to complete
> original concept code by Mathias Nyman.
> 
> Signed-off-by: Mathias Nyman <mathias.nyman@linux.intel.com>
> Co-developed-by: Wesley Cheng <quic_wcheng@quicinc.com>
> Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com>
> ---
>   drivers/usb/host/Kconfig          |  11 +
>   drivers/usb/host/Makefile         |   2 +
>   drivers/usb/host/xhci-sec-intr.c  | 438 ++++++++++++++++++++++++++++++
>   drivers/usb/host/xhci.h           |   4 +
>   include/linux/usb/xhci-sec-intr.h |  70 +++++
>   5 files changed, 525 insertions(+)
>   create mode 100644 drivers/usb/host/xhci-sec-intr.c
>   create mode 100644 include/linux/usb/xhci-sec-intr.h
> 
> diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
> index d011d6c753ed..a2d549e3e076 100644
> --- a/drivers/usb/host/Kconfig
> +++ b/drivers/usb/host/Kconfig
> @@ -104,6 +104,17 @@ config USB_XHCI_RZV2M
>   	  Say 'Y' to enable the support for the xHCI host controller
>   	  found in Renesas RZ/V2M SoC.
>   
> +config USB_XHCI_SEC_INTR
> +	tristate "xHCI support for secondary interrupter management"
> +	help
> +	  Say 'Y' to enable the support for the xHCI secondary management.
> +	  Provide a mechanism for a sideband datapath for payload associated
> +	  with audio class endpoints. This allows for an audio DSP to use
> +	  xHCI USB endpoints directly, allowing CPU to sleep while playing
> +	  audio.  This is not the same feature as the audio sideband
> +	  capability mentioned within the xHCI specification, and continues
> +	  to utilize main system memory for data transfers.

This same API should be used for the hardware xHCI sideband capability.
We should add a function that checks which types of xHC sideband capability xHC
hardware can support, and pick and pass a type to xhci xhci_sec_intr_register()
when registering a sideband/sec_intr

> +
>   config USB_XHCI_TEGRA
>   	tristate "xHCI support for NVIDIA Tegra SoCs"
>   	depends on PHY_TEGRA_XUSB
> diff --git a/drivers/usb/host/Makefile b/drivers/usb/host/Makefile
> index be4e5245c52f..d4b127f48cf9 100644
> --- a/drivers/usb/host/Makefile
> +++ b/drivers/usb/host/Makefile
> @@ -32,6 +32,8 @@ endif
>   xhci-rcar-hcd-y				+= xhci-rcar.o
>   xhci-rcar-hcd-$(CONFIG_USB_XHCI_RZV2M)	+= xhci-rzv2m.o
>   
> +obj-$(CONFIG_USB_XHCI_SEC_INTR) += xhci-sec-intr.o
> +
>   obj-$(CONFIG_USB_PCI)	+= pci-quirks.o
>   
>   obj-$(CONFIG_USB_EHCI_HCD)	+= ehci-hcd.o
> diff --git a/drivers/usb/host/xhci-sec-intr.c b/drivers/usb/host/xhci-sec-intr.c
> new file mode 100644
> index 000000000000..b112c3388368
> --- /dev/null
> +++ b/drivers/usb/host/xhci-sec-intr.c
> @@ -0,0 +1,438 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +/*
> + * xHCI host controller secondary interrupter management
> + *
> + * Provides logic for client drivers that support utilizing xHCI secondary
> + * interrupters.
> + *
> + * Copyright (c) 2023-2024, Intel Corporation.
> + *
> + * Author: Mathias Nyman
> + */
> +
> +#include <linux/usb/xhci-sec-intr.h>
> +#include <linux/dma-direct.h>
> +
> +#include "xhci.h"
> +
> +/* internal helpers */
> +static struct sg_table *
> +xhci_ring_to_sgtable(struct xhci_sec_intr *si, struct xhci_ring *ring)
> +{
> +	struct xhci_segment *seg;
> +	struct sg_table	*sgt;
> +	unsigned int n_pages;
> +	struct page **pages;
> +	struct device *dev;
> +	size_t sz;
> +	int i;
> +
> +	dev = xhci_to_hcd(si->xhci)->self.sysdev;
> +	sz = ring->num_segs * TRB_SEGMENT_SIZE;
> +	n_pages = PAGE_ALIGN(sz) >> PAGE_SHIFT;
> +	pages = kvmalloc_array(n_pages, sizeof(struct page *), GFP_KERNEL);
> +	if (!pages)
> +		return NULL;
> +
> +	sgt = kzalloc(sizeof(*sgt), GFP_KERNEL);
> +	if (!sgt) {
> +		kvfree(pages);
> +		return NULL;
> +	}
> +
> +	seg = ring->first_seg;
> +	if (!seg)
> +		goto err;
> +	/*
> +	 * Rings can potentially have multiple segments, create an array that
> +	 * carries page references to allocated segments.  Utilize the
> +	 * sg_alloc_table_from_pages() to create the sg table, and to ensure
> +	 * that page links are created.
> +	 */
> +	for (i = 0; i < ring->num_segs; i++) {
> +		dma_get_sgtable(dev, sgt, seg->trbs, seg->dma,
> +				TRB_SEGMENT_SIZE);
> +		pages[i] = sg_page(sgt->sgl);
> +		sg_free_table(sgt);
> +		seg = seg->next;
> +	}
> +
> +	if (sg_alloc_table_from_pages(sgt, pages, n_pages, 0, sz, GFP_KERNEL))
> +		goto err;
> +
> +	/*
> +	 * Save first segment dma address to sg dma_address field for the sideband
> +	 * client to have access to the IOVA of the ring.
> +	 */
> +	sg_dma_address(sgt->sgl) = ring->first_seg->dma;
> +
> +	return sgt;
> +
> +err:
> +	kvfree(pages);
> +	kfree(sgt);
> +
> +	return NULL;
> +}
> +
> +static void
> +__xhci_sec_intr_remove_endpoint(struct xhci_sec_intr *si, struct xhci_virt_ep *ep)
> +{
> +	/*
> +	 * Issue a stop endpoint command when an endpoint is removed.
> +	 * The stop ep cmd handler will handle the ring cleanup.
> +	 */
> +	xhci_stop_endpoint_sync(si->xhci, ep, 0, GFP_KERNEL);
> +
> +	ep->sec = NULL;
> +	si->eps[ep->ep_index] = NULL;
> +}
> +
> +/* endpoint api functions */
> +
> +/**
> + * xhci_sec_intr_add_endpoint - add endpoint to access list
> + * @si: secondary interrupter instance for this usb device
> + * @host_ep: usb host endpoint
> + *
> + * Adds an endpoint to the list of endpoints utilizing secondary interrupters
> + * for this usb device.
> + * After an endpoint is added the client can get the endpoint transfer ring
> + * buffer by calling xhci_sec_intr_get_endpoint_buffer()
> + *
> + * Return: 0 on success, negative error otherwise.
> + */
> +int
> +xhci_sec_intr_add_endpoint(struct xhci_sec_intr *si,
> +			   struct usb_host_endpoint *host_ep)
> +{
> +	struct xhci_virt_ep *ep;
> +	unsigned int ep_index;
> +
> +	mutex_lock(&si->mutex);
> +	ep_index = xhci_get_endpoint_index(&host_ep->desc);
> +	ep = &si->vdev->eps[ep_index];
> +
> +	if (ep->ep_state & EP_HAS_STREAMS) {
> +		mutex_unlock(&si->mutex);
> +		return -EINVAL;
> +	}
> +
> +	/*
> +	 * Note, we don't know the DMA mask of the audio DSP device, if its
> +	 * smaller than for xhci it won't be able to access the endpoint ring
> +	 * buffer. This could be solved by not allowing the audio class driver
> +	 * to add the endpoint the normal way, but instead offload it immediately,
> +	 * and let this function add the endpoint and allocate the ring buffer
> +	 * with the smallest common DMA mask
> +	 */
> +	if (si->eps[ep_index] || ep->sec) {
> +		mutex_unlock(&si->mutex);
> +		return -EBUSY;
> +	}
> +
> +	ep->sec = si;
> +	si->eps[ep_index] = ep;
> +	mutex_unlock(&si->mutex);

We should probably check in xhci-mem.c if ep->sec is set before freeing the
endpoint ring.
We don't want the sideband client driver to touch freed rings.
Maybe we even need a way for xhci driver to notify this sideband/sec_intr client
in case a offloaded device or endpoint is being freed.

I guess usb core in most cases ensures class drivers are properly removed,
and thus this sideband/sec_interrupt should be unregistered before xhci starts
freeing endpoints, but I'm not sure sure this is true in all corner cases.
This is the first time we share endpoint ring addresses.

Thanks
Mathias