Project

General

Profile

DevicePortingGuide » History » Version 2

Wolfgang Wiedmeyer, 03/17/2017 10:15 PM
update first two sections

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
First of all, you'll have to find out the device's codename that was given by its manufacturer. "Wikipedia":http://www.wikipedia.org/ usually has that information on the device's article. For instance, the codename for the European version of the Nexus S given by Samsung is i9023. This codename will help in the process of getting informations about the device.
35
36
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 CyanogenMod, you can find it out from the "CyanogenMod Wiki":http://wiki.cyanogenmod.org/ or on "CyanogenMod download page":http://get.cm/. For instance, the "Nexus S":http://wiki.cyanogenmod.org/w/Crespo_Info codename is: @crespo@.
37
38
h3. Investigating the hardware
39
40
It is useful to have a general idea of what kind of hardware is present in the phone. From the Wikipedia and CyanogenMod pages about the device, it's already possible to know what System on a Chip (SoC) it uses and a couple other details.
41
42
To learn more details, you can consider looking for a teardown of the device (for instance on "iFixit":http://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
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
This is not an easy information to find out, but the developers involved in the CyanogenMod port will probably know that information. It's a good idea to just ask them.
51
52
h3. Discovering the way of flashing the device
53
54
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 "CyanogenMod Wiki":http://wiki.cyanogenmod.org/ has install guides for the supported devices and you'll probably find install guides for non-official CM ports as well. It is very important to understand the flashing procedure as it will have to be documented on the Replicant wiki.
55
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
The key information to get before starting the port is the list of the non-free components that are required by CyanogenMod.
63
The easiest way to do this is to spot the device repository in "CyanogenMod repos":https://github.com/CyanogenMod/ and look for the @extract-files.sh@ or @proprietary-blobs.txt@ file on the @ics@ branch.
64
There is usually a link to the device repository from the "CyanogenMod Wiki":http://wiki.cyanogenmod.org/
65
66
For instance, the list of non-free components for the "Nexus S":https://github.com/CyanogenMod/android_device_samsung_crespo is "extract-files.sh":https://github.com/CyanogenMod/android_device_samsung_crespo/blob/ics/extract-files.sh
67
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
70
h2. Getting started with Replicant development
71
72
In order to prepare everything for the Replicant port:
73
* Install CyanogenMod on the phone
74
* Install the [[BuildDependenciesInstallation|build dependencies]]
75
* [[ReplicantSourceCode|Replicant source code]]
76
* Read the Android Source code guide: http://source.android.com/source/index.html
77
* Read the Android Device porting guide: http://source.android.com/devices/index.html
78
* Read How To Port CyanogenMod Android To Your Own Device: https://web.archive.org/web/20161121154456/http://wiki.cyanogenmod.org/w/Doc:_porting_intro
79
* Read the Replicant [[DeveloperGuide|developer guide]]
80
* Learn how to debug: [[GettingLogs|getting logs]], [[GDBDebugging|GDB debugging]].
81
82
h2. Cloning the device files
83
84
Once your Replicant tree is ready, you can start adding the necessary repos for your device.
85
That means cloning the necessary repos in the right place. These repos are:
86
* A *device-specific repo*. On CyanogenMod, it is usually called: @android_device_vendor_device@.
87
* Sometimes one or more *common repo(s)*, usually called: @android_device_vendor_devices-common@.
88
Some devices don't need any common repo, but some do.
89
* A *kernel repo*. On CyanogenMod, it is usually called: @android_kernel_samsung_devices@.
90
The kernel repo can be shared across a family of devices (for instance, on kernel repo for Samsung Exynos, one for Samsung OMAP, etc).
91
92
You can find the device-specific repo from the device's page on the "CyanogenMod Wiki":http://wiki.cyanogenmod.org/. 
93
Make sure you check out the branches that match the CM 9.0 version (the branch may be called @ics@).
94
95
Once you have cloned the device-specific repo for your device and checked out the correct branch, refer to the @cm.dependencies@ file to find what repos are left to clone.
96
Clone these repos in the correct locations and remove the prefix (e.g. @android_device_samsung_crespo@ must be cloned in @device/samsung/@ and renamed to @crespo@).
97
98
If your 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.
99
100
h3. In case of a missing kernel repository
101
102
If the kernel repo is nowhere to be found (make sure you've asked the CyanogenMod team), you'll need to get the kernel source directly from the vendor, especially if your device is supported by a 3rd party CyanogenMod fork.
103
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.
104
That means the kernel sources will be available online. Here are some websites where such releases are done:
105
* "Samsung Open Source Release Center":http://opensource.samsung.com/
106
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).
107
This will hold a kernel archive with all the sources and instructions on how to build it and which defconfig to use.
108
* "CodeAurora":https://www.codeaurora.org/contribute/projects/qaep
109
For MSM/QSD devices, and particularly HTC ones.
110
* "HTCdev":http://www.htcdev.com/devcenter/downloads
111
* "Motorola Sourceforge":http://sourceforge.net/motorola/
112
* "Sony Mobile Developer":http://developer.sonymobile.com/downloads/opensource/
113
* "LG OpenSource":http://www.lg.com/global/support/opensource/opensource.jsp
114
115
Once you have the kernel sources, read the instructions to find out which defconfig to use.
116
117
Since manufacturers usually don't release the git history along with the files, you'll need to recreate a git repo:
118
* Clone the mainline kernel in the same version as the Makefile from the sources you just obtained
119
* Remove the cloned files *except the .git directory*
120
* Move the manufacturer kernel tree at the place of the files you just removed
121
* 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")
122
123
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@).
124
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@.
125
126
h3. In case of a prebuilt kernel
127
128
Some devices are still using a prebuilt kernel. Even though the CyanogenMod team is trying to avoid that, it remains in many repos.
129
For such devices, you will need to remove the prebuilt binaries and the instructions to copy the prebuilt kernel and its modules.
130
131
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).
132
Remove the instructions to copy these prebuilts on the makefiles. Remove instructions such as:
133
<pre>
134
PRODUCT_COPY_FILES += \
135
    $(LOCAL_KERNEL):kernel
