annotate doc/D-Sample @ 600:8f50b202e81f

board preprocessor conditionals: prep for more FC hw in the future This change eliminates the CONFIG_TARGET_FCDEV3B preprocessor symbol and all preprocessor conditionals throughout the code base that tested for it, replacing them with CONFIG_TARGET_FCFAM or CONFIG_TARGET_FCMODEM. These new symbols are specified as follows: CONFIG_TARGET_FCFAM is intended to cover all hardware designs created by Mother Mychaela under the FreeCalypso trademark. This family will include modem products (repackagings of the FCDEV3B, possibly with RFFE or even RF transceiver changes), and also my desired FreeCalypso handset product. CONFIG_TARGET_FCMODEM is intended to cover all FreeCalypso modem products (which will be firmware-compatible with the FCDEV3B if they use TI Rita transceiver, or will require a different fw build if we switch to one of Silabs Aero transceivers), but not the handset product. Right now this CONFIG_TARGET_FCMODEM preprocessor symbol is used to conditionalize everything dealing with MCSI. At the present moment the future of FC hardware evolution is still unknown: it is not known whether we will ever have any beyond-FCDEV3B hardware at all (contingent on uncertain funding), and if we do produce further FC hardware designs, it is not known whether they will retain the same FIC modem core (triband), if we are going to have a quadband design that still retains the classic Rita transceiver, or if we are going to switch to Silabs Aero II or some other transceiver. If we produce a quadband modem that still uses Rita, it will run exactly the same fw as the FCDEV3B thanks to the way we define TSPACT signals for the RF_FAM=12 && CONFIG_TARGET_FCFAM combination, and the current fcdev3b build target will be renamed to fcmodem. OTOH, if that putative quadband modem will be Aero-based, then it will require a different fw build target, the fcdev3b target will stay as it is, and the two targets will both define CONFIG_TARGET_FCFAM and CONFIG_TARGET_FCMODEM, but will have different RF_FAM numbers. But no matter which way we are going to evolve, it is not right to have conditionals on CONFIG_TARGET_FCDEV3B in places like ACI, and the present change clears the way for future evolution.
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 01 Apr 2019 01:05:24 +0000
parents 4d4f0bba9469
children ed403a239ec6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
460
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 Back In The Day TI had an official and well-supported platform for Calypso
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 software development; this platform was called D-Sample. It consisted of a
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 development board with the Calypso+Iota chipset on it (as well as a GSM RF
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 section based on their older Clara RF transceiver chip) plus an attached test
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 handset. Here are some pictures:
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 https://www.freecalypso.org/members/falcon/pictures/D-Sample/
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 I (Mychaela) have managed to obtain one of these historical D-Sample kits (the
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 one pictured) back in 2015. Given that this D-Sample board was the original
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 and most native hw target for the TCS211 firmware program, and given that our
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 FreeCalypso Magnetite firmware project is essentially a resurrection and
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 continuation of that TCS211 fw program, I naturally have a strong desire to
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 have our firmware run on this board in its full glory like it once ran in the
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 offices or cubicles of TI's own software engineers who worked on various parts
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 of TCS211 fw for the Calypso.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 The current state of support is that we have everything other than the GSM radio
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 working. We are currently unable to bring up the radio tract on the D-Sample
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 board with our own Magnetite fw because of Clara RF: we only got a stripped
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 semi-src version of TCS211 in which the *.c files for L1 were censored out and
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 only *.obj blobs were supplied instead; the latter blobs target Rita RF and not
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 Clara. We have now successfully reconstructed the lost C sources for the RF-
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 independent and Rita-specific L1 modules, and we have l1_rf10.c for Clara RF
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 from the MV100 source fragments, but we are still missing the tpudrv10.c module
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 which is also required for Clara RF. Right now if one builds our current
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 Magnetite fw for target dsample, a placeholder stub version of tpudrv10.c is
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 used - it allows the firmware to link, but does not do any actual RF control,
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 thus any attempts to bring up the radio immediately fail.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 Despite having no working radio, everything else works: we can flash our own
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 Magnetite fw images into the board with our fc-loadtool (fc-host-tools-r8 or
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 later; earlier versions did not support the 28F640W30B flash chip correctly),
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 the SIM interface works, the audio subsystem driven by the Calypso DSP driven
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 by our reconstructed TCS211 L1 works (can make beeps through the loudspeaker in
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 the handset part of the kit), the handset keypad works, and when we run a
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 firmware image built with the UI layers enabled, the 176x220 pixel color UI
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 shows up on the big LCD. Because the SIM interface works, one can play with
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 this UI a fair bit despite having no working GSM radio: the UI behaves the same
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 way as any regular phone would in the absence of coverage, so one can step
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 through the menus, read SIM phonebook entries and stored messages.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 Apparent hardware defect in our D-Sample LCD
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44 ============================================
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 The one specific D-Sample board we have managed to score (might be the last one
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 left in the world, who knows) appears to be an early board: it is PCB rev 3,
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48 but it has an early C05 version of the Calypso chip (F741979B), and it was made
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49 some time in 2002. It came flashed with a firmware image built on 20020917,
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 and this original image it came with did not light up the LCD at all - it only
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51 responded to AT commands. (Examination of that fw image suggests that it has
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52 SMI instead of BMI+MFW, but I am not familiar with SMI at all - all I can tell
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
53 is that it behaves functionally as if it were an ACI build.) Thus the LCD part
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
54 of this D-Sample hardware only got exercised for the first time when I ran our
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
55 own Magnetite fw on it, and it exhibits some strange behaviour which I can only
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
56 attribute to a hardware problem.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
57
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
58 The symptom is that the picture on the LCD sometimes appears garbled, and
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59 whether or not this LCD garbling happens (and if it does happen, how severely)
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
60 appears to depend on the picture content. Furthermore, the dependency is not
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
61 only on the picture content, but seemingly also on some law of chance, as the
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
62 same picture can get garbled more or less severely at different times. Closer
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
63 examination of exactly how the picture is garbled reveals that the misbehaviour
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
64 appears to be some kind of double latching of write data inside the LCD module.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
65
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
66 The R2D driver maintains a software framebuffer in the r2d_lcd_memory_words[]
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
67 array, and the r2d_refresh() function transfers the picture in this software
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
68 FB to the hardware FB inside the LCD module by sequentially writing 176*220
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
69 16-bit words into a fixed ARM7 memory address in the nCS3 range, causing a
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
70 write cycle to be issued to the LCD module for each pixel. When a garbled
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
71 picture appears on the physical LCD, the picture maintained by the software in
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
72 the r2d_lcd_memory_words[] array is correct (not garbled) as revealed by
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
73 reading that array memory out via ETM memory read commands (see the tools in
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
74 the freecalypso-ui-dev repository), and the picture on the physical LCD is
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
75 garbled in such a way that it appears that at some point when the firmware sent
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
76 a single pixel to it, the LCD module erroneously registered a double write,
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
77 incrementing the internal FB RAM pointer by two pixels instead of one, with all
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
78 subsequent pixels shifted accordingly. The picture can be garbled more or less
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
79 severely depending on how many pixels in the picture trigger this apparent
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
80 double write effect.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
81
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
82 The end result is that even though we have a real TI-made D-Sample hardware kit,
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
83 its usefulness to us for FreeCalypso UI development is rather limited because
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
84 of both the lack of tpudrv10.c code resulting in no working GSM radio and the
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
85 apparent hardware problem with the LCD module in the handset part of the kit.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
86
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
87 The Mother's plan is to design and build our own UI development board to take
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
88 the place of TI's D-Sample, combining the good version of the Calypso+Iota+Rita
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
89 chipset for which we have good fw support with a 176x220 pix color LCD of our
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
90 own - it is one of the industry standard sizes, so it should only be a matter
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
91 of getting a semi-custom one with the right interface (16-bit parallel) and the
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
92 right polarizer orientation (6 o'clock viewing direction). The proposed board
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
93 would be a derivative of our current FCDEV3B, keeping the core Calypso+RF block
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
94 (originally from Openmoko) completely unchanged, but adding the LCD, the keypad
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
95 buttons and other handset peripherals, resulting in a Handset Motherboard
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
96 Prototype - HSMBP.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
97
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
98 Different Calypso silicon versions
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
99 ==================================
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
100
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
101 Because the D-Sample was a development board rather than a commercial end user
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
102 product, different D-Sample boards at different points in time had different
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
103 versions of the Calypso chip populated on them as the Calypso silicon itself
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
104 evolved. The board we got appears to be an early one, as it has Calypso chip
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
105 version F741979B on it (C05 rev B, DSP ROM version 3311), but I can only reason
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
106 that later D-Sample boards must have had Calypso C035 chips on them, either the
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
107 original Calypso C035 with DSP ROM version 3416 or the final silicon with DSP
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
108 ROM version 3606.
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
109
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
110 Because we only have one D-Sample board and we have no idea whether or not there
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
111 are any other DS boards out there in the world (ours may well be the world's
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
112 last remaining unit), our current build system is set up to target only one
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
113 D-Sample version, the one we've got: CHIPSET=8, DSP=33 for Calypso C05 rev B
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
114 silicon. If anyone else in the world has another D-Sample board and it has a
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
115 different Calypso chip version on it, if you would like to run our FC Magnetite
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
116 firmware on it, you will need to edit the targets/dsample.conf source file
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
117 (it's a Bourne shell script fragment sourced by configure.sh) and set the
4d4f0bba9469 doc/D-Sample written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
118 CHIPSET and DSP settings correctly for your Calypso chip version.