Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic
On Mon, 17 Oct 2016 12:33:19 -0700 Stephen Hemminger wrote: > From: Stephen Hemminger > > Update UIO documentation to include basic information about > uio_hv_generic. I've applied this to the docs tree, thanks. jon ___ devel mailing list de...@linuxdriverproject.org http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic
On Tue, 18 Oct 2016 13:01:20 +0200 Markus Heiser wrote: > Am 18.10.2016 um 12:54 schrieb Jani Nikula : > > > On Mon, 17 Oct 2016, Stephen Hemminger wrote: > >> From: Stephen Hemminger > >> > >> Update UIO documentation to include basic information about > >> uio_hv_generic. > > > > How about converting to Sphinx/reStructuredText first...? It's not a big > > file... > > > > The files from : > > > https://github.com/return42/sphkerneldoc/tree/master/doc/Documentation/books_migrated/uio-howto > > might be a good starting point for migration / if you use them, > please drop the comments at the end of each file. > > --M-- Sure, you are welcome to do this. I just wanted to add to existing documentation in existing format. ___ devel mailing list de...@linuxdriverproject.org http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic
Am 18.10.2016 um 15:59 schrieb Stephen Hemminger : > On Tue, 18 Oct 2016 13:01:20 +0200 > Markus Heiser wrote: > >> Am 18.10.2016 um 12:54 schrieb Jani Nikula : >> >>> On Mon, 17 Oct 2016, Stephen Hemminger wrote: From: Stephen Hemminger Update UIO documentation to include basic information about uio_hv_generic. >>> >>> How about converting to Sphinx/reStructuredText first...? It's not a big >>> file... >>> >> >> The files from : >> >> https://github.com/return42/sphkerneldoc/tree/master/doc/Documentation/books_migrated/uio-howto >> >> might be a good starting point for migration / if you use them, >> please drop the comments at the end of each file. >> >> --M-- > > Sure, you are welcome to do this. I just wanted to add to existing > documentation in existing > format. OK, I will send a patch / hope Greck and you will give me your acked ;-) --M-- ___ devel mailing list de...@linuxdriverproject.org http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic
Am 18.10.2016 um 12:54 schrieb Jani Nikula : > On Mon, 17 Oct 2016, Stephen Hemminger wrote: >> From: Stephen Hemminger >> >> Update UIO documentation to include basic information about >> uio_hv_generic. > > How about converting to Sphinx/reStructuredText first...? It's not a big > file... > The files from : https://github.com/return42/sphkerneldoc/tree/master/doc/Documentation/books_migrated/uio-howto might be a good starting point for migration / if you use them, please drop the comments at the end of each file. --M-- > BR, > Jani. > > > >> >> Signed-off-by: Stephen Hemminger >> --- >> Documentation/DocBook/uio-howto.tmpl | 62 >> >> 1 file changed, 62 insertions(+) >> >> diff --git a/Documentation/DocBook/uio-howto.tmpl >> b/Documentation/DocBook/uio-howto.tmpl >> index cd0e452..5210f8a 100644 >> --- a/Documentation/DocBook/uio-howto.tmpl >> +++ b/Documentation/DocBook/uio-howto.tmpl >> @@ -46,6 +46,13 @@ GPL version 2. >> >> >> >> +0.10 >> +2016-10-17 >> +sch >> +Added generic hyperv driver >> + >> + >> + >> 0.9 >> 2009-07-16 >> mst >> @@ -1033,6 +1040,61 @@ int main() >> >> >> >> + >> + >> +Generic Hyper-V UIO driver >> + >> +The generic driver is a kernel module named uio_hv_generic. >> +It supports devices on the Hyper-V VMBus similar to uio_pci_generic >> +on PCI bus. >> + >> + >> + >> +Making the driver recognize the device >> + >> +Since the driver does not declare any device GUID's, it will not get loaded >> +automatically and will not automatically bind to any devices, you must load >> it >> +and allocate id to the driver yourself. For example, to use the network >> device >> +GUID: >> + >> + modprobe uio_hv_generic >> + echo "f8615163-df3e-46c5-913f-f2d2f965ed0e" > >> /sys/bus/vmbus/drivers/uio_hv_generic/new_id >> + >> + >> + >> +If there already is a hardware specific kernel driver for the device, the >> +generic driver still won't bind to it, in this case if you want to use the >> +generic driver (why would you?) you'll have to manually unbind the hardware >> +specific driver and bind the generic driver, like this: >> + >> + echo -n vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3 > >> /sys/bus/vmbus/drivers/hv_netvsc/unbind >> + echo -n vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3 > >> /sys/bus/vmbus/drivers/uio_hv_generic/bind >> + >> + >> + >> +You can verify that the device has been bound to the driver >> +by looking for it in sysfs, for example like the following: >> + >> +ls -l >> /sys/bus/vmbus/devices/vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3/driver >> + >> +Which if successful should print >> + >> + .../vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3/driver -> >> ../../../bus/vmbus/drivers/uio_hv_generic >> + >> + >> + >> + >> + >> +Things to know about uio_hv_generic >> + >> +On each interrupt, uio_hv_generic sets the Interrupt Disable bit. >> +This prevents the device from generating further interrupts >> +until the bit is cleared. The userspace driver should clear this >> +bit before blocking and waiting for more interrupts. >> + >> + >> + >> + >> >> Further information >> > > -- > Jani Nikula, Intel Open Source Technology Center > -- > To unsubscribe from this list: send the line "unsubscribe linux-doc" in > the body of a message to majord...@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html ___ devel mailing list de...@linuxdriverproject.org http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic
On Mon, 17 Oct 2016, Stephen Hemminger wrote: > From: Stephen Hemminger > > Update UIO documentation to include basic information about > uio_hv_generic. How about converting to Sphinx/reStructuredText first...? It's not a big file... BR, Jani. > > Signed-off-by: Stephen Hemminger > --- > Documentation/DocBook/uio-howto.tmpl | 62 > > 1 file changed, 62 insertions(+) > > diff --git a/Documentation/DocBook/uio-howto.tmpl > b/Documentation/DocBook/uio-howto.tmpl > index cd0e452..5210f8a 100644 > --- a/Documentation/DocBook/uio-howto.tmpl > +++ b/Documentation/DocBook/uio-howto.tmpl > @@ -46,6 +46,13 @@ GPL version 2. > > > > + 0.10 > + 2016-10-17 > + sch > + Added generic hyperv driver > + > + > + > 0.9 > 2009-07-16 > mst > @@ -1033,6 +1040,61 @@ int main() > > > > + > + > +Generic Hyper-V UIO driver > + > + The generic driver is a kernel module named uio_hv_generic. > + It supports devices on the Hyper-V VMBus similar to uio_pci_generic > + on PCI bus. > + > + > + > +Making the driver recognize the device > + > +Since the driver does not declare any device GUID's, it will not get loaded > +automatically and will not automatically bind to any devices, you must load > it > +and allocate id to the driver yourself. For example, to use the network > device > +GUID: > + > + modprobe uio_hv_generic > + echo "f8615163-df3e-46c5-913f-f2d2f965ed0e" > > /sys/bus/vmbus/drivers/uio_hv_generic/new_id > + > + > + > +If there already is a hardware specific kernel driver for the device, the > +generic driver still won't bind to it, in this case if you want to use the > +generic driver (why would you?) you'll have to manually unbind the hardware > +specific driver and bind the generic driver, like this: > + > + echo -n vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3 > > /sys/bus/vmbus/drivers/hv_netvsc/unbind > + echo -n vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3 > > /sys/bus/vmbus/drivers/uio_hv_generic/bind > + > + > + > +You can verify that the device has been bound to the driver > +by looking for it in sysfs, for example like the following: > + > +ls -l > /sys/bus/vmbus/devices/vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3/driver > + > +Which if successful should print > + > + .../vmbus-ed963694-e847-4b2a-85af-bc9cfc11d6f3/driver -> > ../../../bus/vmbus/drivers/uio_hv_generic > + > + > + > + > + > +Things to know about uio_hv_generic > + > +On each interrupt, uio_hv_generic sets the Interrupt Disable bit. > +This prevents the device from generating further interrupts > +until the bit is cleared. The userspace driver should clear this > +bit before blocking and waiting for more interrupts. > + > + > + > + > > Further information > -- Jani Nikula, Intel Open Source Technology Center ___ devel mailing list de...@linuxdriverproject.org http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel