copylist.h

Go to the documentation of this file.

/******************************************************************************
 *  Copyright (c) 2022-2024 Texas Instruments Incorporated. All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1) Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2) Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *  3) Neither the name of the copyright holder nor the names of its contributors
 *     may be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************
 *  \file       copylist.h
 *
 *  \brief      Copy list format used to apply FCFG, CCFG, and standby wakeup
 *              configurations.
 *
 ******************************************************************************/

#ifndef __COPYLIST_H__
#define __COPYLIST_H__

#include <stdint.h>
#include "../inc/hw_types.h"
#include "hapi.h"

//*****************************************************************************
//
//
//*****************************************************************************
#define CopyList_EOL 0U

//*****************************************************************************
//
//
//*****************************************************************************
#define CopyList_NOP CopyList_WAIT(0U)

//*****************************************************************************
//
//
//*****************************************************************************
#define CopyList_WAIT(n) (0x10000000U | (((uint32_t)n << 2U) & 0xFFFFCU))

//*****************************************************************************
//
//
//*****************************************************************************
#define CopyList_COPY(address) ((uint32_t)address | 0x1U)

//*****************************************************************************
//
//
//*****************************************************************************
#define CopyList_COPY_MULTI(address, n) (((uint32_t)address & 0xF00FFFFCU) | (((uint32_t)n << 20U) & 0xFF00000U))

//*****************************************************************************
//
//
//*****************************************************************************
#define CopyList_JUMP(address) ((uint32_t)address | 0x2U)

//*****************************************************************************
//
//
//*****************************************************************************
#define CopyList_CALL(address) ((uint32_t)address | 0x3U)

#ifndef DRIVERLIB_NS
//*****************************************************************************
//
// Below functions will only be compiled into the driverlib.a library and not
// the driverlib_ns.a library.
// Non-secure applications might be able to access some/all of these functions
// through veneers declared further below in the #else case.
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CopyList_apply(const uint32_t *list)
{
    HapiApplyCopyList(list);
}

#else
    //*****************************************************************************
    //
    // Secure-only API functions available from non-secure context through
    // veneers.
    //
    // These functions must be linked in from from the secure veneer library.
    //
    //*****************************************************************************

    // No veneers

#endif

#endif //__COPYLIST_H__