1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/kernelhwsrv/brdbootldr/ubootldr/ymodem.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,357 @@
1.4 +// Copyright (c) 1996-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// bootldr\src\ymodem.cpp
1.18 +//
1.19 +//
1.20 +
1.21 +#define FILE_ID 0x594D444D
1.22 +
1.23 +#include "bootldr.h"
1.24 +#include "ymodem.h"
1.25 +
1.26 +//#include <e32test.h>
1.27 +//GLREF_D RTest test;
1.28 +
1.29 +// Extra stuff to determine inner compression from the ROM header
1.30 +#include <e32rom.h>
1.31 +extern TInt memcmp1(const TUint8* aTrg, const TUint8* aSrc, TInt aLength);
1.32 +
1.33 +
1.34 +//const TInt KMaxRetries=10;
1.35 +const TInt KMaxRetries=KMaxTInt;
1.36 +
1.37 +static const TUint16 crcTab[256] =
1.38 + {
1.39 + 0x0000,0x1021,0x2042,0x3063,0x4084,0x50a5,0x60c6,0x70e7,0x8108,0x9129,0xa14a,
1.40 + 0xb16b,0xc18c,0xd1ad,0xe1ce,0xf1ef,0x1231,0x0210,0x3273,0x2252,0x52b5,0x4294,
1.41 + 0x72f7,0x62d6,0x9339,0x8318,0xb37b,0xa35a,0xd3bd,0xc39c,0xf3ff,0xe3de,0x2462,
1.42 + 0x3443,0x0420,0x1401,0x64e6,0x74c7,0x44a4,0x5485,0xa56a,0xb54b,0x8528,0x9509,
1.43 + 0xe5ee,0xf5cf,0xc5ac,0xd58d,0x3653,0x2672,0x1611,0x0630,0x76d7,0x66f6,0x5695,
1.44 + 0x46b4,0xb75b,0xa77a,0x9719,0x8738,0xf7df,0xe7fe,0xd79d,0xc7bc,0x48c4,0x58e5,
1.45 + 0x6886,0x78a7,0x0840,0x1861,0x2802,0x3823,0xc9cc,0xd9ed,0xe98e,0xf9af,0x8948,
1.46 + 0x9969,0xa90a,0xb92b,0x5af5,0x4ad4,0x7ab7,0x6a96,0x1a71,0x0a50,0x3a33,0x2a12,
1.47 + 0xdbfd,0xcbdc,0xfbbf,0xeb9e,0x9b79,0x8b58,0xbb3b,0xab1a,0x6ca6,0x7c87,0x4ce4,
1.48 + 0x5cc5,0x2c22,0x3c03,0x0c60,0x1c41,0xedae,0xfd8f,0xcdec,0xddcd,0xad2a,0xbd0b,
1.49 + 0x8d68,0x9d49,0x7e97,0x6eb6,0x5ed5,0x4ef4,0x3e13,0x2e32,0x1e51,0x0e70,0xff9f,
1.50 + 0xefbe,0xdfdd,0xcffc,0xbf1b,0xaf3a,0x9f59,0x8f78,0x9188,0x81a9,0xb1ca,0xa1eb,
1.51 + 0xd10c,0xc12d,0xf14e,0xe16f,0x1080,0x00a1,0x30c2,0x20e3,0x5004,0x4025,0x7046,
1.52 + 0x6067,0x83b9,0x9398,0xa3fb,0xb3da,0xc33d,0xd31c,0xe37f,0xf35e,0x02b1,0x1290,
1.53 + 0x22f3,0x32d2,0x4235,0x5214,0x6277,0x7256,0xb5ea,0xa5cb,0x95a8,0x8589,0xf56e,
1.54 + 0xe54f,0xd52c,0xc50d,0x34e2,0x24c3,0x14a0,0x0481,0x7466,0x6447,0x5424,0x4405,
1.55 + 0xa7db,0xb7fa,0x8799,0x97b8,0xe75f,0xf77e,0xc71d,0xd73c,0x26d3,0x36f2,0x0691,
1.56 + 0x16b0,0x6657,0x7676,0x4615,0x5634,0xd94c,0xc96d,0xf90e,0xe92f,0x99c8,0x89e9,
1.57 + 0xb98a,0xa9ab,0x5844,0x4865,0x7806,0x6827,0x18c0,0x08e1,0x3882,0x28a3,0xcb7d,
1.58 + 0xdb5c,0xeb3f,0xfb1e,0x8bf9,0x9bd8,0xabbb,0xbb9a,0x4a75,0x5a54,0x6a37,0x7a16,
1.59 + 0x0af1,0x1ad0,0x2ab3,0x3a92,0xfd2e,0xed0f,0xdd6c,0xcd4d,0xbdaa,0xad8b,0x9de8,
1.60 + 0x8dc9,0x7c26,0x6c07,0x5c64,0x4c45,0x3ca2,0x2c83,0x1ce0,0x0cc1,0xef1f,0xff3e,
1.61 + 0xcf5d,0xdf7c,0xaf9b,0xbfba,0x8fd9,0x9ff8,0x6e17,0x7e36,0x4e55,0x5e74,0x2e93,
1.62 + 0x3eb2,0x0ed1,0x1ef0
1.63 + };
1.64 +
1.65 +YModem::YModem(TBool aG)
1.66 + {
1.67 + iTimeout=2000000;
1.68 + iPacketSize=0;
1.69 + iInitChar=aG?BIGG:BIGC;
1.70 + iHeaderStored=EFalse;
1.71 + iImageDeflated=EFalse;
1.72 + }
1.73 +
1.74 +void YModem::UpdateCrc(const TUint8* aPtr, TInt aLength)
1.75 +//
1.76 +// Perform a CCITT CRC checksum.
1.77 +//
1.78 + {
1.79 +
1.80 + register const TUint8* pB=aPtr;
1.81 + register TUint16 crc=iCrc;
1.82 + while (aLength--)
1.83 + crc=TUint16((crc<<8)^crcTab[(crc>>8)^*pB++]);
1.84 + iCrc=crc;
1.85 + }
1.86 +
1.87 +TInt YModem::ReadPacket(TDes8& aDest)
1.88 + {
1.89 + TUint8* pD = (TUint8*)aDest.Ptr();
1.90 + TInt r;
1.91 + TPtr8 d(pD, 0, 1);
1.92 + r = ReadBlock(d);
1.93 + if (r != KErrNone)
1.94 + return r;
1.95 + if (d.Length()==0)
1.96 + return KErrZeroLengthPacket;
1.97 + TUint8 b0 = *pD;
1.98 + if (b0==CAN)
1.99 + return KErrAbort;
1.100 + if (b0==EOT)
1.101 + return KErrEof;
1.102 + if (b0==SOH)
1.103 + iBlockSize=128;
1.104 + else if (b0==STX)
1.105 + iBlockSize=1024;
1.106 + else
1.107 + return KErrBadPacketType;
1.108 + iTimeout=5000000;
1.109 + iPacketSize = iBlockSize+5;
1.110 + d.Set(pD+1, 0, iPacketSize-1);
1.111 + r = ReadBlock(d);
1.112 + if (r!=KErrNone && r!=KErrTimedOut)
1.113 + return r;
1.114 + if (d.Length() < iPacketSize-1)
1.115 + return KErrPacketTooShort;
1.116 + TUint8 seq = pD[1];
1.117 + TUint8 seqbar = pD[2];
1.118 + seqbar^=seq;
1.119 + if (seqbar != 0xff)
1.120 + return KErrCorruptSequenceNumber;
1.121 + if (seq==iSeqNum)
1.122 + return KErrAlreadyExists;
1.123 + else
1.124 + {
1.125 + TUint8 nextseq=(TUint8)(iSeqNum+1);
1.126 + if (seq!=nextseq)
1.127 + return KErrWrongSequenceNumber;
1.128 + }
1.129 + iCrc=0;
1.130 + UpdateCrc(pD+3, iBlockSize);
1.131 + aDest.SetLength(iPacketSize);
1.132 + TUint16 rx_crc = (TUint16)((pD[iPacketSize-2]<<8) | pD[iPacketSize-1]);
1.133 + if (rx_crc != iCrc)
1.134 + return KErrBadCrc;
1.135 + ++iSeqNum;
1.136 + return KErrNone;
1.137 + }
1.138 +
1.139 +TInt YModem::CheckPacket(TUint8* aDest)
1.140 + {
1.141 + const TUint8* p=iPacketBuf.Ptr()+3;
1.142 + if (iState>0)
1.143 + memcpy(aDest, p, iBlockSize);
1.144 + else
1.145 + {
1.146 + // parse packet 0
1.147 + TPtrC8 nameptr(p);
1.148 + TInt nLen=nameptr.Length();
1.149 + if (nLen==0)
1.150 + return KErrSessionClosed; // batch termination packet
1.151 + iFileName.Copy(nameptr.Left(Min(nLen,iFileName.MaxLength())));
1.152 + p+=nLen+1;
1.153 + iFileSize=0;
1.154 + for (;;)
1.155 + {
1.156 + TUint c=*p++;
1.157 + if (c<'0' || c>'9')
1.158 + break;
1.159 + iFileSize*=10;
1.160 + iFileSize+=c-'0';
1.161 + }
1.162 +// test.Printf(_L("File %S, size %d\n"),&iFileName,iFileSize);
1.163 + }
1.164 + return KErrNone;
1.165 + }
1.166 +
1.167 +TInt YModem::ReadPackets(TUint8*& aDest, TInt aLength)
1.168 + {
1.169 + TInt l=0;
1.170 + TInt r=KErrNone;
1.171 + while(l<aLength || iState==0)
1.172 + {
1.173 + TInt retries=0;
1.174 + for(retries=0; retries<KMaxRetries; retries++)
1.175 + {
1.176 + if (iState==0)
1.177 + iTimeout=2000000, WriteC(iInitChar);
1.178 + r=ReadPacket(iPacketBuf);
1.179 +// test.Printf(_L("%d\n"),r);
1.180 + if (r==KErrTimedOut)
1.181 + continue;
1.182 + if (r==KErrNone)
1.183 + r=CheckPacket(aDest);
1.184 + if (r==KErrEof || r==KErrSessionClosed)
1.185 + break;
1.186 + if (r==KErrNone || r==KErrAlreadyExists)
1.187 + {
1.188 + if (r==KErrNone)
1.189 + iState++;
1.190 + if (iState>1)
1.191 + aDest+=iBlockSize; // don't store packet 0
1.192 + if (iInitChar==BIGC)
1.193 + WriteC(ACK);
1.194 + if (iState==1)
1.195 + WriteC(iInitChar); // Send another 'C' after ACK
1.196 + if (r==KErrAlreadyExists)
1.197 + continue;
1.198 + break;
1.199 + }
1.200 + if (r==KErrAbort)
1.201 + break;
1.202 + if (iInitChar==BIGG)
1.203 + break;
1.204 + WriteC(NAK);
1.205 + }
1.206 + if (r==KErrNone)
1.207 + {
1.208 + if (iState>1)
1.209 + l+=iBlockSize;
1.210 + }
1.211 + else if (r==KErrSessionClosed)
1.212 + {
1.213 + if (iInitChar==BIGC)
1.214 + WriteC(ACK);
1.215 + break;
1.216 + }
1.217 + else if (r==KErrEof)
1.218 + {
1.219 + WriteC(ACK); // acknowledge end
1.220 + break;
1.221 + }
1.222 + else if (r!=KErrAbort)
1.223 + {
1.224 + WriteC(CAN);
1.225 + WriteC(CAN);
1.226 + WriteC(CAN);
1.227 + WriteC(CAN);
1.228 + WriteC(CAN);
1.229 + break;
1.230 + }
1.231 + }
1.232 + return r;
1.233 + }
1.234 +
1.235 +TInt YModem::StartDownload(TBool aG, TInt& aLength, TDes& aName)
1.236 + {
1.237 + TInt r;
1.238 + // iImageDeflated vaule is true iff the first call of StartDownload()
1.239 + // finished AND the ROM Image is deflated.
1.240 + // Practically when the CloseYModem() called.
1.241 + if (iImageDeflated)
1.242 + {
1.243 + // Read the rest of data to correctly finish Y-Modem protocol
1.244 + // This is necessary because the deflated ROM IMage size is not
1.245 + // aligned to 128 or 1024 byte boundary which are transfer block sizes
1.246 + // the Y-Modem protocol.
1.247 + // (reuse iHeaderBuf, because it is not necessary anymore)
1.248 + TUint8* pD=(TUint8*)iHeaderBuf.Ptr();
1.249 + r=ReadPackets(pD, KHeaderBufferSize);
1.250 + DEBUG_PRINT((_L("Remaining data :%d, r:%d\r\n"), pD - iHeaderBuf.Ptr(), r ));
1.251 + }
1.252 +
1.253 +
1.254 + iInitChar=aG?BIGG:BIGC;
1.255 + iState=0;
1.256 + iSeqNum=255;
1.257 + TUint8* dummy=NULL;
1.258 + r=ReadPackets(dummy, 0); // read the file description packet
1.259 + if (r==KErrNone)
1.260 + {
1.261 + aLength=iFileSize; // return file name and file size
1.262 + aName=iFileName;
1.263 + }
1.264 + return r;
1.265 + }
1.266 +
1.267 +TInt YModem::GetInnerCompression(TBool &aImageDeflated, TBool &aRomLoaderHeaderExists)
1.268 + {
1.269 + // Read, analyse and buffer ROM Image Header
1.270 +
1.271 + DEBUG_PRINT((_L(">>YModem::GetInnerCompression()\r\n")))
1.272 + // Try to read first 1k from the ROM Image
1.273 + iDataSizeInPuffer = KHeaderBufferSize;
1.274 + TUint8* pD=(TUint8*)iHeaderBuf.Ptr();
1.275 + TInt r=ReadPackets(pD, iDataSizeInPuffer);
1.276 +
1.277 + DEBUG_PRINT((_L("r:%d (0x%08x).\r\n"), r, r));
1.278 + DEBUG_PRINT((_L("pD->:0x%08x.\r\n"), (TUint8*)pD));
1.279 + DEBUG_PRINT((_L("iHeaderBuf.Ptr()->:0x%08x.\r\n"), (TUint8*)iHeaderBuf.Ptr()));
1.280 + DEBUG_PRINT((_L("iDataSizeInPuffer:%d (0x%08x).\r\n"), iDataSizeInPuffer, iDataSizeInPuffer));
1.281 +
1.282 + if( iDataSizeInPuffer != pD - iHeaderBuf.Ptr())
1.283 + {
1.284 + BOOT_FAULT();
1.285 + }
1.286 +
1.287 +
1.288 + // Analyse the inner compression method
1.289 + const TUint8 * romLoaderSignature1 = (const TUint8*)"EPOC";
1.290 + const TUint8 * romLoaderSignature2 = (const TUint8*)"ROM";
1.291 + pD = (TUint8*)iHeaderBuf.Ptr();
1.292 + r = KErrNone;
1.293 +
1.294 + // Check headers
1.295 + TRomHeader* romHeader= (TRomHeader *)pD;
1.296 + DEBUG_PRINT((_L("pD ->:0x%08x.\r\n"), (TUint8*)pD));
1.297 + DEBUG_PRINT((_L("romHeader->:0x%08x.\r\n"), (TUint8*)romHeader));
1.298 +
1.299 + aRomLoaderHeaderExists = EFalse;
1.300 +
1.301 + if( !memcmp1(pD, romLoaderSignature1, 4) && !memcmp1((pD+8), romLoaderSignature2, 3) )
1.302 + {
1.303 + // We have TRomLoaderHeader skip it
1.304 + romHeader = (TRomHeader *) (pD +TROM_LOADER_HEADER_SIZE);
1.305 + aRomLoaderHeaderExists = ETrue;
1.306 + }
1.307 +
1.308 + DEBUG_PRINT((_L("TRomLoaderHeader exists:%d.\r\n"), aRomLoaderHeaderExists));
1.309 + DEBUG_PRINT((_L("romHeader->:0x%08x (0x%08x).\r\n"), (TUint8*)romHeader, (TUint8*)romHeader-pD));
1.310 +
1.311 + if(romHeader->iCompressionType == 0 )
1.312 + {
1.313 + aImageDeflated = EFalse;
1.314 + }
1.315 + else if (romHeader->iCompressionType == KUidCompressionDeflate )
1.316 + {
1.317 + iImageDeflated = aImageDeflated = ETrue;
1.318 + }
1.319 + else
1.320 + {
1.321 + PrintToScreen(_L("Not supported compression method:0x%08x\r\n"), romHeader->iCompressionType);
1.322 + r = KErrNotSupported;
1.323 + }
1.324 +
1.325 + DEBUG_PRINT((_L("iCompressionType :0x%08x\r\n"), romHeader->iCompressionType));
1.326 + DEBUG_PRINT((_L("iCompressedSize :0x%08x\r\n"), romHeader->iCompressedSize));
1.327 + DEBUG_PRINT((_L("iUncompressedSize:0x%08x\r\n"), romHeader->iUncompressedSize));
1.328 + // Buffer it.
1.329 + iHeaderStored = true;
1.330 +
1.331 + DEBUG_PRINT((_L("<<YModem::GetInnerCompression():%d\r\n"), r))
1.332 + return r;
1.333 + }
1.334 +
1.335 +TInt YModem::GetHeaderBufferContent(TUint8*& aDest, TInt& aLength)
1.336 + {
1.337 + DEBUG_PRINT((_L(">>YModem::GetHeaderBufferContent(aDest:0c%08x, aLen:%d)\r\n"),aDest, aLength ));
1.338 + DEBUG_PRINT((_L("iDataSizeInPuffer :%d\r\n"), iDataSizeInPuffer));
1.339 + if( aLength < iDataSizeInPuffer )
1.340 + {
1.341 + const TUint8* p=iHeaderBuf.Ptr() + (KHeaderBufferSize - iDataSizeInPuffer);
1.342 + memcpy(aDest, p, aLength);
1.343 + iDataSizeInPuffer -= aLength;
1.344 + }
1.345 + else
1.346 + {
1.347 + const TUint8* p=iHeaderBuf.Ptr() + (KHeaderBufferSize - iDataSizeInPuffer);
1.348 + memcpy(aDest, p, iDataSizeInPuffer);
1.349 + aLength = iDataSizeInPuffer;
1.350 + iHeaderStored = false;
1.351 + }
1.352 + DEBUG_PRINT((_L("<<YModem::GetHeaderBufferContent(aDest:0c%08x, aLen:%d)\r\n"),aDest, aLength ));
1.353 + return KErrNone;
1.354 + }
1.355 +
1.356 +TBool YModem::IsHeaderStored(void)
1.357 + {
1.358 + return iHeaderStored;
1.359 + }
1.360 +