diff mbox series

[v11,1/5] usb: gadget: udc: core: Introduce check_config to verify USB configuration

Message ID 1625043642-29822-2-git-send-email-wcheng@codeaurora.org (mailing list archive)
State Superseded
Headers show
Series Re-introduce TX FIFO resize for larger EP bursting | expand

Commit Message

Wesley Cheng June 30, 2021, 9 a.m. UTC
Some UDCs may have constraints on how many high bandwidth endpoints it can
support in a certain configuration.  This API allows for the composite
driver to pass down the total number of endpoints to the UDC so it can verify
it has the required resources to support the configuration.

Signed-off-by: Wesley Cheng <wcheng@codeaurora.org>
---
 drivers/usb/gadget/udc/core.c | 25 +++++++++++++++++++++++++
 include/linux/usb/gadget.h    |  4 ++++
 2 files changed, 29 insertions(+)

Comments

Greg Kroah-Hartman July 2, 2021, 5 a.m. UTC | #1
On Wed, Jun 30, 2021 at 02:00:38AM -0700, Wesley Cheng wrote:
> Some UDCs may have constraints on how many high bandwidth endpoints it can
> support in a certain configuration.  This API allows for the composite
> driver to pass down the total number of endpoints to the UDC so it can verify
> it has the required resources to support the configuration.
> 
> Signed-off-by: Wesley Cheng <wcheng@codeaurora.org>
> ---
>  drivers/usb/gadget/udc/core.c | 25 +++++++++++++++++++++++++
>  include/linux/usb/gadget.h    |  4 ++++
>  2 files changed, 29 insertions(+)
> 
> diff --git a/drivers/usb/gadget/udc/core.c b/drivers/usb/gadget/udc/core.c
> index b7f0b1e..f1f44a6 100644
> --- a/drivers/usb/gadget/udc/core.c
> +++ b/drivers/usb/gadget/udc/core.c
> @@ -1003,6 +1003,31 @@ int usb_gadget_ep_match_desc(struct usb_gadget *gadget,
>  }
>  EXPORT_SYMBOL_GPL(usb_gadget_ep_match_desc);
>  
> +/**
> + * usb_gadget_check_config - checks if the UDC can support the number of eps

"eps"?  What is that?

> + * @gadget: controller to check the USB configuration
> + * @ep_map: bitmap of endpoints being requested by a USB configuration

There is no such option in this function, did you run 'make htmldocs'
and see that this adds a warning?

> + *
> + * Ensure that a UDC is able to support the number of endpoints within a USB
> + * configuration, and that there are no resource limitations to support all
> + * requested eps.
> + *
> + * Returns zero on success, else a negative errno.
> + */
> +int usb_gadget_check_config(struct usb_gadget *gadget)
> +{
> +	int ret = 0;
> +
> +	if (!gadget->ops->check_config)
> +		goto out;
> +
> +	ret = gadget->ops->check_config(gadget);
> +
> +out:
> +	return ret;
> +}
> +EXPORT_SYMBOL_GPL(usb_gadget_check_config);

This can be written in the much simpler form:
{
	if (gadget->ops->check_config)
		return gadget->ops->check_config(gadget);
	return 0;
}

But where are the endpoints that need to be checked???

How is this working?

thanks,

