Project

General

Profile

QMI-RIL » History » Version 17

Wolfgang Wiedmeyer, 07/16/2017 08:35 PM
update modem boot section and introduce a tool to boot the modem

1 1 Wolfgang Wiedmeyer
h1. QMI-RIL
2
3
This page covers development efforts to create a "Radio Interface Layer":https://en.wikipedia.org/wiki/Radio_Interface_Layer (RIL) for modems that use the Qualcomm MSM Interface (QMI) protocol. The work is currently carried out for the Galaxy S 3 4G (I9305) which has a Qualcomm MDM9615 modem. The Galaxy Note 2 4G (t0lte) uses the same modem and this device could be supported as well in Replicant when the QMI-RIL is ready. We will hopefully identify further candidates that have an isolated modem using the QMI protocol and for which Replicant support could be added. Among the non-Android devices, the iPhone 5  is one that "uses the MDM9615 modem":https://www.theiphonewiki.com/wiki/MDM9615 as well.
4 2 Wolfgang Wiedmeyer
5 6 Wolfgang Wiedmeyer
"relevant thread on libqmi mailing list":https://lists.freedesktop.org/archives/libqmi-devel/2017-February/002089.html
6
7 2 Wolfgang Wiedmeyer
h2. Modem boot
8
9 17 Wolfgang Wiedmeyer
h3. Background
10 3 Wolfgang Wiedmeyer
11 17 Wolfgang Wiedmeyer
When the MDM9615 modem is activated, it first boots into a Download mode. There, firmware, bootloaders and EFS files are uploaded to the modem via a serial interface. The used protocol is called SAHARA and it is a proprietary protocol developed by Qualcomm. The protocol covers various functionalities. We likely only need to implement a very small subset that is responsible for transferring firmware and other files to the modem and synchronising changes to EFS files with the filesystem. Being able to retrieve RAM dumps from the modem would also be helpful for debugging. In case of a fatal error, the Linux kernel already requests RAM dumps from the modem, so only the file transfer part needs to be implemented.
12 2 Wolfgang Wiedmeyer
13 17 Wolfgang Wiedmeyer
Qualcomm provides the proprietary tool kickstart for uploading the files to the modem. It is run by the daemon qcks. After the modem is booted, qcks spawns efsks which is responsible for EFS sync.
14
15 1 Wolfgang Wiedmeyer
Logcat and dmesg output of the upload: attachment:ks_logcat, attachment:ks_dmesg
16
17
"libopenpst":https://github.com/openpst/libopenpst can be used as a reference to implement the file upload and as documentation about the protocol. The "kernel":https://git.replicant.us/replicant/kernel_samsung_smdk4412 itself can be checked for the different boot modes.
18 17 Wolfgang Wiedmeyer
19
h3. Implementation
20
21
An initial version of modem boot part is completed and a tool to boot the modem is available here: https://code.fossencdi.org/i9305_modem.git
22
It uploads the needed files in the Download mode and reboots the modem.
23
24 4 Wolfgang Wiedmeyer
25
h2. QMI protocol
26
27 16 Wolfgang Wiedmeyer
"libqmi":https://www.freedesktop.org/wiki/Software/libqmi/ is a library that implements the QMI protocol and it will be used for implementing the RIL. libqmi needs the cdc-wdm and qmi_wwan kernel drivers for communicating with the modem. These are backported to the smdk4412 kernel on the "qmi branch":https://code.fossencdi.org/kernel_samsung_smdk4412.git/log/?h=qmi. The branch is not yet merged into the replicant-6.0 branch because one commit sets SELinux to permissive. This is more convenient for development. The qmi_wwan driver replaces the RMNET usb driver that the blobs use for a network interface to the modem.
28 7 Wolfgang Wiedmeyer
29 15 Wolfgang Wiedmeyer
libqmi provides the command-line tool @qmicli@ to communicate with the modem. It was already successfully tested on the S 3 4G.
30
31 7 Wolfgang Wiedmeyer
h2. Cross-compiling libqmi for Android on ARM
32
33 12 Wolfgang Wiedmeyer
These instructions can be used to build libqmi and include it in an image for the Galaxy S 3 4G. See the [[GalaxyS3I9305Build|build instructions for the Galaxy S 3 4G]] for building the image. Android.mk files need to be written to integrate libqmi and its dependencies into a regular device build. Some of the source code is auto-generated and some dependencies like glib have a lot of source files, so writing the Android Makefiles will be some work.
34 7 Wolfgang Wiedmeyer
35 13 Wolfgang Wiedmeyer
Based on "these instructions":https://zwyuan.github.io/2016/07/17/cross-compile-glib-for-android/
36
37 8 Wolfgang Wiedmeyer
h3. Dependencies
38
39
<pre>
40 11 Wolfgang Wiedmeyer
apt-get install groff libltdl-dev pkg-config gtk-doc-tools
41 8 Wolfgang Wiedmeyer
</pre>
42
43 7 Wolfgang Wiedmeyer
h3. Getting the source code
44
45 1 Wolfgang Wiedmeyer
<pre>
46 13 Wolfgang Wiedmeyer
git clone https://code.fossencdi.org/external_libqmi.git external/libqmi
47 1 Wolfgang Wiedmeyer
git clone https://git.savannah.gnu.org/git/libiconv.git external/libiconv -b v1.15
48 7 Wolfgang Wiedmeyer
git clone https://github.com/libffi/libffi external/libffi -b v3.2.1
49 13 Wolfgang Wiedmeyer
git clone https://code.fossencdi.org/external_gettext.git external/gettext
50 1 Wolfgang Wiedmeyer
git clone https://github.com/GNOME/glib external/glib -b 2.52.3
51 13 Wolfgang Wiedmeyer
</pre>
52
53
h3. Configure and build
54
55
The attached script attachment:qmi_build_envsetup.sh makes it more convenient to configure the environment. You need to set the Replicant source tree root folder as the @REPLICANT_BASE@ variable at the top of the script. Then you can source it:
56
<pre>
57
. path/to/qmi_build_envsetup.sh
58
</pre> 
59
60 14 Wolfgang Wiedmeyer
It's recommended to not run this and the following commands in the same shell you use for building a Replicant image as the environment variables break the Replicant build. Run the commands after you built an image for the I9305.
61 13 Wolfgang Wiedmeyer
62
h4. libiconv
63
64
<pre>
65
./autogen.sh
66 1 Wolfgang Wiedmeyer
./configure --build=${BUILD_SYSTEM} --host=arm-eabi --prefix=${PREFIX} --disable-rpath
67 14 Wolfgang Wiedmeyer
make install -j8
68
</pre>
69
70
If @autoconf-2.69@ and @autoheader-2.69@ are not found, remove the @-2.69@ suffix from the @AUTOCONF@ and @AUTOHEADER@ variables in @Makefile.devel@, @libcharset/Makefile.devel@ and @preload/Makefile.devel@.
71
72
h4. libffi
73
74
<pre>
75
./autogen.sh
76
sed -e '/^includesdir/ s/$(libdir).*$/$(includedir)/' -i include/Makefile.in
77
sed -e '/^includedir/ s/=.*$/=@includedir@/' -e 's/^Cflags: -I${includedir}/Cflags:/' -i libffi.pc.in
78
./configure --build=${BUILD_SYSTEM} --host=arm-eabi --prefix=${PREFIX} --enable-static
79
make install -j8
80
</pre> 
81
82
h4. gettext
83
84
<pre>
85
./autogen.sh
86
./configure --build=${BUILD_SYSTEM} --host=arm-eabi --prefix=${PREFIX} --disable-rpath --disable-libasprintf --disable-java --disable-native-java --disable-openmp --disable-curses
87
make install -j8
88
</pre>
89
90
h4. glib
91
92
First, the file @android.cache@ with the following content needs to be created:
93
<pre>
94
glib_cv_long_long_format=ll
95
glib_cv_stack_grows=no
96
glib_cv_sane_realloc=yes
97
glib_cv_have_strlcpy=no
98
glib_cv_va_val_copy=yes
99
glib_cv_rtldglobal_broken=no
100
glib_cv_uscore=no
101
glib_cv_monotonic_clock=no
102
ac_cv_func_nonposix_getpwuid_r=no
103
ac_cv_func_posix_getpwuid_r=no
104
ac_cv_func_posix_getgrgid_r=no
105
glib_cv_use_pid_surrogate=yes
106
ac_cv_func_printf_unix98=no
107
ac_cv_func_vsnprintf_c99=yes
108
ac_cv_func_realloc_0_nonnull=yes
109
ac_cv_func_realloc_works=yes
110
</pre>
111
112
Make it read-only:
113
<pre>
114
chmod 444 android.cache
115
</pre>
116
117
Then configure and build:
118
<pre>
119
./autogen.sh --build=${BUILD_SYSTEM} --host=${TOOLCHAIN_PREFIX} --prefix=${PREFIX} --disable-dependency-tracking --cache-file=android.cache --enable-included-printf --enable-static --with-pcre=no --enable-libmount=no
120
make install -j8
121
</pre>
122
123
h4. libqmi
124
125
<pre>
126
./autogen.sh --build=${BUILD_SYSTEM} --host=${TOOLCHAIN_PREFIX} --prefix=${PREFIX} --without-udev
127 13 Wolfgang Wiedmeyer
make install -j8
128 7 Wolfgang Wiedmeyer
</pre>