summaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/uio-howto.tmpl (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc: convert UIO howto from docbook to sphinxAlexander Dahl2017-01-311-1112/+0
| | | | | | | | | Converted with tmplcvt. Only some tiny things needed manual fixing. Signed-off-by: Alexander Dahl <post@lespocky.de> Cc: Hans-Jürgen Koch <hjk@hansjkoch.de> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* doc: add documentation for uio-hv-genericStephen Hemminger2016-10-211-0/+62
| | | | | | | | Update UIO documentation to include basic information about uio_hv_generic. Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* pdfdocs: Fix 'make pdfdocs' failure for 'uio-howto.tmpl'Sharon Dvir2015-02-041-7/+7
| | | | | | | | | | 'make pdfdocs' failed for uio-howto.tmpl and reported errors of the form: 'document type does not allow element "varname" here; missing one of "remark", "synopsis", "fieldsynopsis", "literallayout", "programlisting", "screen", "para", "simpara", "bridgehead" start-tag' and similar. Fixed by adding '<para>' and '</para>' tags to a location that made sense, fixed the errors and the pdf looks OK in relevant ereas. Signed-off-by: Sharon Dvir <sharon.dvir1@mail.huji.ac.il> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* uio: support memory sizes larger than 32 bitsCristian Stoica2014-11-071-1/+1
| | | | | | | | | This is a completion to 27a90700a4275c5178b883b65927affdafa5185c The size field is also increased to allow values larger than 32 bits on platforms that have more than 32 bit physical addresses. Signed-off-by: Cristian Stoica <cristian.stoica@freescale.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* DocBook: fix various typosMasanari Iida2014-07-121-2/+2
| | | | | | | | | This patch fixed spelling typo in various template files within Documentation/Docbook. Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* uio-howto: example bugStephen Hemminger2013-01-171-1/+1
| | | | | | | | Bug in demo program, checking wrong return value Signed-off-by: Stephen Hemminger <stephen@networkplumber.org> Cc: "Hans J. Koch" <hjk@hansjkoch.de> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* drivers: uio_dmem_genirq: Don't use DMA_ERROR_CODE to indicate unmapped regionsDamian Hobson-Garcia2012-11-211-1/+1
| | | | | | | | | | | DMA_ERROR_CODE is not defined on all architectures and is architecture specific. Instead, use the constant, ~0 to indicate unmapped regions. Reported-by: Fengguang Wu <fengguang.wu@intel.com> Reported-by: Geert Uytterhoeven <geert@linux-m68k.org> Signed-off-by: Damian Hobson-Garcia <dhobsong@igel.co.jp> Cc: "Hans J. Koch" <hjk@hansjkoch.de> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Add uio_dmem_genirq description to UIO documentationDamian Hobson-Garcia2012-10-251-0/+56
| | | | | | Signed-off-by: Damian Hobson-Garcia <dhobsong@igel.co.jp> Signed-off-by: "Hans J. Koch" <hjk@hansjkoch.de> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* uio: documentation fixupsGeoff Thorpe2011-11-151-1/+6
| | | | | | | | | The 'name' attribute of struct uio_mem wasn't documented, and the note about 'kobj' is stale and needs to be changed to 'map'. Signed-off-by: Geoff Thorpe <geoff@geoffthorpe.net> Signed-off-by: "Hans J. Koch" <hjk@hansjkoch.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* uio: Support physical addresses >32 bits on 32-bit systemsKai Jiang2011-10-181-1/+1
| | | | | | | | | | | | | | | | | | | | | | | To support >32-bit physical addresses for UIO_MEM_PHYS type we need to extend the width of 'addr' in struct uio_mem. Numerous platforms like embedded PPC, ARM, and X86 have support for systems with larger physical address than logical. Since 'addr' may contain a physical, logical, or virtual address the easiest solution is to just change the type to 'phys_addr_t' which should always be greater than or equal to the sizeof(void *) such that it can properly hold any of the address types. For physical address we can support up to a 44-bit physical address on a typical 32-bit system as we utilize remap_pfn_range() for the mapping of the memory region and pfn's are represnted by shifting the address by the page size (typically 4k). Signed-off-by: Kai Jiang <Kai.Jiang@freescale.com> Signed-off-by: Minghuan Lian <Minghuan.Lian@freescale.com> Signed-off-by: Kumar Gala <galak@kernel.crashing.org> Signed-off-by: Hans J. Koch <hjk@hansjkoch.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* Fix common misspellingsLucas De Marchi2011-03-311-1/+1
| | | | | | Fixes generated by 'codespell' and manually reviewed. Signed-off-by: Lucas De Marchi <lucas.demarchi@profusion.mobi>
* Documentation: change email address for Hans KochHans J. Koch2010-11-191-3/+3
| | | | | | | | | My old mail address doesn't exist anymore. This changes all occurrences to my new address. Signed-off-by: Hans J. Koch <hjk@hansjkoch.de> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* uio: add generic driver for PCI 2.3 devicesMichael S. Tsirkin2009-09-151-0/+163
| | | | | | | | | | | | | | | | | | | | | | | | | This adds a generic uio driver that can bind to any PCI device. First user will be virtualization where a qemu userspace process needs to give guest OS access to the device. Interrupts are handled using the Interrupt Disable bit in the PCI command register and Interrupt Status bit in the PCI status register. All devices compliant to PCI 2.3 (circa 2002) and all compliant PCI Express devices should support these bits. Driver detects this support, and won't bind to devices which do not support the Interrupt Disable Bit in the command register. It's expected that more features of interest to virtualization will be added to this driver in the future. Possibilities are: mmap for device resources, MSI/MSI-X, eventfd (to interface with kvm), iommu. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Acked-by: Chris Wright <chrisw@redhat.com> Signed-off-by: Hans J. Koch <hjk@linutronix.de> Acked-by: Jesse Barnes <jbarnes@virtuousgeek.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* UIO: Add name attributes for mappings and port regionsHans J. Koch2009-03-251-4/+25
| | | | | | | | | | | | | | | | | | | If a UIO device has several memory mappings, it can be difficult for userspace to find the right one. The situation becomes even worse if the UIO driver can handle different versions of a card that have different numbers of mappings. Benedikt Spranger has such cards and pointed this out to me. Thanks, Bene! To address this problem, this patch adds "name" sysfs attributes for each mapping. Userspace can use these to clearly identify each mapping. The name string is optional. If a driver doesn't set it, an empty string will be returned, so this patch won't break existing drivers. The same problem exists for port region information, so a "name" attribute is added there, too. Signed-off-by: Hans J. Koch <hjk@linutronix.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* UIO: Add missing documentation of features added recentlyHans J. Koch2009-01-291-0/+88
| | | | | | | | | | | | | | | | The following features were added to the UIO framework in the near past: * Generic drivers for platform devices (uio_pdrv, uio_pdrv_genirq) * an "offset" sysfs attribute for memory mappings Unfortunately, all this went in without documentation (won't happen again...) This patch updates UIO documentation. Signed-off-by: Hans J. Koch <hjk@linutronix.de> Acked-by: Uwe Kleine-König <ukleinek@strlen.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* uio: make uio_info's name and version constStephen Rothwell2009-01-061-2/+2
| | | | | | | | | | | | | These are only ever assigned constant strings and never modified. This was noticed because Wolfram Sang needed to cast the result of of_get_property() in order to assign it to the name field of a struct uio_info. Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Hans J. Koch <hjk@linutronix.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* UIO: Documentation for UIO ioport info handlingHans J. Koch2009-01-061-0/+97
| | | | | | | | | This patch updates UIO documentation with the changes introduced by previous UIO patch. Signed-off-by: Hans J. Koch <hjk@linutronix.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* uio-howto.tmpl: use unique output namesMike Frysinger2008-07-221-1/+1
| | | | | | | | | | | | | The Userspace I/O HOWTO template sets two different sections with the same html output name (about.html). This clearly won't work, so change the first one to a unique "aboutthis.html" to prevent clobbering. Signed-off-by: Mike Frysinger <vapier@gentoo.org> Acked-by: Hans J. Koch <hjk@linutronix.de> Cc: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* uio-howto.tmpl: use standard copyright/legal markingsMike Frysinger2008-07-221-11/+12
| | | | | | | | | | | | | The Userspace I/O HOWTO document uses straight <sect1> tags and plain text to describe copyright/legal information. It should instead use the <copyright> and <legalnotice> tags like all other documents in the kernel. Signed-off-by: Mike Frysinger <vapier@gentoo.org> Acked-by: Hans J. Koch <hjk@linutronix.de> Cc: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* UIO: Add write function to allow irq maskingHans J. Koch2008-07-221-1/+39
| | | | | | | | | | | | | | Sometimes it is necessary to enable/disable the interrupt of a UIO device from the userspace part of the driver. With this patch, the UIO kernel driver can implement an "irqcontrol()" function that does this. Userspace can write an s32 value to /dev/uioX (usually 0 or 1 to turn the irq off or on). The UIO core will then call the driver's irqcontrol function. Signed-off-by: Hans J. Koch <hjk@linutronix.de> Acked-by: Uwe Kleine-König <Uwe.Kleine-Koenig@digi.com> Acked-by: Magnus Damm <damm@igel.co.jp> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* UIO: fix up the UIO documentationHans J Koch2007-11-281-58/+32
| | | | | | | | | | Remove references to the old uio_dummy demo module from UIO documentation. Add a small paragraph to make it clearer that UIO is not a universal driver interface. Signed-off-by: Hans J Koch <hjk@linutronix.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* remove dubious legal statment from uio-howtoAlan Cox2007-08-091-4/+0
| | | | | | | | | | | | | UIO currently contains a rather dubious statement which wants removing. The actual questions around whether user space code that depends tightly on kernel GPL code designed to co-work with it are derivative works of the kernel is extremely complex, and since we don't have space for either a masters length essay on legal issues or need to start flamewars lets simply remove the comment and leave law to lawyers Signed-off-by: Alan Cox <alan@redhat.com> Signed-off-by: Linus Torvalds <tovalds@linux-foundation.org>
* UIO: DocumentationHans J. Koch2007-07-191-0/+611
Documentation for the UIO interface From: Hans J. Koch <hjk@linutronix.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-22 22:47:33 +0100