greg k-h
Wesley Cheng July 2, 2021, 8 a.m. UTC | #2
On 7/1/2021 10:00 PM, Greg KH wrote:
> On Wed, Jun 30, 2021 at 02:00:38AM -0700, Wesley Cheng wrote:
>> Some UDCs may have constraints on how many high bandwidth endpoints it can
>> support in a certain configuration.  This API allows for the composite
>> driver to pass down the total number of endpoints to the UDC so it can verify
>> it has the required resources to support the configuration.
>>
>> Signed-off-by: Wesley Cheng <wcheng@codeaurora.org>
>> ---
>>  drivers/usb/gadget/udc/core.c | 25 +++++++++++++++++++++++++
>>  include/linux/usb/gadget.h    |  4 ++++
>>  2 files changed, 29 insertions(+)
>>
>> diff --git a/drivers/usb/gadget/udc/core.c b/drivers/usb/gadget/udc/core.c
>> index b7f0b1e..f1f44a6 100644
>> --- a/drivers/usb/gadget/udc/core.c
>> +++ b/drivers/usb/gadget/udc/core.c
>> @@ -1003,6 +1003,31 @@ int usb_gadget_ep_match_desc(struct usb_gadget *gadget,
>>  }
>>  EXPORT_SYMBOL_GPL(usb_gadget_ep_match_desc);
>>  
>> +/**
>> + * usb_gadget_check_config - checks if the UDC can support the number of eps

Hi Greg,

Thanks for the feedback.
> 
> "eps"?  What is that?
>

Fixed to "endpoints"

>> + * @gadget: controller to check the USB configuration
>> + * @ep_map: bitmap of endpoints being requested by a USB configuration
> 
> There is no such option in this function, did you run 'make htmldocs'
> and see that this adds a warning?
> 
Removed the ep_map comment, as we've removed it from the arguments.

>> + *
>> + * Ensure that a UDC is able to support the number of endpoints within a USB
>> + * configuration, and that there are no resource limitations to support all
>> + * requested eps.
>> + *
>> + * Returns zero on success, else a negative errno.
>> + */
>> +int usb_gadget_check_config(struct usb_gadget *gadget)
>> +{
>> +	int ret = 0;
>> +
>> +	if (!gadget->ops->check_config)
>> +		goto out;
>> +
>> +	ret = gadget->ops->check_config(gadget);
>> +
>> +out:
>> +	return ret;
>> +}
>> +EXPORT_SYMBOL_GPL(usb_gadget_check_config);
> 
> This can be written in the much simpler form:
> {
> 	if (gadget->ops->check_config)
> 		return gadget->ops->check_config(gadget);
> 	return 0;
> }
>
thanks for this suggestion.

> But where are the endpoints that need to be checked???
> 
> How is this working?
> 
The USB gadget will have ep_list, do we'll be looping through the
endpoints that have been claimed to get the number of IN eps being used
by a particular configuration.

Thanks
Wesley Cheng
diff mbox series

Patch

diff --git a/drivers/usb/gadget/udc/core.c b/drivers/usb/gadget/udc/core.c
index b7f0b1e..f1f44a6 100644
--- a/drivers/usb/gadget/udc/core.c
+++ b/drivers/usb/gadget/udc/core.c
@@ -1003,6 +1003,31 @@  int usb_gadget_ep_match_desc(struct usb_gadget *gadget,
 }
 EXPORT_SYMBOL_GPL(usb_gadget_ep_match_desc);
 
+/**
+ * usb_gadget_check_config - checks if the UDC can support the number of eps
+ * @gadget: controller to check the USB configuration
+ * @ep_map: bitmap of endpoints being requested by a USB configuration
+ *
+ * Ensure that a UDC is able to support the number of endpoints within a USB
+ * configuration, and that there are no resource limitations to support all
+ * requested eps.
+ *
+ * Returns zero on success, else a negative errno.
+ */
+int usb_gadget_check_config(struct usb_gadget *gadget)
+{
+	int ret = 0;
+
+	if (!gadget->ops->check_config)
+		goto out;
+
+	ret = gadget->ops->check_config(gadget);
+
+out:
+	return ret;
+}
+EXPORT_SYMBOL_GPL(usb_gadget_check_config);
+
 /* ------------------------------------------------------------------------- */
 
 static void usb_gadget_state_work(struct work_struct *work)
diff --git a/include/linux/usb/gadget.h b/include/linux/usb/gadget.h
index 75c7538..776851e 100644
--- a/include/linux/usb/gadget.h
+++ b/include/linux/usb/gadget.h
@@ -329,6 +329,7 @@  struct usb_gadget_ops {
 	struct usb_ep *(*match_ep)(struct usb_gadget *,
 			struct usb_endpoint_descriptor *,
 			struct usb_ss_ep_comp_descriptor *);
+	int	(*check_config)(struct usb_gadget *gadget);
 };
 
 /**
@@ -608,6 +609,7 @@  int usb_gadget_connect(struct usb_gadget *gadget);
 int usb_gadget_disconnect(struct usb_gadget *gadget);
 int usb_gadget_deactivate(struct usb_gadget *gadget);
 int usb_gadget_activate(struct usb_gadget *gadget);
+int usb_gadget_check_config(struct usb_gadget *gadget);
 #else
 static inline int usb_gadget_frame_number(struct usb_gadget *gadget)
 { return 0; }
@@ -631,6 +633,8 @@  static inline int usb_gadget_deactivate(struct usb_gadget *gadget)
 { return 0; }
 static inline int usb_gadget_activate(struct usb_gadget *gadget)
 { return 0; }
+static inline int usb_gadget_check_config(struct usb_gadget *gadget)
+{ return 0; }
 #endif /* CONFIG_USB_GADGET */
 
 /*-------------------------------------------------------------------------*/