1
0
mirror of https://github.com/systemd/systemd.git synced 2025-02-03 17:47:28 +03:00

man: minor wording improvements to USB FunctionFS documentation

This commit is contained in:
Lennart Poettering 2015-10-01 14:26:42 +02:00
parent d4e783e44d
commit 3d3145100d
2 changed files with 22 additions and 19 deletions

View File

@ -905,21 +905,23 @@
<varlistentry>
<term><varname>USBFunctionDescriptors=</varname></term>
<listitem><para>Configure the location of the file containing
<ulink url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">functionfs</ulink>
descriptors. This is is used only when a socket with
<varname>ListenUSBFunction=</varname> configured wants to
activate this service. Content of this file is writen to
<filename>ep0</filename> file after it is opened. This is
required for socket activation using
<varname>ListenUSBFunction=</varname> (i.e. for passing all
functionfs endpoints to the service).</para></listitem>
<listitem><para>Configure the location of a file containing
<ulink
url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB
FunctionFS</ulink> descriptors, for implementation of USB
gadget functions. This is is used only in conjunction with a
socket unit with <varname>ListenUSBFunction=</varname>
configured. The contents of this file is written to the
<filename>ep0</filename> file after it is
opened.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>USBFunctionStrings=</varname></term>
<listitem><para>Configure the location of file containing FunctionFS strings.
Behavior is similar to <varname>USBFunctionDescriptors</varname>.</para></listitem>
<listitem><para>Configure the location of a file containing
USB FunctionFS strings. Behavior is similar to
<varname>USBFunctionDescriptors=</varname>
above.</para></listitem>
</varlistentry>
</variablelist>

View File

@ -262,14 +262,15 @@
<varlistentry>
<term><varname>ListenUSBFunction=</varname></term>
<listitem><para>Specifies a
<ulink url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">functionfs</ulink>
endpoint location to
listen on. This expects an absolute file system path as the
argument. Behavior otherwise is very similar to the
<varname>ListenFIFO=</varname> directive above. Use this to
open functionfs endpoint <filename>ep0</filename>. When using
this option, activated service has to have the
<listitem><para>Specifies a <ulink
url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB
FunctionFS</ulink> endpoint location to listen on, for
implementation of USB gadget functions. This expects an
absolute file system path as the argument. Behavior otherwise
is very similar to the <varname>ListenFIFO=</varname>
directive above. Use this to open FunctionFS endpoint
<filename>ep0</filename>. When using this option, the
activated service has to have the
<varname>USBFunctionDescriptors=</varname> and
<varname>USBFunctionStrings=</varname> options set.
</para></listitem>