[1/2] Documentation: usb: Update NCM configfs parameters

Message ID 20231009142005.21338-1-quic_kriskura@quicinc.com
State New
Headers
Series [1/2] Documentation: usb: Update NCM configfs parameters |

Commit Message

Krishna Kurapati Oct. 9, 2023, 2:20 p.m. UTC
  Updateed NCM configfs parameters by adding max_segment_size
property and describing its effect on MTU configuration of
NCM interface.

Signed-off-by: Krishna Kurapati <quic_kriskura@quicinc.com>
---
 Documentation/usb/gadget-testing.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)
  

Comments

Greg KH Oct. 9, 2023, 3:05 p.m. UTC | #1
On Mon, Oct 09, 2023 at 07:50:04PM +0530, Krishna Kurapati wrote:
> Updateed NCM configfs parameters by adding max_segment_size
> property and describing its effect on MTU configuration of
> NCM interface.

"Updated"?

> 
> Signed-off-by: Krishna Kurapati <quic_kriskura@quicinc.com>
> ---
>  Documentation/usb/gadget-testing.rst | 20 +++++++++++---------
>  1 file changed, 11 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
> index 29072c166d23..6e5d96668e8e 100644
> --- a/Documentation/usb/gadget-testing.rst
> +++ b/Documentation/usb/gadget-testing.rst
> @@ -448,15 +448,17 @@ Function-specific configfs interface
>  The function name to use when creating the function directory is "ncm".
>  The NCM function provides these attributes in its function directory:
>  
> -	=============== ==================================================
> -	ifname		network device interface name associated with this
> -			function instance
> -	qmult		queue length multiplier for high and super speed
> -	host_addr	MAC address of host's end of this
> -			Ethernet over USB link
> -	dev_addr	MAC address of device's end of this
> -			Ethernet over USB link
> -	=============== ==================================================
> +	================= ====================================================
> +	ifname		  network device interface name associated with this
> +			  function instance
> +	qmult		  queue length multiplier for high and super speed
> +	host_addr	  MAC address of host's end of this
> +			  Ethernet over USB link
> +	dev_addr	  MAC address of device's end of this
> +			  Ethernet over USB link
> +	max_segment_size  Segment size required for P2P connections. This
> +			  will inturn set MTU to (max_segment_size - 14 bytes)

"inturn"???

> +	================= ====================================================
>  

What commit id does this fix?

thanks,

greg k-h
  
Krishna Kurapati Oct. 9, 2023, 3:10 p.m. UTC | #2
On 10/9/2023 8:35 PM, Greg Kroah-Hartman wrote:
> On Mon, Oct 09, 2023 at 07:50:04PM +0530, Krishna Kurapati wrote:
>> Updateed NCM configfs parameters by adding max_segment_size
>> property and describing its effect on MTU configuration of
>> NCM interface.
> 
> "Updated"?

My bad. Will fix it in v2.
> 
>>
>> Signed-off-by: Krishna Kurapati <quic_kriskura@quicinc.com>
>> ---
>>   Documentation/usb/gadget-testing.rst | 20 +++++++++++---------
>>   1 file changed, 11 insertions(+), 9 deletions(-)
>>
>> diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
>> index 29072c166d23..6e5d96668e8e 100644
>> --- a/Documentation/usb/gadget-testing.rst
>> +++ b/Documentation/usb/gadget-testing.rst
>> @@ -448,15 +448,17 @@ Function-specific configfs interface
>>   The function name to use when creating the function directory is "ncm".
>>   The NCM function provides these attributes in its function directory:
>>   
>> -	=============== ==================================================
>> -	ifname		network device interface name associated with this
>> -			function instance
>> -	qmult		queue length multiplier for high and super speed
>> -	host_addr	MAC address of host's end of this
>> -			Ethernet over USB link
>> -	dev_addr	MAC address of device's end of this
>> -			Ethernet over USB link
>> -	=============== ==================================================
>> +	================= ====================================================
>> +	ifname		  network device interface name associated with this
>> +			  function instance
>> +	qmult		  queue length multiplier for high and super speed
>> +	host_addr	  MAC address of host's end of this
>> +			  Ethernet over USB link
>> +	dev_addr	  MAC address of device's end of this
>> +			  Ethernet over USB link
>> +	max_segment_size  Segment size required for P2P connections. This
>> +			  will inturn set MTU to (max_segment_size - 14 bytes)
> 
> "inturn"???
> 
>> +	================= ====================================================
>>   
> 
> What commit id does this fix?
> 
This is not a bug fix. It is just an addition of a new property. Does it 
need a fixes tag ?

