Merge branch 'tmp-mike2'
[keystone-rtos/ibl.git] / src / interp / blob / blob.c
1 /*
2  *
3  * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/ 
4  * 
5  * 
6  *  Redistribution and use in source and binary forms, with or without 
7  *  modification, are permitted provided that the following conditions 
8  *  are met:
9  *
10  *    Redistributions of source code must retain the above copyright 
11  *    notice, this list of conditions and the following disclaimer.
12  *
13  *    Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the 
15  *    documentation and/or other materials provided with the   
16  *    distribution.
17  *
18  *    Neither the name of Texas Instruments Incorporated nor the names of
19  *    its contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
26  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
27  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
28  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
31  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
32  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34 */
38 /************************************************************************************
39  * FILE PURPOSE: Boot a binary blob
40  ************************************************************************************
41  * FILE NAME: blob.c
42  *
43  * DESCRIPTION: A binary blob is booted.
44  *
45  * @file blob.c
46  *
47  * @brief
48  *   This file reads data from the boot device as a binary blob
49  *
50  ************************************************************************************/
51 #include "types.h"
52 #include "ibl.h"
53 #include "iblloc.h"
54 #include "iblblob.h"
58 /**
59  * @b Description
60  * @n
61  *
62  * A simple read from the boot device is done until one of the following
63  * conditions occurs:
64  *    - The complete data block is read
65  *    - The read request fails
66  */
68 void iblBootBlob (BOOT_MODULE_FXN_TABLE *bootFxn, Uint32 *entry, void *formatParams)
69 {
70     Int32   dataSize;
71     Uint32  remainSize;
72     Uint32  dummyVal;
73     Uint32  bytesRead    = 0;
74     Int32   erVal        = 0;
75     Uint8  *datap;
77     iblBinBlob_t *blobParams = (iblBinBlob_t *)formatParams;
79     datap  = (Uint8 *)blobParams->startAddress;
80     *entry = 0;
82     for (remainSize = blobParams->sizeBytes; (remainSize > 0) && (erVal == 0);   )  {
84         /* If there is any data waiting go ahead and process it */
85         dataSize = (*bootFxn->query)();
87         /* The query function will return a negative value when the stream has
88          * closed */
89         if (dataSize < 0)
90             break;
92         if (dataSize > remainSize)
93             dataSize = remainSize;
95         if (dataSize > 0)  {
97             (*bootFxn->read)(datap, dataSize);
98             datap      = datap      + dataSize;
99             remainSize = remainSize - dataSize;
100             bytesRead  = bytesRead  + dataSize;
102         }  else  {
104             /* If there is no data waiting peek for more. On error assume
105              * that the device has completed the transfer. This is valid
106              * since the read includes a timeout. */
107             erVal = (*bootFxn->peek)((Uint8 *)&dummyVal, 1);
109         }
111     }
113    /* Assume that if any data was read the boot was successful. 
114     * A check could be added to see if the entry address was
115     * actually written, but this assumes there was no data already
116     * at the entry point */
117    if (bytesRead > 0)
118       *entry = blobParams->branchAddress;
123      
124