Project

General

Profile

TasksFunding » History » Version 11

Denis 'GNUtoo' Carikli, 01/07/2019 10:19 PM

1 2 Denis 'GNUtoo' Carikli
h1. Tasks
2 1 Denis 'GNUtoo' Carikli
3
{{>toc}}
4
5 2 Denis 'GNUtoo' Carikli
This page describes how to help Replicant if you have some time at hand.
6 1 Denis 'GNUtoo' Carikli
7 2 Denis 'GNUtoo' Carikli
Filtering the issue tracker for open issues, which have either one of the priorities "immediate":/projects/replicant/issues?set_filter=1&f[]=status_id&op[status_id]=o&f[]=priority_id&op[priority_id]=%3D&v[priority_id][]=39&f[]=&c[]=tracker&c[]=status&c[]=priority&c[]=subject&c[]=assigned_to&c[]=updated_on&c[]=category&c[]=cf_21&group_by=, "urgent":/projects/replicant/issues?set_filter=1&f[]=status_id&op[status_id]=o&f[]=priority_id&op[priority_id]=%3D&v[priority_id][]=33&f[]=&c[]=tracker&c[]=status&c[]=priority&c[]=subject&c[]=assigned_to&c[]=updated_on&c[]=category&c[]=cf_21&group_by= or "high":/projects/replicant/issues?set_filter=1&f[]=status_id&op[status_id]=o&f[]=priority_id&op[priority_id]=%3D&v[priority_id][]=27&f[]=&c[]=tracker&c[]=status&c[]=priority&c[]=subject&c[]=assigned_to&c[]=updated_on&c[]=category&c[]=cf_21&group_by=, lists the important current tasks.
8
9
Additionally, below is an overview over tasks where help is greatly appreciated.
10
11
*Note: Working on most of these tasks and projects requires a sufficiently powerful computer with enough disk space to build Replicant.*
12 1 Denis 'GNUtoo' Carikli
13 3 Denis 'GNUtoo' Carikli
h2. Various tasks that don't require specific hardware
14
15
h3. Access Point mode for RepWifi
16
17
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.
18
19
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.
20
21
*Difficulty*: Easy to Medium
22
23
*Requirements/Prerequisites*: Knowledge of Java and basic shell scripting. Basic knowledge about wpa_supplicant and general network management in POSIX environments.
24
Required knowledge builds up very fast by trial and error, no need to be experts in networking, it's mostly about researching and learning.
25 1 Denis 'GNUtoo' Carikli
26 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: 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.
27 3 Denis 'GNUtoo' Carikli
28 6 Denis 'GNUtoo' Carikli
h3. Port Replicant to a newer LineageOS version and support in-system updates
29 3 Denis 'GNUtoo' Carikli
30
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.
31
32 1 Denis 'GNUtoo' Carikli
*Difficulty*: Medium
33 3 Denis 'GNUtoo' Carikli
34
*Requirements/Prerequisites*: Knowledge of C, C++, and Java.
35
36 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: 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
37 3 Denis 'GNUtoo' Carikli
38 7 Denis 'GNUtoo' Carikli
h3. Improve support for the free software compatible external WiFi adapter
39 3 Denis 'GNUtoo' Carikli
40
All devices currently supported by Replicant have WiFi chips that requires a non-free firmware to work. So to have WiFi working with free software, users need to use external WiFi adapters. They typically use tiny ath9k_htc compatible USB WiFi adapter along with a tiny USB OTG Host adapter.
41
42
Such external USB WiFi adapters used with Replicant are originally intended for laptops, not phones. As a result, they tend to consume a lot of power. According to lsusb some ath9k_htc compatible devices can consume up to 500mA.
43
44
This poses several issues:
45
* Some smartphones and tablets might not be compatible, at the hardware level, with such big power consumption.
46
* They can adversely impact battery life
47
48
Such USB WiFi adapters can also randomly stop working completely on some devices (e.g. needing to unplug and replug the adapter periodically to keep it operational).
49 1 Denis 'GNUtoo' Carikli
50 3 Denis 'GNUtoo' Carikli
You will need to investigate reliability issues such as the one mentioned above and look how power consumption can be improved in the adapter firmware and/or kernel driver.
51
52
You will also need to investigate how much miliampers USB devices can use, at the hardware level, on the smartphones and tablets Replicant supports.
53 1 Denis 'GNUtoo' Carikli
54 3 Denis 'GNUtoo' Carikli
*Difficulty*: Medium/Hard
55
56
*Requirements/Prerequisites*: Knowledge of C
57
58 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Reliable WiFi with external WiFi adapter
59 3 Denis 'GNUtoo' Carikli
60 4 Denis 'GNUtoo' Carikli
h3. Tackle security issues in Replicant
61 3 Denis 'GNUtoo' Carikli
62
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.
63
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.
64
65 1 Denis 'GNUtoo' Carikli
It would also be nice to do the same for privacy issues. Since Replicant indirectly depends on the "Android Open Source Project" and directly depends on LineageOS, not all privacy issues might have been found fixed by Replicant. Once security issues have been fixed, it would be nice to try to identify as many privacy issues as possible, and in a second time to fix them.
66 3 Denis 'GNUtoo' Carikli
67
*Difficulty*: Medium-Hard
68
69
*Requirements/Prerequisites*: Android build system, knowledge of system security, advanced git
70
71 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Integration or update of components of Replicant to tackle security issues
72 3 Denis 'GNUtoo' Carikli
73 4 Denis 'GNUtoo' Carikli
h3. Fix the Free software distribution guidelines issues and improve the build system.
74 3 Denis 'GNUtoo' Carikli
75
Replicant has some issues with "FSDG (Free System Distribution Guidelines)":https://www.gnu.org/distros/free-system-distribution-guidelines.html compliance: "F-droid":https://f-droid.org/ repository is not FSDG compliant anymore (Bug #1629), and Replicant can't be built from an FSDG distribution (Bug #1861). This ought to be fixed. Replicant should also be fixed to build without issue.
76 1 Denis 'GNUtoo' Carikli
77 3 Denis 'GNUtoo' Carikli
It would also be nice to have the build system not depend on pre-built dependencies anymore, and 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. Ideally Replicant builds should also be made "reproducible":https://en.wikipedia.org/wiki/Deterministic_compilation if they are not already.
78
79
*Difficulty*: Easy
80
81
*Requirements/Prerequisites*: Knowledge of shell scripts and the ability to learn the Android build system
82
83 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: The ability to compile Replicant from "an FSDG distribution":https://www.gnu.org/distros/free-distros.html, F-droid only showing FSDG compliant software.
84 3 Denis 'GNUtoo' Carikli
85
h3. llvmpipe ARM optimizations
86 1 Denis 'GNUtoo' Carikli
87 3 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.
88
See also the "wiki page about llvmpipe":https://redmine.replicant.us/projects/replicant/wiki/GraphicsResearch#llvmpipe for more details about the issue. Other solutions fixing the problem might be acceptable too, if it makes more sense.
89 1 Denis 'GNUtoo' Carikli
90
*Difficulty*: See with the MESA project
91
92
*Requirements/Prerequisites*: See with the MESA project
93
94 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Working EGL implementation, fast enough graphics, F-droid applications not crashing anymore because of EGL.
95 1 Denis 'GNUtoo' Carikli
96
h2. Device-specific tasks
97 8 Denis 'GNUtoo' Carikli
98 9 Denis 'GNUtoo' Carikli
h3. Project focus
99 8 Denis 'GNUtoo' Carikli
100
While supporting many common (Samsung) phones and tablets is relatively easy and fast to do, we think that it's at lot more important to support devices that are better for freedom. Many Samsung devices we do support have an isolated modem, however we can't free their bootloader because it is signed.
101
102
Devices like the GTA04 or the LG Optimus Black don't have this bootloader issue, while still having an isolated modem.
103
We therefore strongly advise to pick tasks that would improve the support for these more freedom-friendly devices in Replicant.
104
105
We however still accept contributions for devices with isolated modems and non-free bootloaders.
106 3 Denis 'GNUtoo' Carikli
107
h3. U-Boot and Linux mainline related tasks and ports
108
109
h4. Select and/or port a tablet with an Allwinner SOC to mainline Linux and U-boot, and Replicant
110
111 1 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.
112
113
The chosen tablet should have:
114
* A SOC that has good mainline support, see "the Linux mainlining effort page on linux-sunxi":https://linux-sunxi.org/Linux_mainlining_effort for more details.
115
* A Free software bootloader, or the ability to easily add support for the tablet to a free software bootloader.
116
* The ability to power and use an USB WiFi card or chip that is compatible with the ath9k_htc driver.
117
118
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.
119
120
*Difficulty*: Medium
121
122
*Requirements/Prerequisites*: C programming language, driver development
123
124 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Replicant support for a tablet using an Allwinner SOC, with free software bootloader and mainline based Linux kernel.
125 1 Denis 'GNUtoo' Carikli
126
h4. Advance the Optimus Black U-Boot and Linux mainline ports
127 3 Denis 'GNUtoo' Carikli
128 1 Denis 'GNUtoo' Carikli
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.
129
130
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.
131
132
*Difficulty*: Medium
133
134
*Requirements/Prerequisites*: C programming language, driver development
135
136 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Improved hardware support for the Optimus Black in U-Boot and Linux
137 1 Denis 'GNUtoo' Carikli
138 11 Denis 'GNUtoo' Carikli
h4. Port the Galaxy S3 and Galaxy Note 2 to Mainline Linux
139 1 Denis 'GNUtoo' Carikli
140
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 these devices to use generic hardware abstraction layers (HAL) when abstractions layers are ready, and to do some research on whether the "TrustZone operating system":https://blog.fossencdi.org/u-boot-galaxys3.html can be removed from such devices.
141
142
*Difficulty*: Medium to Hard
143
144
*Requirements/Prerequisites*: Knowledge of C
145
146 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Audio working, modem working, and Replicant or LineageOS booting with mainline Linux.
147 1 Denis 'GNUtoo' Carikli
148
h4. Advance the Kindle Fire (first generation) U-Boot and Linux mainline ports
149
150
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.
151
152
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.
153
154
*Difficulty*: Medium
155
156
*Requirements/Prerequisites*: C programming language, driver development
157
158 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Improved hardware support for the Kindle Fire (first generation) in U-Boot and Linux
159 1 Denis 'GNUtoo' Carikli
160 3 Denis 'GNUtoo' Carikli
h4. Implementing generic Hardware Abstraction Layers (HALs)
161 1 Denis 'GNUtoo' Carikli
162
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.
163
164
*Difficulty*: Medium
165
166
*Requirements/Prerequisites*: C programming language, kernel interfaces knowledge
167
168 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: A collection of generic HALs for Android and Replicant
169 1 Denis 'GNUtoo' Carikli
170
h3. RIL related tasks
171 3 Denis 'GNUtoo' Carikli
172 1 Denis 'GNUtoo' Carikli
h4. Implement the missing features of Samsung-RIL
173
174
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).
175
176
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.
177
178
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 about having metallic sound quality when doing voice calls over 3G (bug #1773). It would also be nice to be able to recover from EFS (the modem filesystem) corruptions (Bug #1869).
179
180
*Difficulty*: Medium to Hard
181
182
*Requirements/Prerequisites*: Knowledge of C.
183
184 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: Implement the missing features listed at [[Samsung-RIL]].
185 1 Denis 'GNUtoo' Carikli
186
h4. Implement a fully-featured QMI-RIL
187
188
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.
189
190
*Difficulty*: Hard
191
192
*Requirements/Prerequisites*: Knowledge of C.
193
194 10 Denis 'GNUtoo' Carikli
*Expected outcomes*: A QMI-RIL that supports voice calls, SMS, and data, with as complete a protocol implementation as possible.