dcc/v0/sdl_dcc.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022 Texas Instruments Incorporated
 *
 *  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_DCC_H_
#define SDL_DCC_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <sdl/include/sdl_types.h>
#include <sdl/include/hw_types.h>
 
#include <sdl/dcc/v0/sdlr_dcc2.h>
#include <sdl/dcc/v0/soc/sdl_dcc_soc.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define DCC_SRC0_COUNT_MAX      (0xFFFFFU)
 
#define DCC_SRC0_VALID_MAX      (0x0FFFFU)
 
#define DCC_SRC1_COUNT_MAX      (0xFFFFFU)
 
#define DCC_MIN_CLK0_VLD_SEED       (4u)
 
#define SDL_DCC_CLK0_SRC_NUM        (3u)
 
#define SDL_DCC_CLK1_SRC_NUM        (10u)
 
#define SDL_DCC_MODES_NUM           (3u)
 
typedef uint32_t SDL_DCC_Mode;
 
#define SDL_DCC_MODE_SINGLE_SHOT_1     (SDL_DCC2_DCCGCTRL_SINGLESHOT_MODE1)
 
#define SDL_DCC_MODE_SINGLE_SHOT_2     (SDL_DCC2_DCCGCTRL_SINGLESHOT_MODE2)
 
#define SDL_DCC_MODE_CONTINUOUS        (SDL_DCC2_DCCGCTRL_SINGLESHOT_DISABLE)
 
typedef uint32_t SDL_DCC_ClkSrc0;
 
#define SDL_DCC_CLK0_SRC_CLOCK0_0               (SDL_DCC2_DCCCLKSRC0_CLKSRC0_0)
 
#define SDL_DCC_CLK0_SRC_CLOCK0_1               (SDL_DCC2_DCCCLKSRC0_CLKSRC0_1)
 
#define SDL_DCC_CLK0_SRC_CLOCK0_2               (SDL_DCC2_DCCCLKSRC0_CLKSRC0_2)
 
typedef uint32_t SDL_DCC_ClkSrc1;
#define SDL_DCC_CLK1_SRC_CLOCK1                  (SDL_DCC2_DCCCLKSRC1_CLKSRC_0)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC0               (SDL_DCC2_DCCCLKSRC1_CLKSRC_1)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC1               (SDL_DCC2_DCCCLKSRC1_CLKSRC_2)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC2               (SDL_DCC2_DCCCLKSRC1_CLKSRC_3)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC3               (SDL_DCC2_DCCCLKSRC1_CLKSRC_4)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC4               (SDL_DCC2_DCCCLKSRC1_CLKSRC_5)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC5               (SDL_DCC2_DCCCLKSRC1_CLKSRC_6)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC6               (SDL_DCC2_DCCCLKSRC1_CLKSRC_7)
 
#define SDL_DCC_CLK1_SRC_CLOCKSRC7               (SDL_DCC2_DCCCLKSRC1_CLKSRC_8)
 
#define SDL_DCC_CLK1_SRC_FICLK                   (SDL_DCC2_DCCCLKSRC1_CLKSRC_OTHER)
 
typedef uint32_t SDL_DCC_IntrType;
 
#define SDL_DCC_INTERRUPT_ERR              (0x0U)
 
#define SDL_DCC_INTERRUPT_DONE             (0x1U)
 
/* ========================================================================== */
/*                         Structures                                         */
/* ========================================================================== */
 
typedef struct {
    SDL_DCC_Mode mode;
    SDL_DCC_ClkSrc0 clk0Src;
    SDL_DCC_ClkSrc1 clk1Src;
    uint32_t clk0Seed;
    uint32_t clk0ValidSeed;
    uint32_t clk1Seed;
}SDL_DCC_Config;
 
 
typedef struct {
    bool doneIntr;
    /* Indicates if a done interrupt is currently pending */
    bool errIntr;
    /* Indicates if an error interrupt is currently pending */
    SDL_DCC_Config config;
    /* DCC config structure */
    uint32_t clk0Cnt;
    /* Current COUNT0 value of clock source 0 */
    uint32_t clk0Valid;
    /* Current VALID0 value */
    uint32_t clk1Cnt;
    /* Current COUNT1 value of clock source 1 */
}SDL_DCC_Status;
 
 
typedef struct {
    uint32_t DCC_REV;
    /* DCC revision register */
    uint32_t DCC_CNTSEED0;
    /* COUNT0 SEED register */
    uint32_t DCC_VALIDSEED0;
    /* VALID0 SEED register */
    uint32_t DCC_CNTSEED1;
    /* COUNT1 SEED register */
    uint32_t DCC_CLKSRC1;
    /* CLOCK SOURCE1 register */
    uint32_t DCC_CLKSRC0;
    /* CLOCK SOURCE0 register */
}SDL_DCC_StaticRegs;
 
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t SDL_DCC_configure(SDL_DCC_Inst instance, const SDL_DCC_Config *pConfig);
 
int32_t SDL_DCC_verifyConfig(SDL_DCC_Inst instance, const SDL_DCC_Config *pConfig);
 
int32_t SDL_DCC_enable(SDL_DCC_Inst instance);
 
int32_t SDL_DCC_disable(SDL_DCC_Inst instance);
 
int32_t SDL_DCC_getStatus(SDL_DCC_Inst instance, SDL_DCC_Status *pStatus);
 
int32_t SDL_DCC_enableIntr(SDL_DCC_Inst instance, SDL_DCC_IntrType intr);
 
int32_t SDL_DCC_disableIntr(SDL_DCC_Inst instance, SDL_DCC_IntrType intr);
 
int32_t SDL_DCC_clearIntr(SDL_DCC_Inst instance, SDL_DCC_IntrType intr);
 
int32_t SDL_DCC_getStaticRegs(SDL_DCC_Inst instance, SDL_DCC_StaticRegs *pStaticRegs);
 
 
#ifdef __cplusplus
}
 
#endif /*extern "C" */
 
#endif