FreeCalypso > hg > fc-magnetite

comparison doc/Config-vars @ 523:569c3d522e5c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/Config-vars: written
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 24 Jul 2018 04:22:51 +0000
parents
children 5019764a0e9f
comparison
equal deleted inserted replaced
522:9363ea39c74c 523:569c3d522e5c
1 The following Bourne shell variables can be set on the ./configure.sh command
2 line to tweak the firmware build configuration:
3
4 ALLOW_CSIM_GSM
5
6 Per TI's original design, the AT+CSIM command does not allow GSM APDUs
7 of class 0xA0. Openmoko found some need for them, and they patched
8 their modem fw to allow these APDUs with AT+CSIM. With our new hybrid
9 modem fw this policy setting is configurable at build time; the default
10 is ALLOW_CSIM_GSM=1 (GSM APDUs allowed).
11
12 DISABLE_SLEEP
13
14 The general default is DISABLE_SLEEP=0, and the firmware automatically
15 enables all of the chipset's available sleep modes on boot. Setting
16 DISABLE_SLEEP=1 causes all sleep modes to be disabled by default on
17 boot (they can still be enabled with the AT%SLEEP command); this
18 setting is needed for FCDEV3B V1 boards that have a hardware bug that
19 causes breakage when sleep modes are enabled.
20
21 DSAMPLE_FULL_COLOR
22
23 When the firmware's R2D component (normally present only in UI-enabled
24 builds) is built for any target other than c139, one of TI's D-Sample
25 framebuffer drivers is enabled: either color or B&W. (The actual
26 hardware pokes are omitted when the build target is anything other than
27 dsample, but the framebuffer is still maintained in RAM.) By default
28 the color framebuffer driver is enabled; setting DSAMPLE_FULL_COLOR=0
29 switches to the B&W framebuffer driver.
30
31 L1_DYN_DSP_DWNLD
32
33 This setting enables TI's dynamic DSP patch download mechanism. When
34 the firmware is built for a Calypso target with DSP ROM version 36 in
35 the silicon (all FreeCalypso-made hw and most of the supported legacy
36 targets), L1_DYN_DSP_DWNLD is enabled by default and needs to be kept
37 enabled for correct operation: the patch code we got from TI for this
38 ROM is the dynamic download version, and the ARM-side L1 code expects
39 all of these patches to be present, both the static part and the
40 dynamic parts. However, one can build our fw with L1_DYN_DSP_DWNLD=0
41 for experimental testing, to see what breaks when the dynamic patches
42 are omitted.
43
44 L1_VOICE_MEMO_AMR
45
46 This setting enables or disables support in L1 and in the RiViera Audio
47 Service for AMR voice memo recording and playback. This code has not
48 been properly studied yet and no test AT commands are provided for it,
49 but it is enabled by default like in TI's original TCS211 fw.
50
51 MELODY_E2
52
53 This setting enables or disables support in L1 and in the RiViera Audio
54 Service for playing E2-format melodies. The default is MELODY_E2=1
55 like in TI's original TCS211 fw. Note that Melody E1 support is always
56 enabled; setting MELODY_E2=0 disables only Melody E2, but not E1.
57
58 SERIAL_DYNAMIC_SWITCH
59
60 TI's TCS211 fw includes a provision (only for Bluetooth-enabled fw in
61 TI's original) to switch one UART between the AT command interface and
62 RVTMUX while the other UART is fixed for Bluetooth. In FreeCalypso we
63 have changed this code to work without Bluetooth, for the purpose of
64 switching the user-facing MODEM UART between AT commands and RVTMUX,
65 but the mechanism does not work properly yet and is disabled by default.
66 Enable it with SERIAL_DYNAMIC_SWITCH=1 if you would like to play with
67 it.
68
69 SPEECH_RECO
70
71 This setting enables or disables support in L1 and in the RiViera Audio
72 Service for TI's speech recognition mechanism. This code and the
73 underlying DSP facility itself have not been properly studied yet and
74 no test AT commands are provided for it, but it is enabled by default
75 like in TI's original TCS211 fw.
76
77 SUFFIX
78
79 This setting is solely for configuration management. If you make a
80 build with any of the settings described in this document changed from
81 the default, you should also pass a SUFFIX=-xxx argument so your special
82 build will be appropriately identified in the build directory name and
83 in the firmware version ID string compiled into the image. The naming
84 of suffixes is up to you, but here are some examples:
85
86 DSAMPLE_FULL_COLOR=0 UI_CONFIG=bigbw SUFFIX=-bw
87 L1_DYN_DSP_DWNLD=0 SUFFIX=-nodyn
88 MELODY_E2=0 SUFFIX=-noe2
89 SERIAL_DYNAMIC_SWITCH=1 SUFFIX=-sds
90 SPEECH_RECO=0 SUFFIX=-nosr
91 TR_BAUD_CONFIG=TR_BAUD_812500 SUFFIX=-812500
92 USE_STR2IND=1 SUFFIX=-s2i
93
94 TR_BAUD_CONFIG
95
96 The value of this symbol is an alphanumeric keyword of the form
97 TR_BAUD_xxxxxx; the default is TR_BAUD_115200. See
98 src/cs/drivers/drv_core/uart/traceswitch.h for the available baud rate
99 choices; the most practical use is setting TR_BAUD_CONFIG=TR_BAUD_812500
100 when you need to run the RVTMUX serial channel at the maximum possible
101 baud rate.
102
103 UI_CONFIG
104
105 The 3 allowed values for this setting are bigcolor, bigbw and 84x48,
106 selecting one of the 3 UI configurations supported by TI's code. The
107 default is 84x48 when the firmware is built for target c11x or c139,
108 and bigcolor otherwise.
109
110 USE_STR2IND
111
112 Unlike TI's original firmwares, we build without str2ind by default.
113 You can enable str2ind with USE_STR2IND=1, but the time to build the fw
114 will be significantly longer as the compiler has to be run twice for
115 each C source file, with str2ind sandwiched in between.
116
117 The following Bourne shell variables are used inside the build system in the
118 individual component build recipes (components/*) but cannot be set on the
119 ./configure.sh line because they are fixed in the overall fw build recipes
120 (configs/*):
121
122 GPRS
123
124 Self-explanatory: enables or disables GPRS.
125
126 MMI
127
128 TI's original config variable: MMI=0 for the AT-command-controlled
129 modem configuration or MMI=2 for the UI-enabled configuration with
130 BMI and MFW.
131
132 SRVC
133
134 TI's original config variable, selects the presence or absence of data
135 services other than GPRS as follows:
136
137 SRVC=0: voice and SMS only
138 SRVC=1: CSD and fax enabled
139 SRVC=2: CSD enabled, but not fax
140
141 Finally, CHIPSET, DSP, RF and AMR variables reflect the physical configuration
142 of the selected target hw that no amount of software hacking can change.
143 (The AMR variable indicates the presence or absence of AMR support in the DSP.)