[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[ce9b131] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY libqmi-download-http "https://www.freedesktop.org/software/libqmi/libqmi-&libqmi-version;.tar.xz">
|
---|
[ce9b131] | 8 | <!ENTITY libqmi-download-ftp " ">
|
---|
[ea5d4078] | 9 | <!ENTITY libqmi-md5sum "5ec8838914f80e1dfa4d2fa8cc2f186d">
|
---|
[9654a22] | 10 | <!ENTITY libqmi-size "1.2 MB">
|
---|
[88523c51] | 11 | <!ENTITY libqmi-buildsize "151 MB (with tests)">
|
---|
[bd14511f] | 12 | <!ENTITY libqmi-time "0.3 SBU (Using parallelism=4; with tests)">
|
---|
[ce9b131] | 13 | ]>
|
---|
| 14 |
|
---|
[7d645679] | 15 | <sect1 id="libqmi" xreflabel="libqmi-&libqmi-version;">
|
---|
[ce9b131] | 16 | <?dbhtml filename="libqmi.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libqmi-&libqmi-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libqmi">
|
---|
| 22 | <primary sortas="a-libqmi">libqmi</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libqmi</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>libqmi</application> package contains a GLib-based library
|
---|
| 30 | for talking to WWAN modems and devices which speak the Qualcomm MSM Interface
|
---|
| 31 | (QMI) protocol.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[bbfdef7] | 34 | &lfs121_checked;
|
---|
[ce9b131] | 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&libqmi-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&libqmi-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &libqmi-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &libqmi-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &libqmi-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &libqmi-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect3">libqmi Dependencies</bridgehead>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 73 | <para role="required">
|
---|
[c0bc0a9] | 74 | <xref linkend="glib2"/> (GObject Introspection recommended) and
|
---|
[b7887423] | 75 | <xref linkend="libgudev"/>
|
---|
[ce9b131] | 76 | </para>
|
---|
| 77 |
|
---|
[30712eb] | 78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 79 | <para role="recommended">
|
---|
| 80 | <xref linkend="libmbim"/>
|
---|
| 81 | </para>
|
---|
| 82 |
|
---|
[ce9b131] | 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
[5d2965c] | 85 | <xref linkend="gtk-doc"/>,
|
---|
| 86 | <ulink url="https://ftpmirror.gnu.org/gnu/help2man/">help2man</ulink>, and
|
---|
| 87 | <ulink url="https://gitlab.freedesktop.org/mobile-broadband/libqrtr-glib">libqrtr-glib</ulink>
|
---|
[ce9b131] | 88 | </para>
|
---|
| 89 |
|
---|
| 90 | </sect2>
|
---|
| 91 |
|
---|
| 92 | <sect2 role="installation">
|
---|
| 93 | <title>Installation of libqmi</title>
|
---|
| 94 |
|
---|
| 95 | <para>
|
---|
| 96 | Install <application>libqmi</application> by running the following
|
---|
| 97 | commands:
|
---|
| 98 | </para>
|
---|
| 99 |
|
---|
[5d2965c] | 100 | <screen><userinput>PYTHON=python3 ./configure --prefix=/usr --disable-static &&
|
---|
[ce9b131] | 101 | make</userinput></screen>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | To test the results, issue: <command>make check</command>.
|
---|
| 105 | </para>
|
---|
| 106 |
|
---|
| 107 | <para>
|
---|
| 108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 112 |
|
---|
| 113 | </sect2>
|
---|
| 114 |
|
---|
| 115 | <sect2 role="commands">
|
---|
| 116 |
|
---|
| 117 | <title>Command Explanations</title>
|
---|
| 118 |
|
---|
| 119 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 120 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 121 |
|
---|
| 122 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 123 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 124 |
|
---|
[30712eb] | 125 | <para>
|
---|
| 126 | <option>--disable-mbim-qmux</option>: This switch disables support for
|
---|
| 127 | using a MBIM control device for QMI messages. Use this switch if you
|
---|
| 128 | did not install <application>libmbim</application>.
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
[ce9b131] | 131 | </sect2>
|
---|
| 132 |
|
---|
| 133 | <sect2 role="content">
|
---|
| 134 | <title>Contents</title>
|
---|
| 135 |
|
---|
| 136 | <segmentedlist>
|
---|
| 137 | <segtitle>Installed Programs</segtitle>
|
---|
| 138 | <segtitle>Installed Libraries</segtitle>
|
---|
| 139 | <segtitle>Installed Directories</segtitle>
|
---|
| 140 |
|
---|
| 141 | <seglistitem>
|
---|
| 142 | <seg>
|
---|
[40eb6f7] | 143 | qmicli,
|
---|
| 144 | qmi-firmware-update,
|
---|
| 145 | and qmi-network
|
---|
[ce9b131] | 146 | </seg>
|
---|
| 147 | <seg>
|
---|
| 148 | libqmi-glib.so
|
---|
| 149 | </seg>
|
---|
| 150 | <seg>
|
---|
| 151 | /usr/include/libqmi-glib and
|
---|
| 152 | /usr/share/gtk-doc/html/libqmi-glib
|
---|
| 153 | </seg>
|
---|
| 154 | </seglistitem>
|
---|
| 155 | </segmentedlist>
|
---|
| 156 |
|
---|
| 157 | <variablelist>
|
---|
| 158 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 159 | <?dbfo list-presentation="list"?>
|
---|
| 160 | <?dbhtml list-presentation="table"?>
|
---|
| 161 |
|
---|
| 162 | <varlistentry id="qmicli">
|
---|
| 163 | <term><command>qmicli</command></term>
|
---|
| 164 | <listitem>
|
---|
| 165 | <para>
|
---|
[4c24eb0a] | 166 | is an utility used to control QMI devices
|
---|
[ce9b131] | 167 | </para>
|
---|
| 168 | <indexterm zone="libqmi qmicli">
|
---|
| 169 | <primary sortas="b-qmicli">qmicli</primary>
|
---|
[28fb6fd] | 170 | </indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
| 173 |
|
---|
| 174 | <varlistentry id="qmi-firmware-update">
|
---|
| 175 | <term><command>qmi-firmware-update</command></term>
|
---|
| 176 | <listitem>
|
---|
| 177 | <para>
|
---|
[4c24eb0a] | 178 | is an utility used to perform firmware updates on QMI devices
|
---|
[28fb6fd] | 179 | </para>
|
---|
| 180 | <indexterm zone="libqmi qmi-firmware-update">
|
---|
| 181 | <primary sortas="b-qmi-firmware-update">qmi-firmware-update</primary>
|
---|
[ce9b131] | 182 | </indexterm>
|
---|
| 183 | </listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="qmi-network">
|
---|
| 187 | <term><command>qmi-network</command></term>
|
---|
| 188 | <listitem>
|
---|
| 189 | <para>
|
---|
| 190 | is an utility used for simple network management
|
---|
[4c24eb0a] | 191 | of QMI devices
|
---|
[ce9b131] | 192 | </para>
|
---|
| 193 | <indexterm zone="libqmi qmi-network">
|
---|
| 194 | <primary sortas="b-qmi-network">qmi-network</primary>
|
---|
| 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
| 199 | <varlistentry id="libqmi-glib">
|
---|
| 200 | <term><filename class="libraryfile">libqmi-glib.so</filename></term>
|
---|
| 201 | <listitem>
|
---|
| 202 | <para>
|
---|
| 203 | contains API functions for talking to WWAN modems and devices
|
---|
[4c24eb0a] | 204 | which speak the Qualcomm MSM Interface (QMI) protocol
|
---|
[ce9b131] | 205 | </para>
|
---|
| 206 | <indexterm zone="libqmi libqmi-glib">
|
---|
| 207 | <primary sortas="c-libqmi-glib">libqmi-glib.so</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
| 212 | </variablelist>
|
---|
| 213 |
|
---|
| 214 | </sect2>
|
---|
| 215 |
|
---|
| 216 | </sect1>
|
---|