Regards,
Krishna,
  
Greg KH Oct. 9, 2023, 3:21 p.m. UTC | #3
On Mon, Oct 09, 2023 at 08:40:27PM +0530, Krishna Kurapati PSSNV wrote:
> 
> 
> On 10/9/2023 8:35 PM, Greg Kroah-Hartman wrote:
> > On Mon, Oct 09, 2023 at 07:50:04PM +0530, Krishna Kurapati wrote:
> > > Updateed NCM configfs parameters by adding max_segment_size
> > > property and describing its effect on MTU configuration of
> > > NCM interface.
> > 
> > "Updated"?
> 
> My bad. Will fix it in v2.
> > 
> > > 
> > > Signed-off-by: Krishna Kurapati <quic_kriskura@quicinc.com>
> > > ---
> > >   Documentation/usb/gadget-testing.rst | 20 +++++++++++---------
> > >   1 file changed, 11 insertions(+), 9 deletions(-)
> > > 
> > > diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
> > > index 29072c166d23..6e5d96668e8e 100644
> > > --- a/Documentation/usb/gadget-testing.rst
> > > +++ b/Documentation/usb/gadget-testing.rst
> > > @@ -448,15 +448,17 @@ Function-specific configfs interface
> > >   The function name to use when creating the function directory is "ncm".
> > >   The NCM function provides these attributes in its function directory:
> > > -	=============== ==================================================
> > > -	ifname		network device interface name associated with this
> > > -			function instance
> > > -	qmult		queue length multiplier for high and super speed
> > > -	host_addr	MAC address of host's end of this
> > > -			Ethernet over USB link
> > > -	dev_addr	MAC address of device's end of this
> > > -			Ethernet over USB link
> > > -	=============== ==================================================
> > > +	================= ====================================================
> > > +	ifname		  network device interface name associated with this
> > > +			  function instance
> > > +	qmult		  queue length multiplier for high and super speed
> > > +	host_addr	  MAC address of host's end of this
> > > +			  Ethernet over USB link
> > > +	dev_addr	  MAC address of device's end of this
> > > +			  Ethernet over USB link
> > > +	max_segment_size  Segment size required for P2P connections. This
> > > +			  will inturn set MTU to (max_segment_size - 14 bytes)
> > 
> > "inturn"???
> > 
> > > +	================= ====================================================
> > 
> > What commit id does this fix?
> > 
> This is not a bug fix. It is just an addition of a new property. Does it
> need a fixes tag ?

Where is the code for the new property?

Ah, it's in patch 2/2, that wasn't obvious, sorry.  Why is this a
separate patch at all, shouldn't be part of the commit that adds the new
property to the system?

thanks,

greg k-h
  
Krishna Kurapati Oct. 9, 2023, 3:33 p.m. UTC | #4
On 10/9/2023 8:51 PM, Greg Kroah-Hartman wrote:

>>>> diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
>>>> index 29072c166d23..6e5d96668e8e 100644
>>>> --- a/Documentation/usb/gadget-testing.rst
>>>> +++ b/Documentation/usb/gadget-testing.rst
>>>> @@ -448,15 +448,17 @@ Function-specific configfs interface
>>>>    The function name to use when creating the function directory is "ncm".
>>>>    The NCM function provides these attributes in its function directory:
>>>> -	=============== ==================================================
>>>> -	ifname		network device interface name associated with this
>>>> -			function instance
>>>> -	qmult		queue length multiplier for high and super speed
>>>> -	host_addr	MAC address of host's end of this
>>>> -			Ethernet over USB link
>>>> -	dev_addr	MAC address of device's end of this
>>>> -			Ethernet over USB link
>>>> -	=============== ==================================================
>>>> +	================= ====================================================
>>>> +	ifname		  network device interface name associated with this
>>>> +			  function instance
>>>> +	qmult		  queue length multiplier for high and super speed
>>>> +	host_addr	  MAC address of host's end of this
>>>> +			  Ethernet over USB link
>>>> +	dev_addr	  MAC address of device's end of this
>>>> +			  Ethernet over USB link
>>>> +	max_segment_size  Segment size required for P2P connections. This
>>>> +			  will inturn set MTU to (max_segment_size - 14 bytes)
>>>
>>> "inturn"???
>>>
>>>> +	================= ====================================================
>>>
>>> What commit id does this fix?
>>>
>> This is not a bug fix. It is just an addition of a new property. Does it
>> need a fixes tag ?
> 
> Where is the code for the new property?
> 
> Ah, it's in patch 2/2, that wasn't obvious, sorry.  Why is this a
> separate patch at all, shouldn't be part of the commit that adds the new
> property to the system?
> 

