|
1 // Copyright (c) 1996-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of the License "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // bootldr\src\ymodem.cpp |
|
15 // |
|
16 // |
|
17 |
|
18 #define FILE_ID 0x594D444D |
|
19 |
|
20 #include "bootldr.h" |
|
21 #include "ymodem.h" |
|
22 |
|
23 //#include <e32test.h> |
|
24 //GLREF_D RTest test; |
|
25 |
|
26 // Extra stuff to determine inner compression from the ROM header |
|
27 #include <e32rom.h> |
|
28 extern TInt memcmp1(const TUint8* aTrg, const TUint8* aSrc, TInt aLength); |
|
29 |
|
30 |
|
31 //const TInt KMaxRetries=10; |
|
32 const TInt KMaxRetries=KMaxTInt; |
|
33 |
|
34 static const TUint16 crcTab[256] = |
|
35 { |
|
36 0x0000,0x1021,0x2042,0x3063,0x4084,0x50a5,0x60c6,0x70e7,0x8108,0x9129,0xa14a, |
|
37 0xb16b,0xc18c,0xd1ad,0xe1ce,0xf1ef,0x1231,0x0210,0x3273,0x2252,0x52b5,0x4294, |
|
38 0x72f7,0x62d6,0x9339,0x8318,0xb37b,0xa35a,0xd3bd,0xc39c,0xf3ff,0xe3de,0x2462, |
|
39 0x3443,0x0420,0x1401,0x64e6,0x74c7,0x44a4,0x5485,0xa56a,0xb54b,0x8528,0x9509, |
|
40 0xe5ee,0xf5cf,0xc5ac,0xd58d,0x3653,0x2672,0x1611,0x0630,0x76d7,0x66f6,0x5695, |
|
41 0x46b4,0xb75b,0xa77a,0x9719,0x8738,0xf7df,0xe7fe,0xd79d,0xc7bc,0x48c4,0x58e5, |
|
42 0x6886,0x78a7,0x0840,0x1861,0x2802,0x3823,0xc9cc,0xd9ed,0xe98e,0xf9af,0x8948, |
|
43 0x9969,0xa90a,0xb92b,0x5af5,0x4ad4,0x7ab7,0x6a96,0x1a71,0x0a50,0x3a33,0x2a12, |
|
44 0xdbfd,0xcbdc,0xfbbf,0xeb9e,0x9b79,0x8b58,0xbb3b,0xab1a,0x6ca6,0x7c87,0x4ce4, |
|
45 0x5cc5,0x2c22,0x3c03,0x0c60,0x1c41,0xedae,0xfd8f,0xcdec,0xddcd,0xad2a,0xbd0b, |
|
46 0x8d68,0x9d49,0x7e97,0x6eb6,0x5ed5,0x4ef4,0x3e13,0x2e32,0x1e51,0x0e70,0xff9f, |
|
47 0xefbe,0xdfdd,0xcffc,0xbf1b,0xaf3a,0x9f59,0x8f78,0x9188,0x81a9,0xb1ca,0xa1eb, |
|
48 0xd10c,0xc12d,0xf14e,0xe16f,0x1080,0x00a1,0x30c2,0x20e3,0x5004,0x4025,0x7046, |
|
49 0x6067,0x83b9,0x9398,0xa3fb,0xb3da,0xc33d,0xd31c,0xe37f,0xf35e,0x02b1,0x1290, |
|
50 0x22f3,0x32d2,0x4235,0x5214,0x6277,0x7256,0xb5ea,0xa5cb,0x95a8,0x8589,0xf56e, |
|
51 0xe54f,0xd52c,0xc50d,0x34e2,0x24c3,0x14a0,0x0481,0x7466,0x6447,0x5424,0x4405, |
|
52 0xa7db,0xb7fa,0x8799,0x97b8,0xe75f,0xf77e,0xc71d,0xd73c,0x26d3,0x36f2,0x0691, |
|
53 0x16b0,0x6657,0x7676,0x4615,0x5634,0xd94c,0xc96d,0xf90e,0xe92f,0x99c8,0x89e9, |
|
54 0xb98a,0xa9ab,0x5844,0x4865,0x7806,0x6827,0x18c0,0x08e1,0x3882,0x28a3,0xcb7d, |
|
55 0xdb5c,0xeb3f,0xfb1e,0x8bf9,0x9bd8,0xabbb,0xbb9a,0x4a75,0x5a54,0x6a37,0x7a16, |
|
56 0x0af1,0x1ad0,0x2ab3,0x3a92,0xfd2e,0xed0f,0xdd6c,0xcd4d,0xbdaa,0xad8b,0x9de8, |
|
57 0x8dc9,0x7c26,0x6c07,0x5c64,0x4c45,0x3ca2,0x2c83,0x1ce0,0x0cc1,0xef1f,0xff3e, |
|
58 0xcf5d,0xdf7c,0xaf9b,0xbfba,0x8fd9,0x9ff8,0x6e17,0x7e36,0x4e55,0x5e74,0x2e93, |
|
59 0x3eb2,0x0ed1,0x1ef0 |
|
60 }; |
|
61 |
|
62 YModem::YModem(TBool aG) |
|
63 { |
|
64 iTimeout=2000000; |
|
65 iPacketSize=0; |
|
66 iInitChar=aG?BIGG:BIGC; |
|
67 iHeaderStored=EFalse; |
|
68 iImageDeflated=EFalse; |
|
69 } |
|
70 |
|
71 void YModem::UpdateCrc(const TUint8* aPtr, TInt aLength) |
|
72 // |
|
73 // Perform a CCITT CRC checksum. |
|
74 // |
|
75 { |
|
76 |
|
77 register const TUint8* pB=aPtr; |
|
78 register TUint16 crc=iCrc; |
|
79 while (aLength--) |
|
80 crc=TUint16((crc<<8)^crcTab[(crc>>8)^*pB++]); |
|
81 iCrc=crc; |
|
82 } |
|
83 |
|
84 TInt YModem::ReadPacket(TDes8& aDest) |
|
85 { |
|
86 TUint8* pD = (TUint8*)aDest.Ptr(); |
|
87 TInt r; |
|
88 TPtr8 d(pD, 0, 1); |
|
89 r = ReadBlock(d); |
|
90 if (r != KErrNone) |
|
91 return r; |
|
92 if (d.Length()==0) |
|
93 return KErrZeroLengthPacket; |
|
94 TUint8 b0 = *pD; |
|
95 if (b0==CAN) |
|
96 return KErrAbort; |
|
97 if (b0==EOT) |
|
98 return KErrEof; |
|
99 if (b0==SOH) |
|
100 iBlockSize=128; |
|
101 else if (b0==STX) |
|
102 iBlockSize=1024; |
|
103 else |
|
104 return KErrBadPacketType; |
|
105 iTimeout=5000000; |
|
106 iPacketSize = iBlockSize+5; |
|
107 d.Set(pD+1, 0, iPacketSize-1); |
|
108 r = ReadBlock(d); |
|
109 if (r!=KErrNone && r!=KErrTimedOut) |
|
110 return r; |
|
111 if (d.Length() < iPacketSize-1) |
|
112 return KErrPacketTooShort; |
|
113 TUint8 seq = pD[1]; |
|
114 TUint8 seqbar = pD[2]; |
|
115 seqbar^=seq; |
|
116 if (seqbar != 0xff) |
|
117 return KErrCorruptSequenceNumber; |
|
118 if (seq==iSeqNum) |
|
119 return KErrAlreadyExists; |
|
120 else |
|
121 { |
|
122 TUint8 nextseq=(TUint8)(iSeqNum+1); |
|
123 if (seq!=nextseq) |
|
124 return KErrWrongSequenceNumber; |
|
125 } |
|
126 iCrc=0; |
|
127 UpdateCrc(pD+3, iBlockSize); |
|
128 aDest.SetLength(iPacketSize); |
|
129 TUint16 rx_crc = (TUint16)((pD[iPacketSize-2]<<8) | pD[iPacketSize-1]); |
|
130 if (rx_crc != iCrc) |
|
131 return KErrBadCrc; |
|
132 ++iSeqNum; |
|
133 return KErrNone; |
|
134 } |
|
135 |
|
136 TInt YModem::CheckPacket(TUint8* aDest) |
|
137 { |
|
138 const TUint8* p=iPacketBuf.Ptr()+3; |
|
139 if (iState>0) |
|
140 memcpy(aDest, p, iBlockSize); |
|
141 else |
|
142 { |
|
143 // parse packet 0 |
|
144 TPtrC8 nameptr(p); |
|
145 TInt nLen=nameptr.Length(); |
|
146 if (nLen==0) |
|
147 return KErrSessionClosed; // batch termination packet |
|
148 iFileName.Copy(nameptr.Left(Min(nLen,iFileName.MaxLength()))); |
|
149 p+=nLen+1; |
|
150 iFileSize=0; |
|
151 for (;;) |
|
152 { |
|
153 TUint c=*p++; |
|
154 if (c<'0' || c>'9') |
|
155 break; |
|
156 iFileSize*=10; |
|
157 iFileSize+=c-'0'; |
|
158 } |
|
159 // test.Printf(_L("File %S, size %d\n"),&iFileName,iFileSize); |
|
160 } |
|
161 return KErrNone; |
|
162 } |
|
163 |
|
164 TInt YModem::ReadPackets(TUint8*& aDest, TInt aLength) |
|
165 { |
|
166 TInt l=0; |
|
167 TInt r=KErrNone; |
|
168 while(l<aLength || iState==0) |
|
169 { |
|
170 TInt retries=0; |
|
171 for(retries=0; retries<KMaxRetries; retries++) |
|
172 { |
|
173 if (iState==0) |
|
174 iTimeout=2000000, WriteC(iInitChar); |
|
175 r=ReadPacket(iPacketBuf); |
|
176 // test.Printf(_L("%d\n"),r); |
|
177 if (r==KErrTimedOut) |
|
178 continue; |
|
179 if (r==KErrNone) |
|
180 r=CheckPacket(aDest); |
|
181 if (r==KErrEof || r==KErrSessionClosed) |
|
182 break; |
|
183 if (r==KErrNone || r==KErrAlreadyExists) |
|
184 { |
|
185 if (r==KErrNone) |
|
186 iState++; |
|
187 if (iState>1) |
|
188 aDest+=iBlockSize; // don't store packet 0 |
|
189 if (iInitChar==BIGC) |
|
190 WriteC(ACK); |
|
191 if (iState==1) |
|
192 WriteC(iInitChar); // Send another 'C' after ACK |
|
193 if (r==KErrAlreadyExists) |
|
194 continue; |
|
195 break; |
|
196 } |
|
197 if (r==KErrAbort) |
|
198 break; |
|
199 if (iInitChar==BIGG) |
|
200 break; |
|
201 WriteC(NAK); |
|
202 } |
|
203 if (r==KErrNone) |
|
204 { |
|
205 if (iState>1) |
|
206 l+=iBlockSize; |
|
207 } |
|
208 else if (r==KErrSessionClosed) |
|
209 { |
|
210 if (iInitChar==BIGC) |
|
211 WriteC(ACK); |
|
212 break; |
|
213 } |
|
214 else if (r==KErrEof) |
|
215 { |
|
216 WriteC(ACK); // acknowledge end |
|
217 break; |
|
218 } |
|
219 else if (r!=KErrAbort) |
|
220 { |
|
221 WriteC(CAN); |
|
222 WriteC(CAN); |
|
223 WriteC(CAN); |
|
224 WriteC(CAN); |
|
225 WriteC(CAN); |
|
226 break; |
|
227 } |
|
228 } |
|
229 return r; |
|
230 } |
|
231 |
|
232 TInt YModem::StartDownload(TBool aG, TInt& aLength, TDes& aName) |
|
233 { |
|
234 TInt r; |
|
235 // iImageDeflated vaule is true iff the first call of StartDownload() |
|
236 // finished AND the ROM Image is deflated. |
|
237 // Practically when the CloseYModem() called. |
|
238 if (iImageDeflated) |
|
239 { |
|
240 // Read the rest of data to correctly finish Y-Modem protocol |
|
241 // This is necessary because the deflated ROM IMage size is not |
|
242 // aligned to 128 or 1024 byte boundary which are transfer block sizes |
|
243 // the Y-Modem protocol. |
|
244 // (reuse iHeaderBuf, because it is not necessary anymore) |
|
245 TUint8* pD=(TUint8*)iHeaderBuf.Ptr(); |
|
246 r=ReadPackets(pD, KHeaderBufferSize); |
|
247 DEBUG_PRINT((_L("Remaining data :%d, r:%d\r\n"), pD - iHeaderBuf.Ptr(), r )); |
|
248 } |
|
249 |
|
250 |
|
251 iInitChar=aG?BIGG:BIGC; |
|
252 iState=0; |
|
253 iSeqNum=255; |
|
254 TUint8* dummy=NULL; |
|
255 r=ReadPackets(dummy, 0); // read the file description packet |
|
256 if (r==KErrNone) |
|
257 { |
|
258 aLength=iFileSize; // return file name and file size |
|
259 aName=iFileName; |
|
260 } |
|
261 return r; |
|
262 } |
|
263 |
|
264 TInt YModem::GetInnerCompression(TBool &aImageDeflated, TBool &aRomLoaderHeaderExists) |
|
265 { |
|
266 // Read, analyse and buffer ROM Image Header |
|
267 |
|
268 DEBUG_PRINT((_L(">>YModem::GetInnerCompression()\r\n"))) |
|
269 // Try to read first 1k from the ROM Image |
|
270 iDataSizeInPuffer = KHeaderBufferSize; |
|
271 TUint8* pD=(TUint8*)iHeaderBuf.Ptr(); |
|
272 TInt r=ReadPackets(pD, iDataSizeInPuffer); |
|
273 |
|
274 DEBUG_PRINT((_L("r:%d (0x%08x).\r\n"), r, r)); |
|
275 DEBUG_PRINT((_L("pD->:0x%08x.\r\n"), (TUint8*)pD)); |
|
276 DEBUG_PRINT((_L("iHeaderBuf.Ptr()->:0x%08x.\r\n"), (TUint8*)iHeaderBuf.Ptr())); |
|
277 DEBUG_PRINT((_L("iDataSizeInPuffer:%d (0x%08x).\r\n"), iDataSizeInPuffer, iDataSizeInPuffer)); |
|
278 |
|
279 if( iDataSizeInPuffer != pD - iHeaderBuf.Ptr()) |
|
280 { |
|
281 BOOT_FAULT(); |
|
282 } |
|
283 |
|
284 |
|
285 // Analyse the inner compression method |
|
286 const TUint8 * romLoaderSignature1 = (const TUint8*)"EPOC"; |
|
287 const TUint8 * romLoaderSignature2 = (const TUint8*)"ROM"; |
|
288 pD = (TUint8*)iHeaderBuf.Ptr(); |
|
289 r = KErrNone; |
|
290 |
|
291 // Check headers |
|
292 TRomHeader* romHeader= (TRomHeader *)pD; |
|
293 DEBUG_PRINT((_L("pD ->:0x%08x.\r\n"), (TUint8*)pD)); |
|
294 DEBUG_PRINT((_L("romHeader->:0x%08x.\r\n"), (TUint8*)romHeader)); |
|
295 |
|
296 aRomLoaderHeaderExists = EFalse; |
|
297 |
|
298 if( !memcmp1(pD, romLoaderSignature1, 4) && !memcmp1((pD+8), romLoaderSignature2, 3) ) |
|
299 { |
|
300 // We have TRomLoaderHeader skip it |
|
301 romHeader = (TRomHeader *) (pD +TROM_LOADER_HEADER_SIZE); |
|
302 aRomLoaderHeaderExists = ETrue; |
|
303 } |
|
304 |
|
305 DEBUG_PRINT((_L("TRomLoaderHeader exists:%d.\r\n"), aRomLoaderHeaderExists)); |
|
306 DEBUG_PRINT((_L("romHeader->:0x%08x (0x%08x).\r\n"), (TUint8*)romHeader, (TUint8*)romHeader-pD)); |
|
307 |
|
308 if(romHeader->iCompressionType == 0 ) |
|
309 { |
|
310 aImageDeflated = EFalse; |
|
311 } |
|
312 else if (romHeader->iCompressionType == KUidCompressionDeflate ) |
|
313 { |
|
314 iImageDeflated = aImageDeflated = ETrue; |
|
315 } |
|
316 else |
|
317 { |
|
318 PrintToScreen(_L("Not supported compression method:0x%08x\r\n"), romHeader->iCompressionType); |
|
319 r = KErrNotSupported; |
|
320 } |
|
321 |
|
322 DEBUG_PRINT((_L("iCompressionType :0x%08x\r\n"), romHeader->iCompressionType)); |
|
323 DEBUG_PRINT((_L("iCompressedSize :0x%08x\r\n"), romHeader->iCompressedSize)); |
|
324 DEBUG_PRINT((_L("iUncompressedSize:0x%08x\r\n"), romHeader->iUncompressedSize)); |
|
325 // Buffer it. |
|
326 iHeaderStored = true; |
|
327 |
|
328 DEBUG_PRINT((_L("<<YModem::GetInnerCompression():%d\r\n"), r)) |
|
329 return r; |
|
330 } |
|
331 |
|
332 TInt YModem::GetHeaderBufferContent(TUint8*& aDest, TInt& aLength) |
|
333 { |
|
334 DEBUG_PRINT((_L(">>YModem::GetHeaderBufferContent(aDest:0c%08x, aLen:%d)\r\n"),aDest, aLength )); |
|
335 DEBUG_PRINT((_L("iDataSizeInPuffer :%d\r\n"), iDataSizeInPuffer)); |
|
336 if( aLength < iDataSizeInPuffer ) |
|
337 { |
|
338 const TUint8* p=iHeaderBuf.Ptr() + (KHeaderBufferSize - iDataSizeInPuffer); |
|
339 memcpy(aDest, p, aLength); |
|
340 iDataSizeInPuffer -= aLength; |
|
341 } |
|
342 else |
|
343 { |
|
344 const TUint8* p=iHeaderBuf.Ptr() + (KHeaderBufferSize - iDataSizeInPuffer); |
|
345 memcpy(aDest, p, iDataSizeInPuffer); |
|
346 aLength = iDataSizeInPuffer; |
|
347 iHeaderStored = false; |
|
348 } |
|
349 DEBUG_PRINT((_L("<<YModem::GetHeaderBufferContent(aDest:0c%08x, aLen:%d)\r\n"),aDest, aLength )); |
|
350 return KErrNone; |
|
351 } |
|
352 |
|
353 TBool YModem::IsHeaderStored(void) |
|
354 { |
|
355 return iHeaderStored; |
|
356 } |
|
357 |