psdk_cust/pdk_k2g_1_0_1_1_eng/packages/ti/boot/sbl/src/qspi/sbl_qspi.h

   1 /**
   2  *  \file    sbl_qspi.h
   3  *
   4  *  \brief   This file contains functions prototypes for QSPI Boot functionality
   5  *           of SBL.
   6  *
   7  */
   8
   9 /*
  10  * Copyright (C) 2015 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  */
  41
  42 #ifndef _SBL_QSPI_H_
  43 #define _SBL_QSPI_H_
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 /* ========================================================================== */
  50 /*                             Include Files                                  */
  51 /* ========================================================================== */
  52 #include "sbl_image_copy.h"
  53
  54 /*
  55  *  \brief    SBL_QSPIBootImage function initializes the QSPI driver and copies
  56  *            the application image from the QSPI device to the DDR memory and
  57  *            gives control to the processor core.
  58  *
  59  *  \param    pointer to the structure holding the entry pointers for different
  60  *            cores.
  61  *
  62  *  \return   error status.If error has occured it returns a non zero value.
  63  *            If no error has occured then return status will be zero.
  64  *
  65  */
  66 int32_t SBL_QSPIBootImage(sblEntryPoint_t *pEntry);
  67
  68 #ifdef __cplusplus
  69 }
  70 #endif
  71
  72 #endif