136
137
LOCAL_KERNEL := $(LOCAL_PATH)/kernel
138
</pre>
139
and anything regarding @TARGET_PREBUILT_KERNEL@ as well as the instructions to copy the prebuilt modules.
140
141
The @BoardConfig.mk@ (or @BoardConfigCommon.mk@ in the common directory for your device) will most likely hold a line like:
142
<pre>
143
TARGET_PREBUILT_KERNEL := device/samsung/p5/kernel
144
</pre>
145
you must remove this line.
146
147
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:
148
<pre>
149
TARGET_KERNEL_SOURCE := kernel/samsung/p3
150
TARGET_KERNEL_CONFIG := samsung_p5_defconfig
151
</pre>
152
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).
153
154
h3. Building the correct kernel image format
155
156
There are different types of kernel images:
157
* Android image: that is a zImage, without a separate initramfs
158
* zImage: that is a zImage, with a built-in initramfs
159
* uImage: that is an image for the u-boot bootloader, with a built-in initramfs
160
161
You need to find out which type of kernel image your device uses. Asking people who know about that is the best idea.
162
163
h4. Android image
164
165
This is the easiest case to handle: just make sure the @CONFIG_INITRAMFS_SOURCE@ option in the kernel defonfig is left blank or undefined:
166
<pre>
167
CONFIG_INITRAMFS_SOURCE=""
168
</pre>
169
170
h4. zImage with built-in initramfs
171
172
Building a zImage with a built-in initramfs requires the following steps:
173
In the kernel defconfig, define the @CONFIG_INITRAMFS_SOURCE@ option this way:
174
<pre>
175
CONFIG_INITRAMFS_SOURCE="../../root"
176
</pre>
177
178
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:
179
<pre>
180
CONFIG_INITRAMFS_SOURCE="../../recovery/root"
181
</pre>
182
183
Back to the device repository, edit the @BoardConfig.mk@ file and add the following line:
184
<pre>
185
TARGET_KERNEL_RECOVERY_CONFIG := samsung_p5_recovery_defconfig
186
</pre>
187
and make sure to replace the defconfig by the appropriate defconfig you just cloned (the one with the @_recovery_defconfig@ ending).
188
189
Still in the device repository, create a @bootimg.mk@ file containing the following:
190
<pre>
191
LOCAL_PATH := $(call my-dir)
192
193
$(INSTALLED_BOOTIMAGE_TARGET): $(INSTALLED_KERNEL_TARGET)
194
	$(ACP) $(INSTALLED_KERNEL_TARGET) $@
