SymbX/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

plugin: renamed custom-init' property to custom-at-probe'

Browse Source 
The `custom-at-probe' property is just to modify the way we check for AT port
support.
This commit is contained in:
Aleksander Morgado
2012-08-06 20:06:46 +02:00
parent 89b3c01328
commit 9b0f6c83f2
6 changed files with 47 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/api/ModemManager-overview.xml
+21 -29
View File
@@ -171,26 +171,6 @@
prepare the information required in any expected post-probing filter.
</para>
<itemizedlist>
<listitem>
<para><emphasis>Custom AT initialization</emphasis></para>
<para>
This property allows plugins to specify custom initialization sequences to
run in the modem before any additional probing happens. This helps in the cases
where modems require commands to, for example, shutdown unsolicited messages.
</para>
<para>
An additional benefit of the custom initialization through AT commands is that
it can already provide information on whether the port is AT or not. In other
words, a plugin with custom initialization sequence which reports that the
port being initialized is AT won't run the generic checks to see if the port is
AT or not.
</para>
<para>
This configuration is specified by the <type>MM_PLUGIN_CUSTOM_INIT</type>
property in the <structname>MMPlugin</structname> object provided
by the plugin.
</para>
</listitem>
<listitem>
<para><emphasis>AT allowed</emphasis></para>
<para>
@@ -216,6 +196,18 @@
by the plugin.
</para>
</listitem>
<listitem>
<para><emphasis>Custom AT probing</emphasis></para>
<para>
This property allows plugins to specify custom commands to check whether a port
is AT or not. By default, the 'AT' command will be used if no custom one specified.
</para>
<para>
This configuration is specified by the <type>MM_PLUGIN_CUSTOM_AT_PROBE</type>
property in the <structname>MMPlugin</structname> object provided
by the plugin.
</para>
</listitem>
<listitem>
<para><emphasis>QCDM allowed</emphasis></para>
<para>
@@ -352,10 +344,10 @@ mm_plugin_create (void)
<title>Probing setup for a plugin with custom initialization requirements</title>
<programlisting>
static gboolean
parse_init (const gchar *response,
const GError *error,
GValue *result,
GError **result_error)
parse_custom_at (const gchar *response,
const GError *error,
GValue *result,
GError **result_error)
{
if (error) {
*result_error = g_error_copy (error);
@@ -368,8 +360,8 @@ parse_init (const gchar *response,
return TRUE;
}
static const MMPortProbeAtCommand custom_init[] = {
{ "ATE1 E0", parse_init },
static const MMPortProbeAtCommand custom_at_probe[] = {
{ "AT+SOMETHING", parse_custom_at },
{ NULL }
};
@@ -380,7 +372,7 @@ mm_plugin_create (void)
static const guint16 vendor_ids[] = { 0xabcd, 0 };
return MM_PLUGIN (
g_object_new (MM_TYPE_PLUGIN_NOKIA,
g_object_new (MM_TYPE_PLUGIN_EXAMPLE,
MM_PLUGIN_NAME, "Example",
/* Next items are pre-probing filters */
@@ -388,8 +380,8 @@ mm_plugin_create (void)
MM_PLUGIN_ALLOWED_VENDOR_IDS, vendor_ids,
/* Next items are probing sequence setup */
MM_PLUGIN_CUSTOM_INIT, custom_init,
MM_PLUGIN_ALLOWED_AT, TRUE,
MM_PLUGIN_CUSTOM_AT_PROBE, custom_at_probe,
MM_PLUGIN_ALLOWED_AT, TRUE,
/* No post-probing filters */
NULL));