aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/api')
-rw-r--r--docs/reference/api/ModemManager-overview.xml29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/reference/api/ModemManager-overview.xml b/docs/reference/api/ModemManager-overview.xml
index ebb81585..01dc532f 100644
--- a/docs/reference/api/ModemManager-overview.xml
+++ b/docs/reference/api/ModemManager-overview.xml
@@ -238,6 +238,20 @@
by the plugin.
</para>
</listitem>
+ <listitem>
+ <para><emphasis>Check Icera support</emphasis></para>
+ <para>
+ This boolean property allows plugins to specify that they want to have the Icera
+ support checks included in the probing sequence. They can afterwards get the result
+ of the support check to decide whether they want to create a Icera-based modem
+ object or not.
+ </para>
+ <para>
+ This configuration is specified by the <type>MM_PLUGIN_ICERA_PROBE</type>
+ property in the <structname>MMPlugin</structname> object provided
+ by the plugin.
+ </para>
+ </listitem>
</itemizedlist>
</section>
@@ -283,6 +297,21 @@
by the plugin.
</para>
</listitem>
+ <listitem>
+ <para><emphasis>Icera support</emphasis></para>
+ <para>
+ Plugins can specify that they only support Icera-based modems, or that they
+ do not support any Icera-based modem. When either of this configurations is
+ enabled, the Icera support checks will be included in the
+ probing sequence, and the result of the check will help to determine whether
+ the plugin supports the modem or not.
+ </para>
+ <para>
+ This filter is specified by the <type>MM_PLUGIN_ALLOWED_ICERA</type> and
+ <type>MM_PLUGIN_FORBIDDEN_ICERA</type> properties in the
+ <structname>MMPlugin</structname> object provided by the plugin.
+ </para>
+ </listitem>
</itemizedlist>
<note>