Re: [Xen-devel] [Patch V4 1/3] usb: Add Xen pvUSB protocol description

[David Vrabel <david.vrabel@xxxxxxxxxx>]

On 23/07/15 07:46, Juergen Gross wrote:
> On 07/23/2015 06:36 AM, Greg KH wrote:
>> On Thu, Jul 23, 2015 at 06:04:39AM +0200, Juergen Gross wrote:
>>> On 07/23/2015 01:46 AM, Greg KH wrote:
>>>> On Tue, Jun 23, 2015 at 08:53:23AM +0200, Juergen Gross wrote:
>>>>> Add the definition of pvUSB protocol used between the pvUSB
>>>>> frontend in
>>>>> a Xen domU and the pvUSB backend in a Xen driver domain (usually
>>>>> Dom0).
>>>>>
>>>>> This header was originally provided by Fujitsu for Xen based on Linux
>>>>> 2.6.18.
>>>>>
>>>>> Changes are:
>>>>> - adapt to Linux style guide
>>>>>
>>>>> Signed-off-by: Juergen Gross <jgross@xxxxxxxx>
>>>>> ---
>>>>>   include/xen/interface/io/usbif.h | 252
>>>>> +++++++++++++++++++++++++++++++++++++++
>>>>
>>>> Why is this a different interface than the existing ones we have today
>>>> (i.e. usbip?)  Where is it documented?  Do the Xen developers /
>>>
>>> The interface definition is living in the Xen git repository for several
>>> years now:
>>>
>>> git://xenbits.xen.org/xen.git -> xen/include/public/io/usbif.h
>>
>> That's header file, not a document describing the api here.

This is the format that Xen uses to document the interface to frontend
drivers.  This is also the style used for netfront, blkfront etc.

The documentation in the header could be expanded if necessary but...

> I suppose you want to tell me I should add something like:
> 
> Documentation/DocBook/usb/API-struct-urb.html

... we certainly don't want a second location for the interface
description in the Linux source.

David

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel