Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b2433d86 authored by Geoff Thorpe's avatar Geoff Thorpe Committed by Greg Kroah-Hartman
Browse files

uio: documentation fixups 



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: default avatarGeoff Thorpe <geoff@geoffthorpe.net>
Signed-off-by: default avatar"Hans J. Koch" <hjk@hansjkoch.de>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@suse.de>
parent 7b08fae8

Documentation/DocBook/uio-howto.tmpl

+6 −1
Original line number Diff line number Diff line
@@ -520,6 +520,11 @@ Here's a description of the fields of <varname>struct uio_mem</varname>: 
</para>



<itemizedlist>

<listitem><para>

<varname>const char *name</varname>: Optional. Set this to help identify

the memory region, it will show up in the corresponding sysfs node.

</para></listitem>



<listitem><para>

<varname>int memtype</varname>: Required if the mapping is used. Set this to

<varname>UIO_MEM_PHYS</varname> if you you have physical memory on your
@@ -553,7 +558,7 @@ instead to remember such an address. 
</itemizedlist>



<para>

Please do not touch the <varname>kobj</varname> element of

Please do not touch the <varname>map</varname> element of

<varname>struct uio_mem</varname>! It is used by the UIO framework

to set up sysfs files for this mapping. Simply leave it alone.

</para>