sdl_ip_pok.h

Go to the documentation of this file.

/*
 * @file  sdl_ip_pok.h
 *
 * @brief
 *  C implementation interface header file for the POK module SDL-FL.
 *
 *  Translates POK ID to POK Address. This is a SOC specific source file.
 *
 *  \par
 *  ============================================================================
 *  @n   (C) Copyright 2021, Texas Instruments, Inc.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    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.
 *
 *    Neither the name of Texas Instruments Incorporated 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
 *  OWNER 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.
 *
*/
#ifndef SDL_POK_IP_H
#define SDL_POK_IP_H

#ifdef __cplusplus
    extern "C" {
#endif

#if defined (SOC_J721E)
#include <src/ip/pok/V0/sdl_pok_def.h>
#include <src/ip/pok/soc/j721e/sdl_ip_pok.h>
#elif defined (SOC_J7200)
#include <src/ip/pok/V1/sdl_pok_def.h>
#include <src/ip/pok/soc/j7200/sdl_ip_pok.h>
#elif defined (SOC_J721S2)
#include <src/ip/pok/V1/sdl_pok_def.h>
#include <src/ip/pok/soc/j721s2/sdl_ip_pok.h>
#elif defined (SOC_J784S4)
#include <src/ip/pok/V1/sdl_pok_def.h>
#include <src/ip/pok/soc/j784s4/sdl_ip_pok.h>
#endif

/*=============================================================================
 *  Internal definitions and functions
 *===========================================================================*/

/* This function read the registers of POK module */
int32_t SDL_pok_GetShiftsAndMasks(SDL_wkupCtrlRegsBase_t     *pBaseAddress,
                                     SDL_POK_Inst             instance,
                                     SDL_pokShiftsAndMasks_t *pShMasks);

/* This function set the POK register values */
int32_t SDL_pokSetControl (SDL_wkupCtrlRegsBase_t         *pBaseAddress,
                           const SDL_POK_config           *pPokCfg,
                           SDL_POK_Inst                    instance);

int32_t SDL_pokGetControl   (SDL_wkupCtrlRegsBase_t           *pBaseAddress,
                             const SDL_POK_config             *pPokCfg,
                             SDL_pokVal_t                     *pPokVal,
                             SDL_POK_Inst                      instance);

int32_t SDL_porSetControl (SDL_wkupCtrlRegsBase_t           *pBaseAddress,
                           const SDL_pokPorCfg_t            *pPorCfg);

#ifdef __cplusplus
}
#endif
#endif /* SDL_POK_IP_H */
/* Nothing past this point */