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: Geoff Thorpe <geoff@geoffthorpe.net> Signed-off-by: "Hans J. Koch" <hjk@hansjkoch.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
This commit is contained in:
parent
7b08fae8fb
commit
b2433d861e
|
@ -520,6 +520,11 @@ Here's a description of the fields of <varname>struct uio_mem</varname>:
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<itemizedlist>
|
<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>
|
<listitem><para>
|
||||||
<varname>int memtype</varname>: Required if the mapping is used. Set this to
|
<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
|
<varname>UIO_MEM_PHYS</varname> if you you have physical memory on your
|
||||||
|
@ -553,7 +558,7 @@ instead to remember such an address.
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
|
||||||
<para>
|
<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
|
<varname>struct uio_mem</varname>! It is used by the UIO framework
|
||||||
to set up sysfs files for this mapping. Simply leave it alone.
|
to set up sysfs files for this mapping. Simply leave it alone.
|
||||||
</para>
|
</para>
|
||||||
|
|
Loading…
Reference in New Issue