195
196
$(INSTALLED_RECOVERYIMAGE_TARGET): $(INSTALLED_RECOVERY_KERNEL_TARGET)
197
	$(ACP) $(INSTALLED_RECOVERY_KERNEL_TARGET) $@
198
</pre>
199
200
Edit the @BoardConfig.mk@ file and add the following line:
201
<pre>
202
BOARD_CUSTOM_BOOTIMG_MK := device/vendor/device/bootimg.mk
203
</pre>
204
and make sure to replace @device/vendor/device/@ to the correct path to your device's repository.
205
206
h4. uImage with built-in initramfs
207
208
Follow the previous instructions (*zImage with built-in initramfs*) and set the @BOARD_USES_UBOOT@ variable in the @BoardConfig.mk@ file:
209
<pre>
210
BOARD_USES_UBOOT := true
211
</pre>
212
213
214
h2. Setting up the build environment
215
216
Now that the repos are cloned, you need to modify some makefiles to cope with Replicant paths.
217
In the device repository (@device/vendor/device@), modify the file called @cm.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 @cm.mk@ file, change the PRODUCT_NAME variable by replacing the @cm@ prefix with @replicant@ (e.g. change PRODUCT_NAME := cm_crespo  to PRODUCT_NAME := replicant_crespo).
218
219
Now that your device files are ready, you can declare a new build target: these are held in @vendor/replicant/jenkins-build-targets@.
220
Modify that file and add a line (at the end) with the PRODUCT_NAME you set and the @-eng@ suffix (e.g. @replicant_crespo-eng@).
221
222
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:
223
<pre>
224
source build/envsetup.sh
225
lunch replicant_device-eng
226
</pre>
227
228
Adapt replicant_device-eng from what you added to the @jenkins-build-target@ (e.g. @replicant_crespo-eng@).
229
If an error occurs, it will explicitly report it and you'll need to fix it before doing anything.
230
If everything works correctly, you should see something like:
231
<pre>
232
============================================
233
PLATFORM_VERSION_CODENAME=REL
234
PLATFORM_VERSION=4.0.4
235
TARGET_PRODUCT=replicant_crespo
236
TARGET_BUILD_VARIANT=eng
237
TARGET_BUILD_TYPE=release
238
TARGET_BUILD_APPS=
239
TARGET_ARCH=arm
240
TARGET_ARCH_VARIANT=armv7-a
241
HOST_ARCH=x86
242
HOST_OS=linux
243
HOST_BUILD_TYPE=release
244
BUILD_ID=IMM76L
245
============================================
246
</pre>
247
248
*You must repeat these steps everytime before building anything on a freshly-opened terminal.*
249
Remember:
250
<pre>
251
source build/envsetup.sh
252
lunch replicant_device-eng
253
</pre>
254
(make sure to replace device by your device's product name).
255
256
h2. Building a recovery image
257
258
Now that everything is set-up, you can build the first image to test on your device: the recovery image.
259
260
The build target is *recoveryimage*, so all you have to do is:
261
<pre>
262
make -j9 recoveryimage
263
</pre>
264
265
This should trigger the kernel build and the recovery initramfs build and in the end, produce the @out/target/product/device/recovery.img@ file.
266
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 CyanogenMod installation guide to find out how to install that recovery image.
267
268
There is usually also a key combination to hold to boot directly to recovery: hopefully, your recovery image will start.
269
270
h2. Building the system
271
272
It is time to build a complete set of Replicant images. This includes at least the system and kernel images. Depending on the installation method, an userdata image might be needed too.
273
274
h3. Building the kernel
275
276
Let's start by building the boot image, that is both the kernel and the Android initramfs. The build target is *bootimage*:
277
<pre>
278
make -j9 bootimage
279
</pre>
280
281
In the end, the @out/target/product/device/boot.img@ file will be produced.
282
283
h3. Setting up the system image format
284
285
It is time for you to take a good look at the installation process. Mainly, about whether the images will be flashed using the bootloader or recovery.
286
Since CyanogenMod uses the zip installation method, that we do not want to use, you're on your own here.
287
288
h4. Finding the appropriate filesystem
289
290
It will be easy to find out the filesystem for the different partitions if the device already runs CyanogenMod:
291
<pre>
292
$ adb shell mount
293
rootfs / rootfs ro,relatime 0 0
294
tmpfs /dev tmpfs rw,nosuid,relatime,mode=755 0 0
295
devpts /dev/pts devpts rw,relatime,mode=600 0 0
296
proc /proc proc rw,relatime 0 0
297
sysfs /sys sysfs rw,relatime 0 0
298
none /acct cgroup rw,relatime,cpuacct 0 0
299
tmpfs /mnt/asec tmpfs rw,relatime,mode=755,gid=1000 0 0
300
tmpfs /mnt/obb tmpfs rw,relatime,mode=755,gid=1000 0 0
301
none /dev/cpuctl cgroup rw,relatime,cpu 0 0
302
/dev/block/mtdblock2 /system yaffs2 ro,relatime 0 0
303
/dev/block/mtdblock3 /cache yaffs2 rw,nosuid,nodev,relatime 0 0
304
/dev/block/mtdblock5 /radio yaffs2 rw,relatime 0 0
305
/dev/block/mmcblk0p2 /data ext4 rw,nosuid,nodev,noatime,nodiratime,barrier=1,data=ordered,noauto_da_alloc 0 0
306
/dev/block/mtdblock6 /datadata yaffs2 rw,relatime 0 0
307
/dev/block/mtdblock4 /efs yaffs2 rw,relatime 0 0
308
/sys/kernel/debug /sys/kernel/debug debugfs rw,relatime 0 0
309
/dev/block/vold/179:1 /mnt/sdcard vfat rw,dirsync,nosuid,nodev,noexec,relatime,uid=1000,gid=1015,fmask=0702,dmask=0702,allow_utime=0020,codepage=cp437,iocharset=iso8859-1,shortname=mixed,utf8,errors=remount-ro 0 0
310
/dev/block/vold/179:1 /mnt/secure/asec vfat rw,dirsync,nosuid,nodev,noexec,relatime,uid=1000,gid=1015,fmask=0702,dmask=0702,allow_utime=0020,codepage=cp437,iocharset=iso8859-1,shortname=mixed,utf8,errors=remount-ro 0 0
311
tmpfs /mnt/sdcard/.android_secure tmpfs ro,relatime,size=0k,mode=000 0 0
312
</pre>
313
314
So we can deduce that system is yaffs2 and data is ext4. Don't bother about the other partitions and mount-points, only */system* and */data* matter for now.
315
316
h4. Changing the images format for bootloader installation
317
318
You have to modify the @BoardConfig.mk@ file on the main device repository (it might be delegated to @BoardConfigCommon.mk@ on the common repos).
319
320
To build ext4 system and userdata images, make sure you have:
321
<pre>
322
TARGET_USERIMAGES_USE_EXT4 := true
323
</pre>
324
To build yaffs2 system and userdata images, make sure you have:
325
<pre>
326
TARGET_USERIMAGES_USE_EXT4 := false
327
</pre>
328
329
h4. Changing the images format for recovery installation
330
331
If the images have to be flashed using recovery, you must make sure they are built in yaffs2 format, with the default page and spare sizes.
332
Make sure to remove the following lines from @BoardConfig.mk@ (even though the values might be different):
333
<pre>
334
BOARD_NAND_PAGE_SIZE := 4096
335
BOARD_NAND_SPARE_SIZE := 128
336
</pre>
337
Add the following to have yaffs2 images:
338
<pre>
339
TARGET_USERIMAGES_USE_EXT4 := false
340
</pre>
341
342
Even though the images are built as yaffs2, it doesn't mean that the filesystem on the device will be yaffs2: you have to set the correct filesystem, amongst: *ext4*, *yaffs2* in the built image file name.
343
That means you have to change the target images names. This is done by adding the following line (adapted for your device) on @BoardConfig.mk@:
344
<pre>
345
BOARD_CUSTOM_USERIMG_MK := device/vendor/device/userimg.mk
346
</pre>
347
You need to create the @userimg.mk@ file on the device main repository, with the following contents (adapt the target name):
348
349
<pre>
350
INSTALLED_SYSTEMIMAGE_TARGET := $(PRODUCT_OUT)/system.ext4.img
351
352
$(INSTALLED_SYSTEMIMAGE_TARGET): $(INSTALLED_SYSTEMIMAGE)
353
	@echo -e ${CL_INS}"Install system fs image: $@"${CL_RST}
354
	$(hide) mv $(INSTALLED_SYSTEMIMAGE) $(INSTALLED_SYSTEMIMAGE_TARGET)
355
356
systemimage: $(INSTALLED_SYSTEMIMAGE_TARGET)
357
</pre>
358
359
h3. Building the system image
360
361
Building the system is the longest task. The build target is *systemimage*:
362
<pre>
363
make -j9 systemimage
364
</pre>
365
366
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.
367
For instance, the following error:
368
<pre>
369
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.
370
</pre>
371
Was solved by turning @BOARD_USE_SECTVOUT@ to false:
372
<pre>
373
BOARD_USE_SECTVOUT := false
374
</pre>
375
376
Once the systemimage is built, you have to build the *userdataimage* if you're going to flash using the bootloader:
377
<pre>
378
make -j9 userdataimage
379
</pre>
380
381
When all the images are built, you're ready for flashing the images.
382
Some more steps are required for recovery flashing:
383
# Create a md5sum of the images: @md5sum system.ext4.img boot.img > checksum.md5@
384
# Create a directory on the root of the usb storage (or sdcard) of the phone
385
# Copy the images and the md5 checksum to the newly-created directory
386
# Install the images using the *flash images* menu
387
# Wipe data using *wipe data/factory resert*
388
# Reboot the device: *reboot system now*
389
390
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.
391
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.
392
393
h2. Android development tips
394
395
Keep in mind that all the make (and such) commands must be run in a terminal where *lunch* has been executed before.
396
397
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):
398
<pre>
399
make module
400
</pre>
401
402
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 remount@ the first time).
403
404
Moreover, instead of rebooting, you can kill the Android applications (@zygote@, @surfaceflinger@, @rild@) depending on what you are working on.
405
For instance for audio:
406
<pre>
407
adb shell killall zygote
408
</pre>
409
For graphics:
410
<pre>
411
adb shell killall surfaceflinger
412
</pre>
413
For the RIL:
414
<pre>
415
adb shell killall rild
416
</pre>
417
418
Be sure to always look what's going on in logs.
419
For the main buffer:
420
<pre>
421
adb logcat
422
</pre>
423
For the radio (RIL) buffer:
424
<pre>
425
adb logcat -b radio
426
</pre>
427
428
h2. Graphics
429
430
Once Replicant booted on the phone, it's time to get graphics working. Several components are involved with graphics on android:
431
* *gralloc*: the graphical memory allocator, also handles the framebuffer
432
* *hwcomposer*: handles things like overlays and 2D blits to offload OpenGL
433
* *libEGL*: the OpenGL implementation (that's what uses the GPU to accelerate graphics)
434
435
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 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.
436
437
However, to have a fluid-enough experience, you need to disable most hardware-accelerated features of Android to enable Software GL.
438
This is done by modifying the @cm.mk@ Makefile on the device repository. Add the following lines after the others inherit calls:
439
<pre>
440
# Inherit Software GL configuration.
441
$(call inherit-product, vendor/replicant/config/software_gl.mk)
442
</pre>
443
444
Moreover, you might need to add the Software GL configuration on the @egl.cfg@ file, that is located somewhere in the device repository (perhaps under @config/@).
445
Add the following line at the beginning of the file (if it's not there already):
446
<pre>
447
0 0 android
448
</pre>
449
450
This will prevent surfaceflinger from doing a SEGFAULT.
451
452
h2. Audio
453
454
If there is no audio support with free software on CyanogenMod, you'll have to find out details about how audio works on your device. There are mainly 3 different cases:
455
* Audio is standard ALSA
456
* Audio is ALSA with a non-standard interface aside
457
* Audio is not ALSA but something else that is not standard
458
459
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.
460
461
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/configs/tinyalsa-audio.xml@). You can find the propers controls to set on which scenario by running @tinymix@ (found under @external/tinyalsa@) with the non-free blob in place in the different scenarios.
462
463
If your device involves a non-standard interface or if it completely relies 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) there and figure out what is going on.
464
465
Remember to add the working audio module to the build targets (on the makefiles in the device repo).
466
467
h2. Modem
468
469
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.
470
471
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:
472
* The protocol is AT, which is the only standard protocol, but it's very old: it is mostly plain ASCII and newer modems usually use a binary protocol
473
* The protocol is not standard (vendor-specific) but has been implemented in free software already
474
* The protocol is not standard and has no known free software implementation
475
476
To find out which protocol your phone uses, it is a good idea to look at the *radio* log buffer in CyanogenMod and try to find out from the messages (it may be verbose).
477
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@).
478
479
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 (located under @hardware/ril/hayes-ril/@) 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.
480
481
If the protocol is not AT, it might still be supported: the "FreeSmartphone.Org":http://wiki.freesmartphone.org (FSO) project implements some undocumented protocols. You can also look at "oFono":https://ofono.org/.
482
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.
483
484
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 CyanogenMod, would be interested in helping you.
485
486
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).
487
488
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.
489
490
h2. Sensors
491
492
When adding support for sensors, look at exactly what you will need to replace. There are several possible scenarios:
493
* A *complete* free sensors module is already available for your device on the tree from CyanogenMod
494
* An incomplete free sensors module is there and it requires a non-free library to fully work
495
* The sensors module is non-free
496
497
Note that sensors may require daemons aside, such as @orientationd@, @geomagneticd@, etc. You will most likely need to replace these as well.
498
499
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.
500
501
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.
502
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.
503
504
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.
505
506
h3. Figuring out the magic in sensors
507
508
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.
509
510
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.
511
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.
512
513
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):
514
<pre>
515
f(x)=0,0095768072 * x 
516
</pre>
517
518
Once you have this, you may want to find out where that value comes from. In that case, we can see that:
519
<pre>
520
0,0095768072 = 9.80665 / 1024
521
</pre>
522
With @9.80665@ being the standard gravity on Earth. Hence, we have:
523
<pre>
524
f(x)=x * GRAVITY_EARTH / 1024
525
</pre>
526
We can guess that 1024 is the resolution of the ADC that provides the sensor value.
527
528
Once you have this equation figured out, you're ready to implement this in your free sensors module!
529
530
h2. Camera
531
532
When adding support for the camera, you need to look at what is already there in CyanogenMod:
533
* A camera library with full support is there
534
* A camera wrapper is there but needs a non-free library
535
* A non-free library is used directly
536
537
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
538
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.
539
540
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:
541
* The camera is accessed through V4L2, with custom controls and procedure
542
* The camera is accessed through a non-standard interface
543
544
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.
545
546
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.
547
548
*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.
549
550
h2. Dealing with loaded firmwares
551
552
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.
553
554
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.
555
556
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).
557
558
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]].
559
560
h3. Dealing with the kernel firmwares
561
562
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.
563
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
564
565
h2. Software media decoding
566
567
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).
568
569
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
570
571
h2. Bottomline
572
573
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!
574
575
h2. Pushing your work to Replicant repositories
576
577
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. 
578
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.
579
580
The [[DeveloperGuide#Repositories|Developer guide]] hold all the rules for naming repositories: make sure to act accordingly with these requirements!
581
582
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.
583
584
h2. Adding documentation about your device
585
586
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!
587
588
The process is described in the [[DeveloperGuide#New-device-documentation-guide|Developer guide]].