Project

General

Profile

BCM4751 » History » Version 28

Wolfgang Wiedmeyer, 05/27/2017 01:22 AM
add link to feature request

1 24 Paul Kocialkowski
h1. BCM4751
2 1 Paul Kocialkowski
3 28 Wolfgang Wiedmeyer
corresponding feature request: #1473
4
5 9 Paul Kocialkowski
h2. Factory image files
6 1 Paul Kocialkowski
7 2 Paul Kocialkowski
The non-free files holding the GPS infos/code are the following:
8 1 Paul Kocialkowski
<pre>
9
/system/vendor/bin/gpsd
10
/system/vendor/lib/hw/gps.s5pc110.so
11
/system/vendor/etc/gps.xml
12
/system/etc/gps.conf
13
</pre>
14
15 9 Paul Kocialkowski
h3. gps.xml parameters 
16
17
We have tried to change some parameters in gps.xml to see how it behaves:
18
19
|_. Parameter |_. Original |_. Changed to |_. Result |
20
| acPortName | /dev/s3c2410_serial1 | /dev/s3c2410_serial42 | The chip wasn't "booted" |
21
| gpioNStdbyPath | /sys/class/sec/gps/GPS_PWR_EN/value | /sys/class/sec/gps/GPS_PWR_EN/value2 | The chip was booted |
22
| gpioNResetPath | /sys/class/sec/gps/GPS_nRST/value | /sys/class/sec/gps/GPS_nRST/value2 | The chip was booted |
23
24
After all, it seems that when the gpsd binary is running without the gps.s5pc110.so library, the chip isn't started (our test utility doesn't work) whereas when the library is running and connects to the socket when it is created by starting gpsd, the chip is booted. 
25
26
gps.s5pc110.so will actually order bootup via the socket, when the gps is requested by the Android framework. When it's not used anymore, it will request poweroff as well.
27
28 1 Paul Kocialkowski
h2. Protocol
29
30 9 Paul Kocialkowski
According to the logs obtained from gpsd, the chip seems to be using the MEIF protocol at first, then a patch is sent and it starts using another protocol, which doesn't seem related to MEIF according to the logs (there are basically no more references to MEIF after uploading the patch). However, as we have no information about what MEIF is (it's a binary proprietary undocumented protocol), these are just guesses.
31
We decided to implement the first protocol under the name MEIF, but it could also be some sort of BCM4751-specific bootloader protocol that is in charge of making the patch upload.
32 1 Paul Kocialkowski
33 9 Paul Kocialkowski
The GPSD component is in charge of translating the second protocl to standard NMEA that is sent to the gps.s5pc110.so lib via the /dev/socket/gps Unix socket, created by GPSD.
34 1 Paul Kocialkowski
35 9 Paul Kocialkowski
h2. Devices
36 1 Paul Kocialkowski
37 9 Paul Kocialkowski
Here is a list of the devices that are known to use the BCM4751 chip:
38 1 Paul Kocialkowski
39 9 Paul Kocialkowski
|_. Device |_. Vendor |_. BCM4751 revision |
40 16 Denis 'GNUtoo' Carikli
| Nexus S | Google/Samsung | 4751A1 or 4751A2 |
41 9 Paul Kocialkowski
| Galaxy S I9000 | Samsung | 4751A2 |
42
| Galaxy Tab P1000 | Samsung | ? |
43 14 Paul Kocialkowski
| Galaxy Tab 8.9 P7300/P7310 | Samsung | 4751A2 |
44 9 Paul Kocialkowski
| Nexus 7 | Google/Asus | ? |
45 1 Paul Kocialkowski
46 15 Paul Kocialkowski
The bCM4751 chip exists under the following revisions: 4751A0, 4751A1, 4751A2, 47511A0
47
48 9 Paul Kocialkowski
h2. Free software implementation
49 1 Paul Kocialkowski
50 9 Paul Kocialkowski
On January 2012, the work to write a free software implementation that could handle the BCM4751 chip was started.
51
The main target is the Nexus S, even though it should work with few changes on other BCM4751 devices.
52 1 Paul Kocialkowski
53 26 Wolfgang Wiedmeyer
The source code is available at: https://git.replicant.us/PaulK/bcm4751/
54 1 Paul Kocialkowski
55 9 Paul Kocialkowski
h3. Current status
56 1 Paul Kocialkowski
57 9 Paul Kocialkowski
|_. Part |_. Status |_. Comments |
58 27 Wolfgang Wiedmeyer
| Serial setup | "DONE":https://git.replicant.us/PaulK/bcm4751/commit/e4f94e901b9b4c5fef5642ad9580863fc2bfe336 | Magic is: @termios.c_cflag = 0x800018b2;@ |
59
| MEIF parsing | "DONE":https://git.replicant.us/PaulK/bcm4751/commit/927c1c92dd092cec8c56351bf663101183f19076 | |
60
| MEIF dispatch | "DONE":https://git.replicant.us/PaulK/bcm4751/commit/f952dde8f3a29634be1c8fa19b8eed367c1ad878 | |
61
| MEIF patch upload | "DONE":https://git.replicant.us/PaulK/bcm4751/commit/9a5827778189b7e0f91879430a4e160567ee6bbd | Nexus S and Galaxy S patches differ |
62 1 Paul Kocialkowski
63 9 Paul Kocialkowski
h3. Utilities
64
65
|_. Name |_. Task |_. Arguments |
66
| bcm4751_gpsd | Main utility, boots the chip, send the patch, switch protocol | None |
67
| bcm4751_test | Deprecated utility, can be used for poweroff | @stop@: poweroff the chip |
68
| bcm4751_hal | Acts as the framework: permits to trace gps.s5pc110.so | None |
69
| bcm4751_daemon | Acts as (a fake) gpsd to the lib | None |
70
| bcm4751_lib | Acts as (a fake) lib to gpsd | None |
71
72
h3. BCM4751 gpsd
73
74
This is where MEIF is implemented. It currently does the following:
75
* Serial setup
76
* Autobaud
77
* MEIF reader loop
78
* MEIF parsing
79
* MEIF dispatch
80
* MEIF patch upload
81
* Protocol switch (sends unknown bytes in the second protocol to get a response)
82
* Response dump
83
84
Sample output log:
85 1 Paul Kocialkowski
<pre>
86 9 Paul Kocialkowski
Turning the GPS on...
87
Opening the GPS serial...
88
Sending autobaud...
89
Read 17 bytes
90
Read 32 bytes
91
MEIF message: MEIF_STATE_REPORT_MSG with 18 bytes of data:
92
[0000]   01 00 00 00 01 00 00 00   00 00 00 00 00 00 00 00   ........ ........
93
[0010]   1A 00                                               ..
94
Got a STATE_REPORT message
95 1 Paul Kocialkowski
96 9 Paul Kocialkowski
Read 23 bytes
97
Read 32 bytes
98
Read 16 bytes
99
Read 7 bytes
100
MEIF message: MEIF_CONFIG_VALUES_MSG with 70 bytes of data:
101
[0000]   02 00 01 00 01 00 40 00   01 00 02 00 00 00 00 00   ........ ........
102
[0010]   01 00 02 00 00 00 00 00   00 00 06 00 81 11 00 09   ........ ........
103
[0020]   07 07 D9 07 42 52 4F 41   44 43 4F 4D 00 00 00 00   ....BROA DCOM....
104
[0030]   00 00 00 00 34 37 35 31   41 31 00 00 00 00 00 00   ....4751 A1......
105
[0040]   00 00 00 00 B3 05                                   ......
106
Got config values:
107
	vendor: BROADCOM
