From 84d205c9be4fa5e6d773ac60edc7200885da7af6 Mon Sep 17 00:00:00 2001 From: Aleksander Morgado Date: Mon, 30 Jul 2012 20:25:22 +0200 Subject: plugin: new filters for forbidden product IDs/strings Plugins may specify that specific vendor & product IDs or strings are not supported. This is useful when plugins need to specify that they support all devices of a given vendor except for some specific ones. --- docs/reference/api/ModemManager-overview.xml | 52 ++++++++++++++++++---------- 1 file changed, 33 insertions(+), 19 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/api/ModemManager-overview.xml b/docs/reference/api/ModemManager-overview.xml index 01dc532f..751dc687 100644 --- a/docs/reference/api/ModemManager-overview.xml +++ b/docs/reference/api/ModemManager-overview.xml @@ -105,22 +105,29 @@ - Allowed product IDs + Product IDs Plugins can provide a list of udev-reported pairs of vendor and product - IDs to be used as pre-probing filters. If the vendor ID and product ID - pair reported by the device via udev is found in the list provided by - the plugin, port probing will be launched as requested by the given - plugin. + IDs to be used as pre-probing filters. - This additional filter should be used when the plugin is - expected to work only with a given specific product of a given vendor. + If the vendor ID and product ID pair reported by the device via udev is + found in the list of 'allowed' pairs provided by the plugin, port probing + will be launched as requested by the given plugin. This additional filter + should be used when the plugin is expected to work only with a given + specific product of a given vendor. - This filter is specified by the MM_PLUGIN_ALLOWED_PRODUCT_IDS - property in the MMPlugin object provided - by the plugin. + If the vendor ID and product ID pair reported by the device via udev is + found in the list of 'forbidden' pairs provided by the plugin, port probing + will not be launched by this plugin. This additional filter + should be used when the plugin supports all devices of a given vendor + except for some specific ones. + + + These filters are specified by the MM_PLUGIN_ALLOWED_PRODUCT_IDS + and MM_PLUGIN_FORBIDDEN_PRODUCT_IDS properties in the + MMPlugin object provided by the plugin. @@ -280,21 +287,28 @@ - Allowed product strings + Product strings Plugins can provide a list of pairs of vendor and product - strings to be used as post-probing filters. If the vendor and product string - pair reported by the device via AT commands is found in the list provided by - the plugin, the plugin will report that it can handle this modem. + strings to be used as post-probing filters. - This additional filter should be used when the plugin is - expected to work only with a given specific product of a given vendor. + If the vendor and product string pair reported by the device via AT + commands is found in the 'allowed' list provided by the plugin, the + plugin will report that it can handle this modem. This additional filter + should be used when the plugin is expected to work only with a given + specific product of a given vendor. - This filter is specified by the MM_PLUGIN_ALLOWED_PRODUCT_STRINGS - property in the MMPlugin object provided - by the plugin. + If the vendor and product string pair reported by the device via AT + commands is found in the 'forbidden list provided by the plugin, the + plugin will report that it cannot handle this modem. This additional filter + should be used when the plugin supports all devices of a given vendor, except for some specific ones. + + + These filters are specified by the MM_PLUGIN_ALLOWED_PRODUCT_STRINGS + and MM_PLUGIN_FORBIDDEN_PRODUCT_STRINGS properties in the + MMPlugin object provided by the plugin. -- cgit v1.2.3-70-g09d2