Merge "Cleanup Obsolete LOCAL_PRELINK_MODULE."
[GitHub/LineageOS/android_hardware_samsung_slsi_exynos5.git] / mobicore / README.android
1 MobiCore Daemon in Android
2 ---
3
4 Command line
5 --
6 The MobiCore Daemon supports 4 command line options. It also displays them with the help option:
7
8 # ./mcDriverDaemon -h
9 usage: ./mcDriverDaemon [-mdsbh]
10 Start MobiCore Daemon
11
12 -h show this help
13 -b fork to background
14 -m IMAGE load mobicore from IMAGE to DDR
15 -s disable daemon scheduler(default enabled)
16 -d SIZE donate SIZE bytes to mobicore(disabled on most platforms)
17 -r DRIVER load dyamic driver
18
19 -b Forks the daemon to background
20
21 # ./mcDriverDaemon -b
22
23 Makes the daemon run in background and returns immediate control to the shell. No need to use shell forking with &
24
25 -m Loads a mobicore image to DDR
26
27 # ./mcDriverDaemon -m /data/app/mobicore.img
28
29 Loads the mobicore.img to DDR and starts executing it.
30
31 -s Disables NQ IRQ scheduler
32
33 # ./mcDriverDaemon -s
34
35 -d Sets how much RAM is donated to Mobicore in bytes
36
37 # ./mcDriverDaemon -d 1048576
38
39 If no -d is specified then the daemon donates 1Mb. The Value 0 disables RAM donation.
40
41 -r Loads dynamic driver at startup. The full path of the driver binary must be given, eg. /data/app/driver.drbin
42
43 # ./mcDriverDaemon -r /data/app/driver.drbin
44
45 Custom registry locations
46 --
47 Registry fallback
48
49 In case of a Device wipe in Android the /data/app/mcRegistry folder will be deleted with all it's contents. To overcome
50 this the daemon supports a fallback location(eg /system/app/mcRegistry): it first tries to load the trustlet
51 from /data/app/mcRegistry/[uuid].tlbin and if it fails then it tries to read the trustlet from /system/app/mcRegistry/[uuid].tlb
52
53 Both paths are completely configurable for the Daemon using 2 environment variables:MC_REGISTRY_PATH and MC_REGISTRY_FALLBACK_PATH
54
55 For example if you want to use /data/app/mcRegistry as the default path and /system/app/mcRegistry as the fallback path:
56
57 $ export MC_REGISTRY_PATH=/data/app/mcRegistry
58 $ export MC_REGISTRY_FALLBACK_PATH=/system/app/mcRegistry
59 $ /data/app/mcDriverDaemon
60
61 Custom authtoken path
62 --
63
64 The authtoken file is created at provisioning and is by default located in /data/app/mcRegistry/00000.authtoken
65
66 Because a device wipe could delete this file and make MobiCore unusable a new environment variable has been added to change the
67 default behaviour: MC_AUTH_TOKEN_PATH
68
69 $ export MC_AUTH_TOKEN_PATH=/efs
70 $ /data/app/mcDriverDaemon
71
72 This would change the location of the authtoken file to /efs