108
	product: 4751A1
109
110
Sending the first part of the patch...
111
Sending 2054 bytes!
112
MEIF message: MEIF_SEND_PATCH_MSG with 2046 bytes of data:
113
114
Read 14 bytes
115
MEIF message: MEIF_NACK_MSG with 6 bytes of data:
116
[0000]   03 00 03 00 0F 00                                   ......
117
Got a NACK message
118
Reason is: MEIF_NACK_GARBAGE_RECEIVED
119
120
Read 12 bytes
121
MEIF message: MEIF_ACK_MSG with 4 bytes of data:
122
[0000]   04 01 0B 00                                         ....
123
Got an ACK message
124
125
Sending the second part of the patch...
126
Sending 706 bytes!
127
MEIF message: MEIF_SEND_PATCH_MSG with 698 bytes of data:
128
129
Read 12 bytes
130
MEIF message: MEIF_ACK_MSG with 4 bytes of data:
131
[0000]   05 02 0D 00                                         ....
132
Got an ACK message
133
134
Ready to switch protocol!
135
Sending unknown bytes!
136
Read 12 bytes:
137
[0000]   FE 00 FD 40 00 00 F1 B1   12 20 67 FC               ........ ..g.
138
</pre>
139 1 Paul Kocialkowski
140 10 Paul Kocialkowski
h3. BCM4751 patch
141
142
In order to use the same protocol as the non-free gpsd, a patch needs to be sent. It is hardcoded in the non-free gpsd binary.
143
Note that we don't know what that patch exactly is nor what it does. In any case, it must be considered as the propriety of Broadcom (or Samsung maybe) and falls under the non-free gpsd license.
144
145
Here are notes on how to extract the patch from various non-free gpsd binaries:
146 13 Paul Kocialkowski
|_. Device |_. Source |_. GPSD MD5 |_. Offset |_. Length |_. dd command |
147
| Nexus S | CM 9.0.0 | 4a6c0027e530b5b8a346153a355ef8e3 | 0x15DDEA | 2738 bytes | dd skip=1433066 count=2738 if=gpsd of=bcm4751a1.fw bs=1 |
148
| Galaxy S | CM 9.1.0 | 4a6c0027e530b5b8a346153a355ef8e3 | 0x15E89E | 6406 bytes | dd skip=1435806 count=6406 if=gpsd of=bcm4751a2.fw bs=1 |
149 10 Paul Kocialkowski
150 13 Paul Kocialkowski
The @bcm4751_gpsd@ utility will attempt to read the patch from @/data/bcm4751a1.fw@ or @/data/bcm4751a2.fw@
151 10 Paul Kocialkowski
152 18 Denis 'GNUtoo' Carikli
h4. Post protocol switching
153
154 20 Denis 'GNUtoo' Carikli
Sending this string:
155
"\xfe\x00\xfd\x6f\x3a\x01\x00\x00\x00\x00\x34\xfc"
156
many times makes some other string appear on the serial port...
157 17 Denis 'GNUtoo' Carikli
<pre>
158 20 Denis 'GNUtoo' Carikli
fe 00 fd 0f ff 07 06 00 00 01 54 fc
159
fe 00 fd 0f ff 08 06 00 00 01 1c fc
160
</pre>
161
Here's the decoding of the first bytes:
162
<pre>
163 17 Denis 'GNUtoo' Carikli
ff00 = 8bytes
164
fe00 = 12bytes
165
fe01 = 16bytes
166
fe02 = 20bytes
167
fe03 = 24bytes
168
fe04 = 28bytes
169
fe05 = 32bytes
170
fe06 = 36bytes
171
fe07 = 40bytes
172
</pre>
173 20 Denis 'GNUtoo' Carikli
174 22 Denis 'GNUtoo' Carikli
 * fc seem an end marker and 54/c1 a checksum....
175 23 Denis 'GNUtoo' Carikli
 * 07,08 seem a sequence number, if I do it right after booting the chip it starts with 01
176 21 Denis 'GNUtoo' Carikli
177
h5. howto
178
run that python program:
179
<pre>
180
print "\xfe\x00\xfd\x6f\x3a\x01\x00\x00\x00\x00\x34\xfc"
181
</pre>
182
like that
183 22 Denis 'GNUtoo' Carikli
<pre>python foo.py > serial.txt</pre>
184 21 Denis 'GNUtoo' Carikli
<pre>adb push serial.txt /sdcard/</pre>
185
on target:
186
<pre>hexdump -C /dev/s3c2410_serial1</pre>
187
<pre>cat /sdcard/serial.txt > /dev/s3c2410_serial1</pre>