Update copyright information
[keystone-rtos/ibl.git] / src / interp / bis / bis.h
1 /** 
2  *   @file  bis.h
3  *
4  *   @brief   
5  *      The file has definitions for the BIS specification. 
6  *
7  *  \par
8  *  NOTE:
9  *      (C) Copyright 2008, Texas Instruments, Inc.
10  * 
11  *  Redistribution and use in source and binary forms, with or without 
12  *  modification, are permitted provided that the following conditions 
13  *  are met:
14  *
15  *    Redistributions of source code must retain the above copyright 
16  *    notice, this list of conditions and the following disclaimer.
17  *
18  *    Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the 
20  *    documentation and/or other materials provided with the   
21  *    distribution.
22  *
23  *    Neither the name of Texas Instruments Incorporated nor the names of
24  *    its contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
31  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
32  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
33  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
36  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
37  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38  *
39  *  \par
40 */
41 #ifndef __BIS_H__
42 #define __BIS_H__
44 /* Boot Image Script (BIS) Magic number definition  
45  * Every boot image should begin with TIBI (TI Boot Image) */
46 #define BIS_MAGIC_NUMBER        (0x54494249u)   // 'T','I','B','I'
48 /* Boot Image Script (BIS) Command Definitions
49  * Every BIS command will read 'B','I','S',XXh, where XXh is the command number */
50 #define BIS_CMD_PREFIX            (0x42495300u)   // 'B','I','S',xxx
51 #define BIS_CMD_MASK              (0xFFFFFF00u)
52 #define BIS_CMD_SECTION_LOAD      (0x42495301u)
53 #define BIS_CMD_FUNCTION_LOAD     (0x42495302u)
54 #define BIS_CMD_FUNCTION_EXEC     (0x42495303u)
55 #define BIS_CMD_MEMORY_ACCESS     (0x42495304u)
56 #define BIS_CMD_SECTION_TERMINATE (0x424953FFu)
59 Int32 iblBootBis (BOOT_MODULE_FXN_TABLE *bootFxn, Uint32* entry_point);
61 #endif  /* __BIS_H__ */