1 files changed, 276 insertions, 0 deletions
diff --git a/docs/reference/api/html/ModemManager-Common-udev-tags.html b/docs/reference/api/html/ModemManager-Common-udev-tags.html
new file mode 100644
index 00000000..1af9f43a
--- /dev/null
+++ b/docs/reference/api/html/ModemManager-Common-udev-tags.html
@@ -0,0 +1,276 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Common udev tags: ModemManager Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
+<link rel="home" href="index.html" title="ModemManager Reference Manual">
+<link rel="up" href="ref-udev.html" title="Part III. Common udev tag definitions">
+<link rel="prev" href="ref-udev.html" title="Part III. Common udev tag definitions">
+<link rel="next" href="ref-dbus.html" title="Part IV. D-Bus Reference">
+<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
+                  <a href="#ModemManager-Common-udev-tags.description" class="shortcut">Description</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="ref-udev.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="ref-udev.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="ref-dbus.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="ModemManager-Common-udev-tags"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ModemManager-Common-udev-tags.top_of_page"></a>Common udev tags</span></h2>
+<p>Common udev tags — generic udev tags supported</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="ModemManager-Common-udev-tags.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-CANDIDATE:CAPS" title="ID_MM_CANDIDATE">ID_MM_CANDIDATE</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PHYSDEV-UID:CAPS" title="ID_MM_PHYSDEV_UID">ID_MM_PHYSDEV_UID</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PORT-IGNORE:CAPS" title="ID_MM_PORT_IGNORE">ID_MM_PORT_IGNORE</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-DEVICE-PROCESS:CAPS" title="ID_MM_DEVICE_PROCESS">ID_MM_DEVICE_PROCESS</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-DEVICE-IGNORE:CAPS" title="ID_MM_DEVICE_IGNORE">ID_MM_DEVICE_IGNORE</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-DEVICE-MANUAL-SCAN-ONLY:CAPS" title="ID_MM_DEVICE_MANUAL_SCAN_ONLY">ID_MM_DEVICE_MANUAL_SCAN_ONLY</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PLATFORM-DRIVER-PROBE:CAPS" title="ID_MM_PLATFORM_DRIVER_PROBE">ID_MM_PLATFORM_DRIVER_PROBE</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PORT-TYPE-AT-PPP:CAPS" title="ID_MM_PORT_TYPE_AT_PPP">ID_MM_PORT_TYPE_AT_PPP</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PORT-TYPE-AT-PRIMARY:CAPS" title="ID_MM_PORT_TYPE_AT_PRIMARY">ID_MM_PORT_TYPE_AT_PRIMARY</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PORT-TYPE-AT-SECONDARY:CAPS" title="ID_MM_PORT_TYPE_AT_SECONDARY">ID_MM_PORT_TYPE_AT_SECONDARY</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PORT-TYPE-GPS:CAPS" title="ID_MM_PORT_TYPE_GPS">ID_MM_PORT_TYPE_GPS</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-PORT-TYPE-QCDM:CAPS" title="ID_MM_PORT_TYPE_QCDM">ID_MM_PORT_TYPE_QCDM</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-TTY-BAUDRATE:CAPS" title="ID_MM_TTY_BAUDRATE">ID_MM_TTY_BAUDRATE</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ModemManager-Common-udev-tags.html#ID-MM-TTY-FLOW-CONTROL:CAPS" title="ID_MM_TTY_FLOW_CONTROL">ID_MM_TTY_FLOW_CONTROL</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ModemManager-Common-udev-tags.description"></a><h2>Description</h2>
+<p>This section defines generic udev tags that are used by ModemManager,
+associated to full devices or to specific ports in a given device.</p>
+</div>
+<div class="refsect1">
+<a name="ModemManager-Common-udev-tags.functions_details"></a><h2>Functions</h2>
+<p></p>
+</div>
+<div class="refsect1">
+<a name="ModemManager-Common-udev-tags.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ID-MM-CANDIDATE:CAPS"></a><h3>ID_MM_CANDIDATE</h3>
+<pre class="programlisting">#define ID_MM_CANDIDATE "ID_MM_CANDIDATE"
+</pre>
+<p>This is a port-specific tag added automatically when all other
+ModemManager related tags have already been set.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PHYSDEV-UID:CAPS"></a><h3>ID_MM_PHYSDEV_UID</h3>
+<pre class="programlisting">#define ID_MM_PHYSDEV_UID "ID_MM_PHYSDEV_UID"
+</pre>
+<p>This is a device-specific tag that allows users to 'name' modem
+devices with a predefined 'unique ID' string.</p>
+<p>When this tag is given per-port, the daemon will consider that all
+ports with the same UID value are associated to the same device.
+This is useful for e.g. modems that expose multiple RS232 ports
+connected to the system via different platform ports (or USB to
+RS232 adapters).</p>
+<p>This UID is exposed in
+the '<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Device" title='The "Device" property'>Device</a>'
+property and can then be used in mmcli calls to refer unequivocally
+to a specific device, regardless of its modem index, e.g.:
+ $ mmcli --modem=UID ...</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PORT-IGNORE:CAPS"></a><h3>ID_MM_PORT_IGNORE</h3>
+<pre class="programlisting">#define ID_MM_PORT_IGNORE "ID_MM_PORT_IGNORE"
+</pre>
+<p>This is a port-specific tag that allows explicitly ignoring a given port
+in a device.</p>
+<p>This tag applies to all types of ports.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-DEVICE-PROCESS:CAPS"></a><h3>ID_MM_DEVICE_PROCESS</h3>
+<pre class="programlisting">#define ID_MM_DEVICE_PROCESS "ID_MM_DEVICE_PROCESS"
+</pre>
+<p>This is a device-specific tag that allows explicitly requesting the
+processing of all ports exposed by the device. This tag is usually
+used by users when the daemon runs with WHITELIST-ONLY filter policy
+type, and is associated to the MM_FILTER_RULE_EXPLICIT_WHITELIST rule.</p>
+<p>This tag may also be specified in specific ports, e.g. when the modem
+exposes a single platform port without any parent device.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-DEVICE-IGNORE:CAPS"></a><h3>ID_MM_DEVICE_IGNORE</h3>
+<pre class="programlisting">#define ID_MM_DEVICE_IGNORE "ID_MM_DEVICE_IGNORE"
+</pre>
+<p>This is a device-specific tag that allows explicitly blacklisting
+devices that expose TTY devices so that they are never probed.</p>
+<p>This tag is used when the daemon runs with DEFAULT or PARANOID
+filter policy type, and is associated to the MM_FILTER_RULE_TTY_BLACKLIST
+rule.</p>
+<p>This tag is ignored when the STRICT filter policy is used.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-DEVICE-MANUAL-SCAN-ONLY:CAPS"></a><h3>ID_MM_DEVICE_MANUAL_SCAN_ONLY</h3>
+<pre class="programlisting">#define ID_MM_DEVICE_MANUAL_SCAN_ONLY "ID_MM_DEVICE_MANUAL_SCAN_ONLY"
+</pre>
+<p>This is a device-specific tag that allows explicitly greylisting
+devices that expose TTY devices so that they are never probed
+automatically. Instead, an explicit manual scan request may be sent
+to the daemon so that the TTY ports exposed by the device are
+probed.</p>
+<p>This tag is used when the daemon runs with DEFAULT or PARANOID
+filter policy type, and is associated to the MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY
+rule.</p>
+<p>This tag is ignored when the STRICT filter policy is used.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PLATFORM-DRIVER-PROBE:CAPS"></a><h3>ID_MM_PLATFORM_DRIVER_PROBE</h3>
+<pre class="programlisting">#define ID_MM_PLATFORM_DRIVER_PROBE "ID_MM_PLATFORM_DRIVER_PROBE"
+</pre>
+<p>This is a port-specific tag applied to platform ports so that they
+are probed automatically by the daemon. Platform ports that don't
+have this tag will never probed. This tag is a bit redundant, as
+the user could also use ID_MM_DEVICE_PROCESS for the same purpose.</p>
+<p>This tag is associated to the MM_FILTER_RULE_TTY_PLATFORM_DRIVER
+rule, which is only meaningful when the daemon runs with the
+DEFAULT filter policy type, as that is the only one that would
+allow probing all ports not explicitly forbidden before the last
+MM_FILTER_RULE_TTY_DEFAULT_ALLOWED rule.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PORT-TYPE-AT-PPP:CAPS"></a><h3>ID_MM_PORT_TYPE_AT_PPP</h3>
+<pre class="programlisting">#define ID_MM_PORT_TYPE_AT_PPP "ID_MM_PORT_TYPE_AT_PPP"
+</pre>
+<p>This is a port-specific tag applied to TTYs that we know in advance
+are AT ports to be used as data ports exclusively.</p>
+<p>This tag will also prevent QCDM probing on the port.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PORT-TYPE-AT-PRIMARY:CAPS"></a><h3>ID_MM_PORT_TYPE_AT_PRIMARY</h3>
+<pre class="programlisting">#define ID_MM_PORT_TYPE_AT_PRIMARY "ID_MM_PORT_TYPE_AT_PRIMARY"
+</pre>
+<p>This is a port-specific tag applied to TTYs that we know in advance
+are AT ports to be used as primary control ports.</p>
+<p>This tag will also prevent QCDM probing on the port.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PORT-TYPE-AT-SECONDARY:CAPS"></a><h3>ID_MM_PORT_TYPE_AT_SECONDARY</h3>
+<pre class="programlisting">#define ID_MM_PORT_TYPE_AT_SECONDARY "ID_MM_PORT_TYPE_AT_SECONDARY"
+</pre>
+<p>This is a port-specific tag applied to TTYs that we know in advance
+are AT ports to be used as secondary control ports.</p>
+<p>This tag will also prevent QCDM probing on the port.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PORT-TYPE-GPS:CAPS"></a><h3>ID_MM_PORT_TYPE_GPS</h3>
+<pre class="programlisting">#define ID_MM_PORT_TYPE_GPS "ID_MM_PORT_TYPE_GPS"
+</pre>
+<p>This is a port-specific tag applied to TTYs that we know in advance
+are GPS data ports where we expect to receive NMEA traces.</p>
+<p>This tag also prevents AT and QCDM probing in the port.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-PORT-TYPE-QCDM:CAPS"></a><h3>ID_MM_PORT_TYPE_QCDM</h3>
+<pre class="programlisting">#define ID_MM_PORT_TYPE_QCDM "ID_MM_PORT_TYPE_QCDM"
+</pre>
+<p>This is a port-specific tag applied to TTYs that we know in advance
+are QCDM ports.</p>
+<p>The only purpose of this tag is to prevent AT probing in the port.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-TTY-BAUDRATE:CAPS"></a><h3>ID_MM_TTY_BAUDRATE</h3>
+<pre class="programlisting">#define ID_MM_TTY_BAUDRATE "ID_MM_TTY_BAUDRATE"
+</pre>
+<p>This is a port-specific tag applied to TTYs that require a specific
+baudrate to work. USB modems will usually allow auto-bauding
+configuration, so this tag is really only meaningful to true RS232
+devices.</p>
+<p>The value of the tag should be the number of bauds per second to
+use when talking to the port, e.g. "115200". If not given, the
+default of 57600bps is assumed.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ID-MM-TTY-FLOW-CONTROL:CAPS"></a><h3>ID_MM_TTY_FLOW_CONTROL</h3>
+<pre class="programlisting">#define ID_MM_TTY_FLOW_CONTROL "ID_MM_TTY_FLOW_CONTROL"
+</pre>
+<p>This is a port-specific tag applied to TTYs that require a specific
+flow control mechanism to work not only in data mode but also in
+control mode.</p>
+<p>The value of the tag should be either 'none', 'xon-xoff' or
+'rts-cts', and must be a flow control value supported by the device
+where it's configured. If not given, it is assumed that the TTYs
+don't require any specific flow control setting in command mode.</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>Generated by GTK-Doc V1.29</div>
+</body>
+</html>
+\ No newline at end of file