[processor-sdk/performance-audio-sr.git] / psdk_cust / pdk_k2g_1_0_1_2_eng / packages / ti / boot / sbl / board / src / sbl_image_copy.h
1 /**
2 * \file sbl_image_copy.c
3 *
4 * \brief This file contains function prototype of the Image Copy wrapper
5 * function.
6 *
7 */
9 /*
10 * Copyright (C) 2015-2016 Texas Instruments Incorporated - http://www.ti.com/
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 *
16 * Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the
22 * distribution.
23 *
24 * Neither the name of Texas Instruments Incorporated nor the names of
25 * its contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 */
42 #ifndef _SBL_IMAGE_COPY_H_
43 #define _SBL_IMAGE_COPY_H_
45 /* ========================================================================== */
46 /* Include Files */
47 /* ========================================================================== */
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
53 /* Structure holding the entry address of the applications for different cores. */
54 typedef struct sblEntryPoint
55 {
56 uint32_t entryPoint_MPU_CPU0;
57 /* Value holding the entry address of MPU_CPU0. */
58 uint32_t entryPoint_MPU_CPU1;
59 /* Value holding the entry address of MPU_CPU1. */
60 uint32_t entryPoint_DSP1;
61 /* Value holding the entry address of MPU_DSP1. */
62 uint32_t entryPoint_DSP2;
63 /* Value holding the entry address of MPU_DSP2. */
64 uint32_t entryPoint_IPU1_CPU0;
65 /* Value holding the entry address of IPU_CPU0. */
66 uint32_t entryPoint_IPU1_CPU1;
67 /* Value holding the entry address of IPU1_CPU1. */
68 uint32_t entryPoint_IPU2_CPU0;
69 /* Value holding the entry address of IPU2_CPU0. */
70 uint32_t entryPoint_IPU2_CPU1;
71 /* Value holding the entry address of IPU2_CPU1. */
72 }sblEntryPoint_t;
74 /*
75 * \brief SBL_ImageCopy function is a wrapper to Multicore Image parser
76 * function. Based on boot-mode jumps into specific Image copy
77 * function for the particular bootmode.
78 *
79 * \param pointer to the structure holding the entry pointers for different
80 * cores.
81 *
82 * \return error status.If error has occured it returns a non zero value.
83 * If no error has occured then return status will be zero.
84 *
85 */
86 int32_t SBL_ImageCopy(sblEntryPoint_t *pEntry);
88 #ifdef __cplusplus
89 }
90 #endif
92 #endif