Sorry. I followed the practice of splitting patches like we usually do. 
Will club them up in a single patch in v2. Thanks for pointing this mistake.

Regards,
Krishna,
  
Greg KH Oct. 9, 2023, 3:42 p.m. UTC | #5
On Mon, Oct 09, 2023 at 09:03:41PM +0530, Krishna Kurapati PSSNV wrote:
> 
> 
> On 10/9/2023 8:51 PM, Greg Kroah-Hartman wrote:
> 
> > > > > diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
> > > > > index 29072c166d23..6e5d96668e8e 100644
> > > > > --- a/Documentation/usb/gadget-testing.rst
> > > > > +++ b/Documentation/usb/gadget-testing.rst
> > > > > @@ -448,15 +448,17 @@ Function-specific configfs interface
> > > > >    The function name to use when creating the function directory is "ncm".
> > > > >    The NCM function provides these attributes in its function directory:
> > > > > -	=============== ==================================================
> > > > > -	ifname		network device interface name associated with this
> > > > > -			function instance
> > > > > -	qmult		queue length multiplier for high and super speed
> > > > > -	host_addr	MAC address of host's end of this
> > > > > -			Ethernet over USB link
> > > > > -	dev_addr	MAC address of device's end of this
> > > > > -			Ethernet over USB link
> > > > > -	=============== ==================================================
> > > > > +	================= ====================================================
> > > > > +	ifname		  network device interface name associated with this
> > > > > +			  function instance
> > > > > +	qmult		  queue length multiplier for high and super speed
> > > > > +	host_addr	  MAC address of host's end of this
> > > > > +			  Ethernet over USB link
> > > > > +	dev_addr	  MAC address of device's end of this
> > > > > +			  Ethernet over USB link
> > > > > +	max_segment_size  Segment size required for P2P connections. This
> > > > > +			  will inturn set MTU to (max_segment_size - 14 bytes)
> > > > 
> > > > "inturn"???
> > > > 
> > > > > +	================= ====================================================
> > > > 
> > > > What commit id does this fix?
> > > > 
> > > This is not a bug fix. It is just an addition of a new property. Does it
> > > need a fixes tag ?
> > 
> > Where is the code for the new property?
> > 
> > Ah, it's in patch 2/2, that wasn't obvious, sorry.  Why is this a
> > separate patch at all, shouldn't be part of the commit that adds the new
> > property to the system?
> > 
> 
> Sorry. I followed the practice of splitting patches like we usually do. Will
> club them up in a single patch in v2. Thanks for pointing this mistake.

Splitting is fine, but don't ask us to review documentation before the
feature is even presented, that's reading backwards :)
  

Patch

diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
index 29072c166d23..6e5d96668e8e 100644
--- a/Documentation/usb/gadget-testing.rst
+++ b/Documentation/usb/gadget-testing.rst
@@ -448,15 +448,17 @@  Function-specific configfs interface
 The function name to use when creating the function directory is "ncm".
 The NCM function provides these attributes in its function directory:
 
-	=============== ==================================================
-	ifname		network device interface name associated with this
-			function instance
-	qmult		queue length multiplier for high and super speed
-	host_addr	MAC address of host's end of this
-			Ethernet over USB link
-	dev_addr	MAC address of device's end of this
-			Ethernet over USB link
-	=============== ==================================================
+	================= ====================================================
+	ifname		  network device interface name associated with this
+			  function instance
+	qmult		  queue length multiplier for high and super speed
+	host_addr	  MAC address of host's end of this
+			  Ethernet over USB link
+	dev_addr	  MAC address of device's end of this
+			  Ethernet over USB link
+	max_segment_size  Segment size required for P2P connections. This
+			  will inturn set MTU to (max_segment_size - 14 bytes)
+	================= ====================================================
 
 and after creating the functions/ncm.<instance name> they contain default
 values: qmult is 5, dev_addr and host_addr are randomly selected.