Project

General

Profile

DevicePortingGuide » History » Version 9

Wolfgang Wiedmeyer, 03/18/2017 12:29 AM
development tips update 1

1 2 Wolfgang Wiedmeyer
h1. Replicant 6.0 Porting Guide
2 1 Wolfgang Wiedmeyer
3
{{>toc}}
4
5 2 Wolfgang Wiedmeyer
This guide is a step-by-step explanation of the process of porting a new device to Replicant 6.0.
6 1 Wolfgang Wiedmeyer
7
h2. Overview
8
9
Porting a new device to Replicant is a long task, so make sure you're ready to go through all the steps mentioned below. While it's not technically hard (unless you have to write free software replacements yourself), the process itself takes time as many steps are involved:
10 2 Wolfgang Wiedmeyer
* Checking that your devices meets [[Replicant60PortingGuide#Prerequisites|the required prerequisites]]
11 1 Wolfgang Wiedmeyer
* Discovering the phone's hardware and the amount of non-free blobs involved
12
* Getting Replicant sources, reading all the relevant material about developing on Replicant
13
* Adding the device-specific repositories and files
14
* Setting up the build environment for the new device
15
* Building a recovery image
16
17 2 Wolfgang Wiedmeyer
*A general good advice when porting a new device to Replicant is to look at how things are done on other devices and look at the commits that were made, especially in the device-specific repositories that are prefixed with "device_".*
18 1 Wolfgang Wiedmeyer
19
h2. Prerequisites
20
21
Before porting your device to Replicant, you must make sure it complies with the following requirements:
22 2 Wolfgang Wiedmeyer
* The phone is already supported by LineageOS (LOS) 13.0 (or, worst-case scenario, by a non-official LineageOS 13.0 or CyanogenMod 13.0 port)
23 1 Wolfgang Wiedmeyer
* The phone has a GSM modem: Replicant doesn't support CDMA phones (but you can add support for it if you're skilled)
24 2 Wolfgang Wiedmeyer
* There is a way of installing another operating system, either through the bootloader or via recovery (this is likely if there is a LOS port)
25 1 Wolfgang Wiedmeyer
* The kernel is not signed: this means that the bootloader doesn't check the kernel's signature to match with the vendor's key to allow it to run
26
27 2 Wolfgang Wiedmeyer
If your device fails to comply with one of the last two requirements, it won't be possible to port Replicant to it. If one of the first two requirements can't be fulfilled, porting the device to Replicant will be very hard.
28
If you don't know whether your device complies or not, you'll probably learn it along the way.
29 1 Wolfgang Wiedmeyer
30
h2. Discovering the phone's hardware and associated blobs
31
32
h3. Finding the device's codenames
33
34 3 Wolfgang Wiedmeyer
First of all, you'll have to find out the device's codename that was given by its manufacturer. "Wikipedia":https://www.wikipedia.org/ usually has that information on the device's article. For instance, the codename for the European version of the Galaxy Nexus given by Samsung is i9250. This codename will help in the process of getting information about the device.
35 1 Wolfgang Wiedmeyer
36 3 Wolfgang Wiedmeyer
Then, a second codename (that can turn out the be the same as the previous one) is given to the device at Android-level. If your device is supported by LineageOS, you can find it out from the "LineageOS Wiki":http://wiki.lineageos.org/devices.html or on the "LineageOS download page":https://download.lineageos.org/. For instance, the "Galaxy Nexus":http://wiki.lineageos.org/maguro_info.html codename is: @maguro@.
37 1 Wolfgang Wiedmeyer
38
h3. Investigating the hardware
39
40 3 Wolfgang Wiedmeyer
It is useful to have a general idea of what kind of hardware is present in the phone. From the Wikipedia and LineageOS pages about the device, it's already possible to know what System on a Chip (SoC) it uses and a couple other details.
41 1 Wolfgang Wiedmeyer
42 3 Wolfgang Wiedmeyer
To learn more details, you can consider looking for a teardown of the device (for instance on "iFixit":https://www.ifixit.com/), that will reveal what chips are used on the device. Looking at the kernel defconfig for the device will also help a lot, you can also try to find the service manual for the device.
43 1 Wolfgang Wiedmeyer
44
You can then compare that to the devices that are already supported in Replicant to get an idea of what will possibly work.
45
46
h3. Finding out if the device checks the kernel's signature
47
48
One very important step is to find out if the device is Tivoized: that means that even though the manufacturer releases the kernel source code for the device, the bootloader checks the kernel signature and will refuse to start it if it's not properly signed by the manufacturer. In other words, if you build the kernel yourself, the device will refuse to run it since it's not signed by the manufacturer. Since the Linux kernel is released under the GPLv2, there are no specific dispositions to counter Tivoization, and so porting the device to Replicant is pointless as it will require a prebuilt and signed kernel from the manufacturer.
49
50 4 Wolfgang Wiedmeyer
This is not an easy information to find out, but the developers involved in the LineageOS port will probably know that information. It's a good idea to just ask them.
51 1 Wolfgang Wiedmeyer
52
h3. Discovering the way of flashing the device
53
54 4 Wolfgang Wiedmeyer
To install the future Replicant image on the device, you have to find out how the device can be flashed with a new operating system. The "LineageOS Wiki":http://wiki.lineageos.org/index.html has install guides for the supported devices and you'll probably find install guides for non-official LOS ports as well. It is very important to understand the flashing procedure as it will have to be documented on the Replicant wiki.
55 1 Wolfgang Wiedmeyer
56
There are basically two ways of flashing a new operating system:
57
# Through the bootloader: a program has to send the images to the phone in bootloader mode. Make sure that program is free if your device supports flashing via bootloader.
58
# With recovery: a recovery image has to be installed instead of the current kernel so that at next reboot, recovery permits the installation of another operating system. Make sure this doesn't involve rooting the phone using non-free software.
59
60
h3. The non-free blobs
61
62 4 Wolfgang Wiedmeyer
The key information to get before starting the port is the list of the non-free components that are required by LineageOS.
63
The easiest way to do this is to spot the device repository in "LineageOS repos":https://github.com/LineageOS/ and look for the @proprietary-files.txt@ or @extract-files.sh@ file on the @cm-13.0@ branch.
64
There is usually a link to the device repository from the device's build page in the "LineageOS Wiki":http://wiki.lineageos.org/index.html. There may not be a @proprietary-files.txt@ file, but there should be a file with a similar name that lists the non-free blobs.
65
Some devices share additional common device repositories with other devices. You can identify these by looking at the @lineage.dependencies@ file. These have their own @proprietary-files.txt@ or @extract-files.sh@ files. You will also have to look at these to get a full picture of all the used non-free components.
66 1 Wolfgang Wiedmeyer
67 4 Wolfgang Wiedmeyer
For instance, the list of non-free components for the "Galaxy Nexus":https://github.com/LineageOS/android_device_samsung_maguro/tree/cm-13.0 is "device-proprietary-files.txt":https://github.com/LineageOS/android_device_samsung_maguro/blob/cm-13.0/device-proprietary-files.txt
68
From that list, spot what is related to what hardware component (audio, camera, sensors, gps, modem, etc): That gives an idea of the amount of work required to add support for the phone.
69 1 Wolfgang Wiedmeyer
70
h2. Getting started with Replicant development
71
72
In order to prepare everything for the Replicant port:
73 5 Wolfgang Wiedmeyer
* Install LineageOS on the phone
74 1 Wolfgang Wiedmeyer
* Install the [[BuildDependenciesInstallation|build dependencies]]
75
* [[ReplicantSourceCode|Replicant source code]]
76 5 Wolfgang Wiedmeyer
* Read the Android Source code guide: https://source.android.com/source/index.html
77
* Read the Android Device porting guide: https://source.android.com/devices/index.html
78
* If there is no LineageOS support for your device: Read how to port CyanogenMod to your own device: https://web.archive.org/web/20161121154456/http://wiki.cyanogenmod.org/w/Doc:_porting_intro
79
  (a similar guide for LineageOS doesn't exist yet)
80 1 Wolfgang Wiedmeyer
* Read the Replicant [[DeveloperGuide|developer guide]]
81
* Learn how to debug: [[GettingLogs|getting logs]], [[GDBDebugging|GDB debugging]].
82
83
h2. Cloning the device files
84
85
Once your Replicant tree is ready, you can start adding the necessary repos for your device.
86
That means cloning the necessary repos in the right place. These repos are:
87 5 Wolfgang Wiedmeyer
* A *device-specific repo*. On LineageOS, it is usually called: @android_device_vendor_device@.
88 1 Wolfgang Wiedmeyer
* Sometimes one or more *common repo(s)*, usually called: @android_device_vendor_devices-common@.
89 5 Wolfgang Wiedmeyer
  Some devices don't need any common repo, but some do.
90
* A *kernel repo*. On LineageOS, it is usually called: @android_kernel_vendor_devices@.
91 1 Wolfgang Wiedmeyer
The kernel repo can be shared across a family of devices (for instance, on kernel repo for Samsung Exynos, one for Samsung OMAP, etc).
92
93 5 Wolfgang Wiedmeyer
You can find the device-specific repo from the device's page on the "LineageOS Wiki":http://wiki.lineageos.org. 
94
Make sure you check out the branches that match the LOS 13.0 version (cm-13.0).
95 1 Wolfgang Wiedmeyer
96 5 Wolfgang Wiedmeyer
Once you have cloned the device-specific repo for your device and checked out the correct branch, refer to the @lineage.dependencies@ file to find what repos are left to clone.
97
Clone these repos in the correct locations and remove the prefix (e.g. @android_device_samsung_maguro@ must be cloned in @device/samsung/@ and renamed to @maguro@).
98 1 Wolfgang Wiedmeyer
99 5 Wolfgang Wiedmeyer
*If you cloned the kernel source for your device, it is likely that the kernel build is already integrated, so you can skip the next sections below and continue with [[Replicant60PortingGuide#Setting-up-the-build-environment| setting up the build environment]].*
100 1 Wolfgang Wiedmeyer
101
h3. In case of a missing kernel repository
102
103 6 Wolfgang Wiedmeyer
If the kernel repo is nowhere to be found (make sure you've asked the LineageOS team), you'll need to get the kernel source directly from the vendor, especially if your device is supported by a 3rd party LineageOS fork.
104 1 Wolfgang Wiedmeyer
Keep in mind that the Linux kernel is GPLv2, so vendors have the legal obligation to release the modified kernel sources as soon as they sell you the device.
105
That means the kernel sources will be available online. Here are some websites where such releases are done:
106
* "Samsung Open Source Release Center":http://opensource.samsung.com/
107
For Samsung kernels. Search the device codename (e.g. I9000) and download the package called "Opensource Update" (e.g. GT-I9000_Opensource_GB_Update2.zip).
108
This will hold a kernel archive with all the sources and instructions on how to build it and which defconfig to use.
109 6 Wolfgang Wiedmeyer
* "CodeAurora":https://wiki.codeaurora.org/xwiki/bin/QAEP/
110 1 Wolfgang Wiedmeyer
For MSM/QSD devices, and particularly HTC ones.
111
* "HTCdev":http://www.htcdev.com/devcenter/downloads
112
* "Motorola Sourceforge":http://sourceforge.net/motorola/
113 6 Wolfgang Wiedmeyer
* "Sony Mobile Developer":https://developer.sonymobile.com/downloads/opensource/
114
* "LG OpenSource":http://opensource.lge.com/index
115 1 Wolfgang Wiedmeyer
116
Once you have the kernel sources, read the instructions to find out which defconfig to use.
117
118
Since manufacturers usually don't release the git history along with the files, you'll need to recreate a git repo:
119
* Clone the mainline kernel in the same version as the Makefile from the sources you just obtained
120
* Remove the cloned files *except the .git directory*
121
* Move the manufacturer kernel tree at the place of the files you just removed
122
* Add all the files in git (@git add -A@) and commit (@git commit@) with a message explaining what you just imported (e.g. "GT-I9000 GB Opensource Update 2")
123
124
Now that you have a git repo, you can move it to the Replicant code tree, under the name: @kernel/vendor/devices@ (e.g. @kernel/samsung/aries@).
125
Make sure to make the @devices@ name match the @devices@ in @android_device_vendor_devices-common@ if the kernel is shared across these devices or to match the @device@ in @android_device_vendor_device@.
126
127
h3. In case of a prebuilt kernel
128
129 6 Wolfgang Wiedmeyer
Some devices may still use a prebuilt kernel.
130
131 1 Wolfgang Wiedmeyer
For such devices, you will need to remove the prebuilt binaries and the instructions to copy the prebuilt kernel and its modules.
132
133
In the device repository (@device/vendor/device@) and common repository for your device (if any), remove the prebuilt kernel and modules (usually called @kernel@ and @module.ko@ (replace module with the name of a module) or a @modules@ directory).
134
Remove the instructions to copy these prebuilts on the makefiles. Remove instructions such as:
135
<pre>
136
PRODUCT_COPY_FILES += \
137
    $(LOCAL_KERNEL):kernel
138
139
LOCAL_KERNEL := $(LOCAL_PATH)/kernel
140
</pre>
141
and anything regarding @TARGET_PREBUILT_KERNEL@ as well as the instructions to copy the prebuilt modules.
142
143
The @BoardConfig.mk@ (or @BoardConfigCommon.mk@ in the common directory for your device) will most likely hold a line like:
144
<pre>
145
TARGET_PREBUILT_KERNEL := device/samsung/p5/kernel
146
</pre>
147
you must remove this line.
148
149
Now that the device repository has no prebuilt instructions, you can add the instructions to build the kernel. In the @BoardConfig.mk@ file, add the following lines:
150
<pre>
151
TARGET_KERNEL_SOURCE := kernel/samsung/p3
152
TARGET_KERNEL_CONFIG := samsung_p5_defconfig
153
</pre>
154
and make sure to replace the location and defconfig by the correct values for your devices (being the location of the device kernel tree and the appropriate defconfig).
155
156
h3. Building the correct kernel image format
157
158
There are different types of kernel images:
159
* Android image: that is a zImage, without a separate initramfs
160
* zImage: that is a zImage, with a built-in initramfs
161
* uImage: that is an image for the u-boot bootloader, with a built-in initramfs
162
163
You need to find out which type of kernel image your device uses. Asking people who know about that is the best idea.
164
165
h4. Android image
166
167
This is the easiest case to handle: just make sure the @CONFIG_INITRAMFS_SOURCE@ option in the kernel defonfig is left blank or undefined:
168
<pre>
169
CONFIG_INITRAMFS_SOURCE=""
170
</pre>
171
172
h4. zImage with built-in initramfs
173
174
Building a zImage with a built-in initramfs requires the following steps:
175
In the kernel defconfig, define the @CONFIG_INITRAMFS_SOURCE@ option this way:
176
<pre>
177
CONFIG_INITRAMFS_SOURCE="../../root"
178
</pre>
179
180
Once this is done, duplicate the defconfig and add the @_recovery@ prefix before the @_defconfig@ ending (e.g. @herring_recovery_defconfig@), edit that file and replace @CONFIG_INITRAMFS_SOURCE@ with:
181
<pre>
182
CONFIG_INITRAMFS_SOURCE="../../recovery/root"
183
</pre>
184
185
Back to the device repository, edit the @BoardConfig.mk@ file and add the following line:
186
<pre>
187
TARGET_KERNEL_RECOVERY_CONFIG := samsung_p5_recovery_defconfig
188
</pre>
189
and make sure to replace the defconfig by the appropriate defconfig you just cloned (the one with the @_recovery_defconfig@ ending).
190
191
Still in the device repository, create a @bootimg.mk@ file containing the following:
192
<pre>
193
LOCAL_PATH := $(call my-dir)
194
195
$(INSTALLED_BOOTIMAGE_TARGET): $(INSTALLED_KERNEL_TARGET)
196
	$(ACP) $(INSTALLED_KERNEL_TARGET) $@
197
198
$(INSTALLED_RECOVERYIMAGE_TARGET): $(INSTALLED_RECOVERY_KERNEL_TARGET)
199
	$(ACP) $(INSTALLED_RECOVERY_KERNEL_TARGET) $@
200
</pre>
201
202
Edit the @BoardConfig.mk@ file and add the following line:
203
<pre>
204
BOARD_CUSTOM_BOOTIMG_MK := device/vendor/device/bootimg.mk
205
</pre>
206 6 Wolfgang Wiedmeyer
and make sure to replace @device/vendor/device/@ with the correct path to your device's repository.
207 1 Wolfgang Wiedmeyer
208
h4. uImage with built-in initramfs
209
210
Follow the previous instructions (*zImage with built-in initramfs*) and set the @BOARD_USES_UBOOT@ variable in the @BoardConfig.mk@ file:
211
<pre>
212
BOARD_USES_UBOOT := true
213
</pre>
214
215
216
h2. Setting up the build environment
217
218
Now that the repos are cloned, you need to modify some makefiles to cope with Replicant paths.
219 7 Wolfgang Wiedmeyer
In the device repository (@device/vendor/device@), modify the file called @lineage.mk@ and replace the @vendor/cm/@ occurrences by @vendor/replicant/@. Other makefiles may need that as well (in any case, build will fail very early if you missed one). In that same @lineage.mk@ file, change the PRODUCT_NAME variable by replacing the @lineage@ prefix with @replicant@ (e.g. change PRODUCT_NAME := lineage_maguro  to PRODUCT_NAME := replicant_maguro).
220 1 Wolfgang Wiedmeyer
221 7 Wolfgang Wiedmeyer
Now that your device files are ready, you can declare a new build target: these are held in @vendor/replicant/targets@.
222
Modify that file and add a line (at the end) with the PRODUCT_NAME you set and the @-userdebug@ suffix (e.g. @replicant_maguro-userdebug@).
223 1 Wolfgang Wiedmeyer
224
From now on, everything should be ready to start a build. To check for errors or missed occurrences, start a terminal in the Replicant tree root and lunch:
225
<pre>
226 7 Wolfgang Wiedmeyer
. build/envsetup.sh
227
lunch replicant_device-userdebug
228 1 Wolfgang Wiedmeyer
</pre>
229
230 7 Wolfgang Wiedmeyer
Adapt replicant_device-userdebug from what you added to the @targets@ (e.g. @replicant_maguro-userdebug@).
231 1 Wolfgang Wiedmeyer
If an error occurs, it will explicitly report it and you'll need to fix it before doing anything.
232
If everything works correctly, you should see something like:
233
<pre>
234
============================================
235
PLATFORM_VERSION_CODENAME=REL
236 7 Wolfgang Wiedmeyer
PLATFORM_VERSION=6.0.1
237
REPLICANT_VERSION="replicant-6.0"
238
TARGET_PRODUCT=replicant_n7100
239
TARGET_BUILD_VARIANT=userdebug
240 1 Wolfgang Wiedmeyer
TARGET_BUILD_TYPE=release
241
TARGET_BUILD_APPS=
242
TARGET_ARCH=arm
243 7 Wolfgang Wiedmeyer
TARGET_ARCH_VARIANT=armv7-a-neon
244
TARGET_CPU_VARIANT=cortex-a9
245
TARGET_2ND_ARCH=
246
TARGET_2ND_ARCH_VARIANT=
247
TARGET_2ND_CPU_VARIANT=
248
HOST_ARCH=x86_64
249 1 Wolfgang Wiedmeyer
HOST_OS=linux
250 7 Wolfgang Wiedmeyer
HOST_OS_EXTRA=Linux-4.9.0-2-grsec-amd64-x86_64-with-debian-9.0
251 1 Wolfgang Wiedmeyer
HOST_BUILD_TYPE=release
252 7 Wolfgang Wiedmeyer
BUILD_ID=MOB31K
253
OUT_DIR=/home/wolfi/replicant/6.0-romsrc-official/out
254
WITH_SU=true
255 1 Wolfgang Wiedmeyer
============================================
256
</pre>
257
258 7 Wolfgang Wiedmeyer
This is the output for the Galaxy Note 2 (n7100).
259
260 1 Wolfgang Wiedmeyer
*You must repeat these steps everytime before building anything on a freshly-opened terminal.*
261
Remember:
262
<pre>
263 7 Wolfgang Wiedmeyer
. build/envsetup.sh
264
lunch replicant_device-userdebug
265 1 Wolfgang Wiedmeyer
</pre>
266 7 Wolfgang Wiedmeyer
267
(Make sure to replace device by your device's product name)
268 1 Wolfgang Wiedmeyer
269
h2. Building a recovery image
270
271
Now that everything is set-up, you can build the first image to test on your device: the recovery image.
272
273
The build target is *recoveryimage*, so all you have to do is:
274
<pre>
275 8 Wolfgang Wiedmeyer
mka -j9 recoveryimage
276 1 Wolfgang Wiedmeyer
</pre>
277
278
This should trigger the kernel build and the recovery initramfs build and in the end, produce the @out/target/product/device/recovery.img@ file.
279 8 Wolfgang Wiedmeyer
Once your image is built (it takes some time), flash it to the recovery partition of your device (if any). It's a good idea to look at the LineageOS installation guide to find out how to install that recovery image.
280 1 Wolfgang Wiedmeyer
281
There is usually also a key combination to hold to boot directly to recovery: hopefully, your recovery image will start.
282
283
h2. Building the system
284
285 8 Wolfgang Wiedmeyer
It is time to build a complete set of Replicant images. This includes the system and kernel images.
286 1 Wolfgang Wiedmeyer
287
h3. Building the kernel
288
289
Let's start by building the boot image, that is both the kernel and the Android initramfs. The build target is *bootimage*:
290
<pre>
291 8 Wolfgang Wiedmeyer
mka -j9 bootimage
292 1 Wolfgang Wiedmeyer
</pre>
293
294
In the end, the @out/target/product/device/boot.img@ file will be produced.
295
296
h3. Building the system image
297
298
Building the system is the longest task. The build target is *systemimage*:
299
<pre>
300 8 Wolfgang Wiedmeyer
mka -j9 systemimage
301 1 Wolfgang Wiedmeyer
</pre>
302
303
You might encounter build errors due to the lack of non-free libs. You'll need to find clean workarounds for that. Removing options from @BoardConfig.mk@ can help solve the situation.
304
For instance, the following error:
305
<pre>
306
make: *** No rule to make target `out/target/product/i9300/obj/lib/libTVOut.so', needed by `out/target/product/i9300/obj/EXECUTABLES/mediaserver_intermediates/LINKED/mediaserver'.  Stop.
307
</pre>
308
Was solved by turning @BOARD_USE_SECTVOUT@ to false:
309
<pre>
310
BOARD_USE_SECTVOUT := false
311
</pre>
312
313
When all the images are built, you're ready for flashing the images.
314
Some more steps are required for recovery flashing:
315
# Create a md5sum of the images: @md5sum system.ext4.img boot.img > checksum.md5@
316
# Create a directory on the root of the usb storage (or sdcard) of the phone
317
# Copy the images and the md5 checksum to the newly-created directory
318
# Install the images using the *flash images* menu
319
# Wipe data using *wipe data/factory resert*
320
# Reboot the device: *reboot system now*
321
322
If everything was correctly setup, this should succeed. The best way to make sure it booted is to run @adb logcat@ and wait for an output.
323
That early, it is very likely that graphics will be broken, so don't expect anything to show up on the screen: only adb is a reliable way of knowing whether it worked.
324
325
h2. Android development tips
326
327
Keep in mind that all the make (and such) commands must be run in a terminal where *lunch* has been executed before.
328
329
Once you have a Replicant image installed on the device, there is no need to rebuild a whole image everytime you make a change (but it's a good idea to do it from time to time): you can instead rebuild only a single module by using (where module is the module's name):
330
<pre>
331
make module
332
</pre>
333
334 9 Wolfgang Wiedmeyer
Even better, you can build the module that sits in the current directory by simply using @mm@. To push the new library to the device, use @adb push@ (you'll need to @adb root@ and @adb remount@ the first time).
335 1 Wolfgang Wiedmeyer
336
Moreover, instead of rebooting, you can kill the Android applications (@zygote@, @surfaceflinger@, @rild@) depending on what you are working on.
337
For instance for audio:
338
<pre>
339
adb shell killall zygote
340
</pre>
341
For graphics:
342
<pre>
343
adb shell killall surfaceflinger
344
</pre>
345
For the RIL:
346
<pre>
347
adb shell killall rild
348
</pre>
349
350
Be sure to always look what's going on in logs.
351
For the main buffer:
352
<pre>
353
adb logcat
354
</pre>
355 9 Wolfgang Wiedmeyer
356 1 Wolfgang Wiedmeyer
For the radio (RIL) buffer:
357
<pre>
358
adb logcat -b radio
359
</pre>
360
361
h2. Graphics
362
363 9 Wolfgang Wiedmeyer
Once Replicant booted on the phone, it's time to get graphics working. Several components are involved with graphics on Android:
364 1 Wolfgang Wiedmeyer
* *gralloc*: the graphical memory allocator, also handles the framebuffer
365
* *hwcomposer*: handles things like overlays and 2D blits to offload OpenGL
366
* *libEGL*: the OpenGL implementation (that's what uses the GPU to accelerate graphics)
367
368 9 Wolfgang Wiedmeyer
Generally speaking, libEGL is non-free while gralloc and hwcomposer might be free software (but they often rely on non-free blobs). On most Replicant-supported phones, we use the default gralloc, the software libEGL (libagl) and no hwcomposer. We modified the gralloc so that is uses RGB565 on framebuffer, which turns out to be faster than any other format we tried.
369 1 Wolfgang Wiedmeyer
370 9 Wolfgang Wiedmeyer
To have a fluid-enough experience, you need to disable most hardware-accelerated features of Android and enable Software GL.
371
In @BoardConfig.mk@ (or @BoardConfigCommon.mk@ in the common directory for your device), you may find the following lines:
372 1 Wolfgang Wiedmeyer
<pre>
373 9 Wolfgang Wiedmeyer
USE_OPENGL_RENDERER := true
374
BOARD_EGL_NEEDS_HANDLE_VALUE := true
375
TARGET_REQUIRES_SYNCHRONOUS_SETSURFACE := true
376 1 Wolfgang Wiedmeyer
</pre>
377
378 9 Wolfgang Wiedmeyer
Set @USE_OPENGL_RENDERER@ to @false@ and remove the other lines. There may be more settings related to GPU-accelerated Graphics. You will need to remove these, too.
379
380
Replicant 6.0 has experimental support for a more complete software renderer implementation: llvmpipe from Mesa. To be able to use llvmpipe, add this line to the @BoardConfig.mk@ (or @BoardConfigCommon.mk@ in the common directory for your device):
381 1 Wolfgang Wiedmeyer
<pre>
382 9 Wolfgang Wiedmeyer
BOARD_GPU_DRIVERS := swrast
383 1 Wolfgang Wiedmeyer
</pre>
384
385
h2. Audio
386
387 9 Wolfgang Wiedmeyer
If there is no audio support with free software on LineageOS, you'll have to find out details about how audio works on your device. There are mainly 3 different cases:
388 1 Wolfgang Wiedmeyer
* Audio is standard ALSA
389
* Audio is ALSA with a non-standard interface aside
390
* Audio is not ALSA but something else that is not standard
391
392
To find out whether your device uses ALSA or not, look if you have the @/dev/snd/pcmC0D0c@ and @/dev/snd/pcmC0D0p@ nodes available. A non-standard interface aside might be indicated by the presence of the @/dev/snd/hwC0D0@ node.
393
394 9 Wolfgang Wiedmeyer
If your device is standard ALSA, you can use the tinyalsa-audio library (located under @hardware/tinyalsa-audio@) with a configuration file (an example of such a file is available at @device/samsung/galaxys2-common/configs/tinyalsa-audio.xml@). You can find the proper controls to set on which scenario by running @tinymix@ (found under @external/tinyalsa@) with the non-free blob in place in the different scenarios.
395 1 Wolfgang Wiedmeyer
396 9 Wolfgang Wiedmeyer
If your device involves a non-standard interface or if it completely relies on a non-standard interface, there is no readily available guide to find out how it works, but you can start by looking at the kernel driver and adding debug prints (with printk) and figure out what is going on.
397 1 Wolfgang Wiedmeyer
398
Remember to add the working audio module to the build targets (on the makefiles in the device repo).
399
400
h2. Modem
401
402
In order to support telephony, messaging (SMS) and other network-related features (data as well), you need to make the modem work with Replicant. The modem is often called the radio in Android terminology.
403
404
The modem uses a protocol to communicate with the CPU. You need to find out which protocol the modem for your device is using. There are several possible cases:
405 9 Wolfgang Wiedmeyer
* The protocol is AT, which is the only standard protocol, but it is very old: it is mostly plain ASCII and newer modems usually use a binary protocol
406 1 Wolfgang Wiedmeyer
* The protocol is not standard (vendor-specific) but has been implemented in free software already
407
* The protocol is not standard and has no known free software implementation
408
409 9 Wolfgang Wiedmeyer
To find out which protocol your phone uses, it is a good idea to look at the *radio* log buffer in LineageOS and try to find out from the messages (it may be verbose).
410
The protocol itself is implemented in the RIL (Radio Interface Layer): it is a good idea to take a look at the non-free RIL the device uses (get its path with @getprop rild.libpath@). If LineageOS developers have implemented a wrapper for the proprietary RIL, you will get the path of the wrapper. Look at the RIL wrapper source code in the device repo to find out the path to the non-free RIL.
411 1 Wolfgang Wiedmeyer
412 9 Wolfgang Wiedmeyer
If the modem uses the AT protocol, there are many available RIL implementations out there: Android has a reference-ril (@hardware/ril/reference-ril@) that implements AT and there is the hayes-ril library that makes it easier for you to add support for your device. Though, it is possible that the modem of your device implements undocumented commands, so you'll have to figure these out: the radio log might help a lot if it's verbose, else you'll have to trace the RIL somehow.
413 1 Wolfgang Wiedmeyer
414 9 Wolfgang Wiedmeyer
If the protocol is not AT, it might still be supported: the "FreeSmartphone.Org":http://www.freesmartphone.org/ (FSO) project implements some undocumented protocols. You can also look at "oFono":https://01.org/ofono.
415 1 Wolfgang Wiedmeyer
If your phone was manufactured by Samsung, there is a very good chance that it uses the Samsung-IPC protocol, which is implemented in [[libsamsung-ipc]] and [[Samsung-RIL]]. You will need to add support for your device in [[libsamsung-ipc]] ([[Samsung-RIL]] is device-independent: all the abstraction is done by [[libsamsung-ipc]]), which may be more or less easy depending on whether your modem type is already supported. In any case, you'll need to trace the RIL to find out. There may also be a separate daemon (often called *cbd*) that is in charge of the modem bootup (that's the biggest part you need to figure out), so that's the thing to trace.
416
417 9 Wolfgang Wiedmeyer
If the protocol implementation is nowhere to be found, you'll have to write a free implementation yourself if you want to have free software support for the modem. It's a good idea to ask around whether other people from other communities, such as XDA or LineageOS, would be interested in helping you.
418 1 Wolfgang Wiedmeyer
419
After finding a RIL that may work, add it to the build targets (in the device makefiles) and specify the path to the RIL with @rild.libpath@ (it is often already declared in system.prop in the device repo).
420
421
Once the RIL is working, you may need the audio module cooperation to have sound during calls. For instance with [[Samsung-RIL]], you need to use an Audio-RIL-Interface that implements the Samsung-RIL-Socket interface.
422
423
h2. Sensors
424
425
When adding support for sensors, look at exactly what you will need to replace. There are several possible scenarios:
426 9 Wolfgang Wiedmeyer
* A *complete* free sensors module is already available for your device on the tree from LineageOS
427 1 Wolfgang Wiedmeyer
* An incomplete free sensors module is there and it requires a non-free library to fully work
428
* The sensors module is non-free
429
430
Note that sensors may require daemons aside, such as @orientationd@, @geomagneticd@, etc. You will most likely need to replace these as well.
431
432
If the implementation is incomplete, you will have to write a replacement for the non-free library that is used. For instance, "samsung-sensors":https://gitorious.org/replicant/hardware_samsung-sensors replaces the non-free libakm and provides free software acceleration sensor results for many Samsung devices.
433
434
If there is nothing available, you will have to write a sensors module for you device. You can reuse one from another device and add support for your sensors there.
435
For instance, here is a reference commit of the "Galaxy S3 Exynos Sensors module":https://gitorious.org/replicant/device_samsung_i9300/commit/e49c15824e1a18c6b2bf4b0a89d558749cbb7dac that you may reuse.
436
437
Remember to add the working sensors module to the build targets (on the makefiles in the device repo) like it is done on the reference commit.
438
439
h3. Figuring out the magic in sensors
440
441
When there is no free software for your sensors, you have to figure out: how to enable/disable the sensor and set the poll delay (it's often done via sysfs or via ioctl on a dev node). Reading the kernel-side driver of the sensor is a very good idea, you can add debug prints and force values there. You can also find datasheets about your sensor online, which may help you understanding how it works.
442
443
The really big part is to figure out how to convert the values that are out of the device (and generally passed through by the kernel driver) into the standard units that the Android framework requires.
444
An effective way to do this is to print the values passed by the kernel driver and look what the non-free sensors module returns. Better yet, you can also trace the non-free module and see exactly what it does, though that won't give you the details of the maths involved.
445
446
To find out the maths, open a spreadsheet software, then add the matching kernel values and the one out of the non-free module and try to find an equation that gives the values in standard units from the one returned by the kernel driver. For instance, you might find something like (this is for the LSM330DLC accelerometer):
447
<pre>
448
f(x)=0,0095768072 * x 
449
</pre>
450
451
Once you have this, you may want to find out where that value comes from. In that case, we can see that:
452
<pre>
453
0,0095768072 = 9.80665 / 1024
454
</pre>
455
With @9.80665@ being the standard gravity on Earth. Hence, we have:
456
<pre>
457
f(x)=x * GRAVITY_EARTH / 1024
458
</pre>
459
We can guess that 1024 is the resolution of the ADC that provides the sensor value.
460
461
Once you have this equation figured out, you're ready to implement this in your free sensors module!
462
463
h2. Camera
464
465
When adding support for the camera, you need to look at what is already there in CyanogenMod:
466
* A camera library with full support is there
467
* A camera wrapper is there but needs a non-free library
468
* A non-free library is used directly
469
470
In the first case, you will only have to adjust the preview format to RGB565 and it is also a good idea to lower the preview frame rate. Depending on whether the library already has code to handle RGB565, the difficulty of doing this will change. Here are reference commits that introduce these changes for the Nexus S: "libcamera: Use RGB565 preview format":http://gitorious.org/replicant/device_samsung_crespo/commit/6739c4b2f916467b937a40783de84861787f6605 "libcamera: Set preview framerate to 20fps":http://gitorious.org/replicant/device_samsung_crespo/commit/c53e6a8be024ffd287cec98a7bbec90b862856a3
471
We cannot use YUV formats directly because the Android software EGL implementation used in Replicant only supports dealing with the first YUV plane: thus, preview would be black and white only, and probably slower than RGB565.
472
473
If there is wrapper, you'll need to replace it by an actual camera module that works. Depending on your hardware, there may be different cases:
474
* The camera is accessed through V4L2, with custom controls and procedure
475
* The camera is accessed through a non-standard interface
476
477
In both cases, you'll need to add lots of debug prints to the relevant kernel drivers to figure out how it works. It will be easier if it uses V4L2, as you can already find many implementations of V4L2 out there, but it will very likely need a custom procedure and controls. In the case of a non-standard interface, you're on your own, except if you can find an implementation for a similar interface used on another other device.
478
479
Here is a reference commit of the "Galaxy S3 Exynos Camera module":http://gitorious.org/replicant/device_samsung_i9300/commit/473bbd9d447088f59dd3bb87e0cfe352da56fa49 that uses the Samsung FIMC engine. While it uses V4L2, it needs a custom procedure and custom controls to work properly.
480
481
*Beware:* some camera drivers require the cooperation of the GPU (that seems to be the case on OMAP4). In that case, even a free camera module implementation cannot work on Replicant. Camera drivers may also need to load a non-free firmware, that cannot be distributed with Replicant: hence, you must make sure that the driver will use the pre-installed version of the firmware (if any), burnt on the camera chip in the case loading the non-free firmware from the system fails.
482
483
h2. Dealing with loaded firmwares
484
485
It is very likely that your device requires loaded firmwares for some components of the hardware. These are non-free programs that run separately from the CPU, on other chips. Since Replicant respects its users' freedom, no non-free firmwares are shipped with Replicant. It is possible that CyanogenMod includes shareable non-free firmwares in its tree: you must remove them.
486
487
Sometimes, components will crash (and may restart in an endless loop) when attempting to load a firmware that is not shipped with Replicant: you have to spot the code that loads the firmware and make it properly handle the case where the firmware is not available.
488
489
Though, you should keep in mind that some users may want to use that firmware, so you have to make the firmware loading possible. There are some exceptions to this however, especially when this involves blocking a free software alternative (this is the case with OMX media decoding). Moreover, firmwares should always be located under @/system/vendor/firmware/@ so that they are easy to spot and remove when the user decides to get rid of them (after installing them previously).
490
491
For instance, the Wi-Fi firmwares path (often declared in the @BoardConfig.mk@ file) have to be changed with the @/system/vendor/firmware@ prefix. The bluetooth firmware path is often declared in the init files (such as @init.herring.rc@). Make sure to document the new firmwares locations on the wiki: see the [[DeveloperGuide#New-device-documentation-guide|Developer guide]].
492
493
h3. Dealing with the kernel firmwares
494
495
The Linux kernel comes with its own share of firmware: you have to get rid of them too. Mostly, this is about removing the @firmwares@ directory and modifying the @Makefile@ to make it avoid firmwares.
496
Since the procedure is nearly exactly the same on all kernels, here is a reference commit for the changes to add to @Makefile@: "Removed non-free firmwares and related instructions":https://gitorious.org/replicant/kernel_samsung_crespo/commit/20a341a98d18d9d627fd42d09e0a1d9f8c8ce455
497
498
h2. Software media decoding
499
500
Most of the time, there is a chip dedicated to decoding media files (audio and video) and it very often requires a non-free loaded firmware. Moreover, it prevents software-only solutions from working, so you need to get rid of the libraries (even though they may be free software) that handle hardware media decoding. This is implemented in the @OMX@ and @stagefrighthw@ libraries. You need to spot and remove these products from the build targets of your device (in the device makefiles).
501
502
For reference, here is the commit that removes hardware media decoding on Nexus S (crespo): "OMX: Disable SEC OMX libraries to permit software decoding":https://gitorious.org/replicant/device_samsung_crespo/commit/c8edb6539977c8820d665691d53c33892cfa4fdd
503
504
h2. Bottomline
505
506
Not every hardware feature can be supported by Replicant: there are some areas where there is simply no free software available. If this is about a critical component (audio, graphics too slow, telephony) and there is no solution in sight, you might as well consider the port a failure. On the other hand, there are lacks we can leave with, for instance 3D, camera or GPS support: don't let that get in the way of releasing images for your device!
507
508
h2. Pushing your work to Replicant repositories
509
510
Once your device works, or during the development process (it is recommended to do it as soon as it appears that the port will be successful), you have to push all your work to Replicant repositories. 
511
You need to ask for commit access to our repositories to be allowed to push your work. This means creating the repositories for your device, pushing your work to these and to the other repositories you modified and adding the new repositories to the manifest.
512
513
The [[DeveloperGuide#Repositories|Developer guide]] hold all the rules for naming repositories: make sure to act accordingly with these requirements!
514
515
The @manifest@ holds the list of the repositories we use in each Replicant version. Its syntax is xml, so it's easy to add your new repositories.
516
517
h2. Adding documentation about your device
518
519
Once your device is usable, you have to create documentation on the Replicant wiki to let others know about relevant material concerning the device, especially build and installation instructions. This is absolutely required before we can publish any image for your device!
520
521
The process is described in the [[DeveloperGuide#New-device-documentation-guide|Developer guide]].