Google Summer of Code 2018 » History » Version 66

Denis 'GNUtoo' Carikli, 02/09/2018 04:10 PM
Group QMI ril with other RIL tasks

1 1 Jeremy Rand
h1. Google Summer of Code 2018
3 33 Paul Kocialkowski
5 1 Jeremy Rand
Replicant intends to apply to GSoC 2018 as part of the FSF umbrella.  This page lists suggested projects for GSoC students.  *This list is a draft!*
7 21 Jeremy Rand
*Note: Working on most of these projects requires a sufficiently powerful computer with enough disk space to build Replicant.*
9 59 Denis 'GNUtoo' Carikli
h2. U-Boot and Linux mainline related tasks and ports
10 1 Jeremy Rand
11 61 Denis 'GNUtoo' Carikli
h3. Select and/or port a tablet with an Allwinner SOC to mainline Linux and U-boot, and Replicant
12 60 Denis 'GNUtoo' Carikli
13 61 Denis 'GNUtoo' Carikli
Tablets with Allwinner SOCs are an interesting targets because they do not use signed bootloaders and the SOCs and various devices using them have good Linux and u-boot mainline support. If not much work is required for that, once the code is merged, the candidate is also required to work on the generic abstraction layer project which is also documented in this page.
14 60 Denis 'GNUtoo' Carikli
The chosen tablet should:
* A SOC that has good mainline support, see "the Linux mainlining effort page on linux-sunxi": for more details.
17 62 Denis 'GNUtoo' Carikli
* A Free software bootloader, or the ability to easily add support for the tablet to a free software bootloader.
18 60 Denis 'GNUtoo' Carikli
* Have the ability to power and use an USB WiFi card or chip that is compatible with the ath9k_htc driver.
19 62 Denis 'GNUtoo' Carikli
It would be better if the chosen tablet doesn't use an AllWinner SOC with a PowerVR GPU, as MALI GPU have more probability to be usable with free software in the future.
21 60 Denis 'GNUtoo' Carikli
*Difficulty*: Medium
*Requirements/Prerequisites*: C programming language, driver development
*Expected Outcomes/Deliverables*: Replicant support for a tablet using an Allwinner SOC, with free software bootloader and mainline based Linux kernel.
*Possible Mentors*: Paul (confirmed), GNUtoo (confirmed, backup)
30 57 Denis 'GNUtoo' Carikli
h3. Advance the Optimus Black U-Boot and Linux mainline ports
32 25 Paul Kocialkowski
The Optimus Black from LG is an interesting device from the perspective of freedom and privacy/security. It has the ability to run a free bootloader and uses an OMAP3 SoC that is well-documented and supported in upstream U-Boot (bootloader) and Linux (kernel). Its modem is well-isolated from the rest of the device, ensuring a sane base for privacy/security. Currently, the device-specific parts of the mainline U-Boot and Linux ports are still at an early stage, where they are functional with a very limited set of supported hardware.
33 1 Jeremy Rand
34 26 Paul Kocialkowski
Advancing the Optimus Black U-Boot and Linux mainline ports would allow using the device with free, up-to-date and maintainable software and would pave the way for support in GNU/Linux systems as well as Replicant. A list of priorities in hardware support will be defined, with the objective of tackling as many as possible.
35 1 Jeremy Rand
36 25 Paul Kocialkowski
*Difficulty*: Medium
37 1 Jeremy Rand
38 25 Paul Kocialkowski
*Requirements/Prerequisites*: C programming language, driver development
39 1 Jeremy Rand
40 25 Paul Kocialkowski
*Expected Outcomes/Deliverables*: Improved hardware support for the Optimus Black in U-Boot and Linux
41 31 Paul Kocialkowski
42 1 Jeremy Rand
*Possible Mentors*: Paul (confirmed), GNUtoo (confirmed, backup)
44 57 Denis 'GNUtoo' Carikli
h3. Port the Galaxy S3 and Galaxy Note 2 to Mainline Linux
45 1 Jeremy Rand
46 57 Denis 'GNUtoo' Carikli
The Galaxy S3 and Galaxy Note 2 currently use a vendor fork of Linux, which poses a maintainability and security issue.  Forkbomb has done some initial work on porting these devices to use mainline Linux.  You can help by continuing this work. This would also enable theses devices to use generic hardware abstraction layers (HAL) when abstractions layers are ready, and to do some research on whether the "TrustZone operating system": can be removed of such devices.
*Difficulty*: Medium to Hard
*Requirements/Prerequisites*: Knowledge of C
*Expected Outcomes/Deliverables*: Audio working, modem working, and Replicant or LineageOS booting with mainline Linux.
*Possible Mentors*: Forkbomb (confirmed), GNUtoo (confirmed)
h3. Advance the Kindle Fire (first generation) U-Boot and Linux mainline ports
58 25 Paul Kocialkowski
The Kindle Fire (first generation) from Amazon is an interesting device from the perspective of freedom and privacy/security. It has the ability to run a free bootloader and uses an OMAP4 SoC that is well-documented and supported in upstream U-Boot (bootloader) and Linux (kernel). It does not embed a modem, ensuring a sane base for privacy/security. Currently, the device-specific parts of the mainline U-Boot and Linux ports are still at an early stage, where they are functional with a very limited set of supported hardware.
59 2 Jeremy Rand
60 26 Paul Kocialkowski
Advancing the Kindle Fire (first generation) U-Boot and Linux mainline ports would allow using the device with free, up-to-date and maintainable software and would pave the way for support in GNU/Linux systems as well as Replicant. A list of priorities in hardware support will be defined, with the objective of tackling as many as possible.
61 2 Jeremy Rand
62 25 Paul Kocialkowski
*Difficulty*: Medium
63 2 Jeremy Rand
64 25 Paul Kocialkowski
*Requirements/Prerequisites*: C programming language, driver development
*Expected Outcomes/Deliverables*: Improved hardware support for the Kindle Fire (first generation) in U-Boot and Linux
67 2 Jeremy Rand
68 31 Paul Kocialkowski
*Possible Mentors*: Paul (confirmed), GNUtoo (confirmed, backup)
69 3 Jeremy Rand
70 58 Denis 'GNUtoo' Carikli
h3. Implementing generic Hardware Abstraction Layers (HALs)
71 30 Paul Kocialkowski
Currently, Replicant uses a dedicated Hardware Abstraction Layer per device, because device manufacturers implemented non-standard kernel interfaces. However, Android works with mainline kernels and supports plug-n-play hardware nowadays, so it makes sense to have generic Hardware Abstraction Layers for the standard interfaces of the Linux kernel (ALSA, V4L2, etc). In particular, this would allow supporting external Wi-Fi dongles such as the ones supported by the ath9k_htc driver and free firmwares without the need for a specific application or configuration.
*Difficulty*: Medium
*Requirements/Prerequisites*: C programming language, kernel interfaces knowledge
*Expected Outcomes/Deliverables*: A collection of generic HALs for Android and Replicant
80 46 Denis 'GNUtoo' Carikli
*Possible Mentors*: Forkbomb (confirmed), Paul (confirmed, backup), GNUtoo (confirmed)
81 30 Paul Kocialkowski
82 5 Jeremy Rand
h2. Access Point mode for RepWifi
84 11 Jeremy Rand
RepWifi is Replicant's app for using an external USB WiFi adapter.  RepWifi is useful for Replicant because there exist USB WiFi adapters with free firmware, while the built-in WiFi chipsets in mobile phones do not have free firmware.  Right now, RepWifi doesn't support acting as an access point (e.g. for WiFi tethering purposes); you can help by adding this functionality to RepWifi.
85 30 Paul Kocialkowski
86 45 Jeremy Rand
Note that, if we receive high-quality student proposals for both this project and *Implementing generic Hardware Abstraction Layers (HALs)*, we will probably prioritize *Implementing generic Hardware Abstraction Layers (HALs)* over this project.
87 5 Jeremy Rand
*Difficulty*: Easy to Medium
90 23 Fil Bergamo
*Requirements/Prerequisites*: Knowledge of Java and basic shell scripting. Basic knowledge about wpa_supplicant and general network management in POSIX environments.
91 24 Fil Bergamo
Required knowledge builds up very fast by trial and error, no need to be experts in networking, it's mostly about researching and learning.
92 5 Jeremy Rand
93 23 Fil Bergamo
*Expected Outcomes/Deliverables*: Make wpa_supplicant run in "Access Point mode", allowing another device to connect to the phone via WiFi, and use its mobile data connection to access the internet. Integrate the needed GUI functions into RepWifi.
94 5 Jeremy Rand
95 23 Fil Bergamo
*Possible Mentors*: Fil (confirmed)
96 5 Jeremy Rand
97 34 Paul Kocialkowski
h2. Port Replicant to a newer LineageOS version and support in-system updates
98 4 Jeremy Rand
99 47 Denis 'GNUtoo' Carikli
Replicant is currently based on LineageOS 13.  It would be desirable to upgrade Replicant to a newer release of LineageOS. While at it, it would be useful for a Replicant device to be able to update itself to a new version of Replicant without requiring being connected to a PC. LineageOS already supports this; we suspect that it should be possible to adapt this LineageOS functionality to Replicant. Whenever possible, it would be useful to complete and submit some of the code written for Replicant to LineageOS.
100 4 Jeremy Rand
101 19 Jeremy Rand
*Difficulty*: Medium
102 4 Jeremy Rand
103 19 Jeremy Rand
*Requirements/Prerequisites*: Knowledge of C, C++, and Java.
104 4 Jeremy Rand
105 34 Paul Kocialkowski
*Expected Outcomes/Deliverables*: Remove all proprietary components of LineageOS, port all the changes needed to successfully boot without any blobs, rebrand LineageOS as Replicant and support in-system updates
106 6 Jeremy Rand
*Possible Mentors*: Forkbomb (confirmed), Wolfgang?
108 4 Jeremy Rand
109 66 Denis 'GNUtoo' Carikli
h2. RIL related tasks
110 63 Denis 'GNUtoo' Carikli
h3. Implement the missing features of Samsung-RIL
112 7 Jeremy Rand
113 56 Denis 'GNUtoo' Carikli
Samsung-RIL is the RIL (Radio Interface Layer) that many Replicant devices use to communicate with the modem.  It is a free, reverse-engineered replacement for the proprietary RIL that the Samsung phones ship with by default (which has been found to have backdoors). Right now, Samsung-RIL mostly implements only the protocol features that are absolutely necessary for the phone to be operable.  As a result, many more rarely used protocol features are unimplemented, which decreases functionality compared to the proprietary RIL.  You can help by implementing the missing features of Samsung-RIL. It would also be nice to fix most the reported bugs involving samsung-ril and libsamsung-ipc that are impacting users very seriously. This includes the bugs about the SIM card not being detected, and the issue #1773. It would also be nice to be able to recover from EFS (the modem filesystem) corruptions (Bug #1869).
114 7 Jeremy Rand
115 19 Jeremy Rand
*Difficulty*: Medium to Hard
116 7 Jeremy Rand
117 19 Jeremy Rand
*Requirements/Prerequisites*: Knowledge of C.
118 7 Jeremy Rand
119 20 Jeremy Rand
*Expected Outcomes/Deliverables*: Implement the missing features listed at [[Samsung-RIL]].
120 7 Jeremy Rand
121 18 Jeremy Rand
*Possible Mentors*: Forkbomb (confirmed), Wolfgang?
122 7 Jeremy Rand
123 64 Denis 'GNUtoo' Carikli
h3. Debug metallic sound in many 3G calls
124 1 Jeremy Rand
*We're folding this one into Samsung-RIL as an optional component or stretch goal.*
Replicant has been observed to sometimes exhibit a metallic sound quality when doing voice calls over 3G (2G works fine).  This is problematic, since most users prefer to stay in 3G mode (and some carriers are dropping support for 2G).  You can help by debugging the issue.
*Difficulty*: TODO
*Requirements/Prerequisites*: TODO
*Expected Outcomes/Deliverables*: TODO
*Possible Mentors*: GNUtoo (confirmed)
136 41 Jeremy Rand
137 66 Denis 'GNUtoo' Carikli
h3. Implement a fully-featured QMI-RIL
138 41 Jeremy Rand
The LTE variants of the Samsung Galaxy S3 and Samsung Galaxy Note 2 use a different modem from the non-LTE variants that Replicant currently supports.  You can help Replicant support those modems by implementing a QMI-RIL, which performs a similar role on the LTE variants as what Samsung-RIL performs on the currently-supported non-LTE variants.  Wolfgang has done some preliminary work on this, so you'll probably be picking up where he left off.
141 42 Jeremy Rand
*Difficulty*: Hard
142 41 Jeremy Rand
143 43 Jeremy Rand
*Requirements/Prerequisites*: Knowledge of C.
144 41 Jeremy Rand
145 44 Jeremy Rand
*Expected Outcomes/Deliverables*: A QMI-RIL that supports voice calls, SMS, and data, with as complete a protocol implementation as possible.
146 41 Jeremy Rand
*Possible Mentors*: Forkbomb (confirmed), Wolfgang?
148 8 Jeremy Rand
149 9 Jeremy Rand
h2. Optimize power consumption in external WiFi adapter firmware
151 16 Jeremy Rand
The USB WiFi adapters used with Replicant are originally intended for laptops, not phones.  As a result, they tend to consume a lot of power.  This poses two issues: they can adversely impact battery life, and they can randomly stop working completely (e.g. needing to unplug and replug the adapter periodically to keep it operational).  You can help by optimizing power consumption in the WiFi adapter firmware.
152 10 Jeremy Rand
*Difficulty*: TODO
154 9 Jeremy Rand
*Requirements/Prerequisites*: TODO
157 17 Jeremy Rand
*Expected Outcomes/Deliverables*: TODO
158 35 Paul Kocialkowski
159 1 Jeremy Rand
*Possible Mentors*: GNUtoo (confirmed)
160 36 Jeremy Rand
161 18 Jeremy Rand
h2. Tackle security issues in Replicant
Replicant is plagued by various security issues, that are mostly due to using a downstream codebase. One of the most crucial issues is that Replicant uses an old version of the Android WebView (from circa 2015), which is also a functionality drawback.
164 48 Denis 'GNUtoo' Carikli
An initial evaluation of the security issues in Replicant should be conducted, followed by the integration or update of the concerned components of the system.
165 18 Jeremy Rand
166 22 Jeremy Rand
*Difficulty*: Medium-Hard
167 18 Jeremy Rand
168 22 Jeremy Rand
*Requirements/Prerequisites*: Android build system, knowledge of system security, advanced git
169 18 Jeremy Rand
170 22 Jeremy Rand
*Expected Outcomes/Deliverables*: Integration or update of components of Replicant to tackle security issues
171 18 Jeremy Rand
172 31 Paul Kocialkowski
*Possible Mentors*: Wolfgang?
173 17 Jeremy Rand
174 49 Denis 'GNUtoo' Carikli
h2. Fix the Free software distribution guidelines issues and improve the build system.
175 28 Denis 'GNUtoo' Carikli
176 52 Denis 'GNUtoo' Carikli
Replicant has some issues with FSDG compliance: F-droid repository is not FSDG compliant anymore, and Replicant can't be built from an FSDG distribution. Replicant should also not depends on pre-built dependencies anymore and build without issues. It would also be nice to document which FSDG compliant F-droid applications crash because Replicant's incomplete EGL implementation (#705) and tag such applications as incompatible (so they are greyed out) until the EGL implemetation is fixed.
177 28 Denis 'GNUtoo' Carikli
*Difficulty*: Easy
*Requirements/Prerequisites*: Knowledge of shell scripts and the ability to learn the Android build system
182 49 Denis 'GNUtoo' Carikli
*Expected Outcomes/Deliverables*: The ability to compile Replicant from an FSDG distribution, F-droid only showing FSDG compliant software.
183 28 Denis 'GNUtoo' Carikli
184 31 Paul Kocialkowski
*Possible Mentors*: GNUtoo (confirmed)
185 28 Denis 'GNUtoo' Carikli
186 3 Jeremy Rand
h2. Projects mentored by other organizations
h3. llvmpipe ARM optimizations
190 51 Denis 'GNUtoo' Carikli
Project description: Replicant's EGL is implementation is incomplete (This has many consequences: #705). The goal is to make llvmpipe usable under Replicant and replace the incomplete EGL implemetation with that. The advantage of this solution over other solutions is that it is supposed to work on all Replicant supported devices and is also used within GNU/Linux.
See also the "wiki page about llvmpipe": for more details about the issue
192 3 Jeremy Rand
*Difficulty*: TODO
195 1 Jeremy Rand
*Requirements/Prerequisites*: TODO
196 3 Jeremy Rand
197 53 Denis 'GNUtoo' Carikli
*Expected Outcomes/Deliverables*: Working EGL implementation, fast enough graphics, F-droid applications not crashing anymore because of EGL.
198 3 Jeremy Rand
Mesa would probably be a good organization for mentoring this project.  If interested in working on this project, please propose it to Mesa.  (We're happy to help.)