aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/api
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2021-06-16 10:18:33 +0200
committerAleksander Morgado <aleksander@aleksander.es>2021-06-16 11:59:51 +0200
commit9639e52726854782508e35a75c6abf874bd9e608 (patch)
treeb38f61a57f2eb93fe8f8987e56c272ef6e5cc79c /docs/reference/api
parent00c1bbfd570492ff6661cfdda8d8a0dcb0e087a4 (diff)
filter: remove support for TTY blacklist, TTY greylist and TTY default allowed
These lists were used in the corresponding TTY_BLACKLIST and TTY_MANUAL_SCAN_ONLY filter rules, in the LEGACY and PARANOID filter types, which are no longer supported. The DEFAULT_ALLOWED filter rule made sense only in the LEGACY filter type, and therefore it is also now removed, leaving the DEFAULT_FORBIDDEN fallback rule exclusively. In other words, there is now no way to ask ModemManager to implicitly allow TTY ports; the only way to do that is by explicit making the TTY ports fall in one filter rule that would allow them.
Diffstat (limited to 'docs/reference/api')
-rw-r--r--docs/reference/api/ModemManager-overview.xml52
-rw-r--r--docs/reference/api/ModemManager-sections.txt5
2 files changed, 29 insertions, 28 deletions
diff --git a/docs/reference/api/ModemManager-overview.xml b/docs/reference/api/ModemManager-overview.xml
index e2316a5a..dd4acbea 100644
--- a/docs/reference/api/ModemManager-overview.xml
+++ b/docs/reference/api/ModemManager-overview.xml
@@ -197,37 +197,12 @@ $ sudo udevadm trigger
</para>
</listitem>
<listitem>
- <para><emphasis>MM_FILTER_RULE_TTY, MM_FILTER_RULE_TTY_DEFAULT_ALLOWED and MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN</emphasis></para>
+ <para><emphasis>MM_FILTER_RULE_TTY</emphasis></para>
<para>
If the MM_FILTER_RULE_TTY filter is disabled, no TTY port will be allowed. If this
filter is enabled, TTY ports will only be allowed if the TTY-specific filters (defined
next) allow it.
</para>
- <para>
- The MM_FILTER_RULE_TTY_DEFAULT_ALLOWED and MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN rules allow
- defining what happens when a TTY port isn't explicitly forbidden or accepted by any of
- the TTY-specific filters. When MM_FILTER_RULE_TTY is enabled, one of these other two options
- must be set.
- </para>
- </listitem>
- <listitem>
- <para><emphasis>MM_FILTER_RULE_TTY_BLACKLIST</emphasis></para>
- <para>
- This filter will not allow probing any of the devices flagged as
- <emphasis>ID_MM_TTY_BLACKLIST</emphasis>, like the ones in the default blacklist
- shipped by ModemManager.
- </para>
- </listitem>
- <listitem>
- <para><emphasis>MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY</emphasis></para>
- <para>
- This filter will not allow automatic probing any of the devices flagged as
- <emphasis>ID_MM_TTY_MANUAL_SCAN_ONLY</emphasis>, like the ones in the default
- USB serial adapters greylist shipped by ModemManager. Devices flagged like
- this will only be probed when a manual scan is requested via the
- <link linkend="gdbus-method-org-freedesktop-ModemManager1.ScanDevices">ScanDevices</link>
- method.
- </para>
</listitem>
<listitem>
<para><emphasis>MM_FILTER_RULE_TTY_PLATFORM_DRIVER</emphasis></para>
@@ -258,6 +233,13 @@ $ sudo udevadm trigger
</para>
</listitem>
<listitem>
+ <para><emphasis>MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN</emphasis></para>
+ <para>
+ This rule is the implicit one defining what happens when a TTY port isn't explicitly
+ accepted by any of the TTY-specific filters; i.e. the TTY port will be forbidden.
+ </para>
+ </listitem>
+ <listitem>
<para><emphasis>MM_FILTER_RULE_WWAN</emphasis></para>
<para>
This filter will automatically flag as allowed all wwan control ports exposed
@@ -270,6 +252,24 @@ $ sudo udevadm trigger
</listitem>
</itemizedlist>
</para>
+
+ <para>
+ The following filter rules have been deprecated and are no longer used.
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>MM_FILTER_RULE_TTY_BLACKLIST</emphasis></para>
+ <para>
+ Deprecated in 1.18.0.
+ </para>
+ </listitem>
+ <listitem>
+ <para><emphasis>MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY</emphasis></para>
+ <para>
+ Deprecated in 1.18.0.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
</section>
<section>
diff --git a/docs/reference/api/ModemManager-sections.txt b/docs/reference/api/ModemManager-sections.txt
index 9b3e4f3d..74f7c8c6 100644
--- a/docs/reference/api/ModemManager-sections.txt
+++ b/docs/reference/api/ModemManager-sections.txt
@@ -200,8 +200,6 @@ ID_MM_PHYSDEV_UID
ID_MM_DEVICE_PROCESS
ID_MM_DEVICE_IGNORE
ID_MM_PORT_IGNORE
-ID_MM_TTY_BLACKLIST
-ID_MM_TTY_MANUAL_SCAN_ONLY
ID_MM_PORT_TYPE_AT_PPP
ID_MM_PORT_TYPE_AT_PRIMARY
ID_MM_PORT_TYPE_AT_SECONDARY
@@ -212,4 +210,7 @@ ID_MM_PORT_TYPE_QMI
ID_MM_PORT_TYPE_MBIM
ID_MM_TTY_BAUDRATE
ID_MM_TTY_FLOW_CONTROL
+<SUBSECTION Deprecated>
+ID_MM_TTY_BLACKLIST
+ID_MM_TTY_MANUAL_SCAN_ONLY
</SECTION>