clk.h

 
#ifndef _CLK_H_
#define _CLK_H_
 
/*******************************************************************************
*                                  Include Files
*******************************************************************************/
 
#include "syna_device.h"
 
/***************************************************************************/
 
/*******************************************************************************
*                                Macro definitions
*******************************************************************************/
 
#define CPU_CLK_RATE_HIGH 400000000 
 
#define CPU_CLK_RATE_MID 200000000 
 
#define CPU_CLK_RATE_LOW 100000000 

 
/******************************************************************************
* Enumerations
*****************************************************************************/


typedef enum
{
    CLK_PLL0,   
    CLK_PLL1    
} clk_pll_en;

typedef enum
{
    CLK_PLL_CFG_OFF,     
    CLK_PLL_CFG_BYPASS,       
    CLK_PLL_CFG_LOW,     
    CLK_PLL_CFG_MID,     
    CLK_PLL_CFG_MID_PLUS,       
    CLK_PLL_CFG_HIGH,       
    CLK_PLL_RATES_MAX      
} clk_pll_config_en;

typedef enum
{
    CLK_OK,                 
    CLK_ERROR,                    
    CLK_ERROR_BUSY,               
    CLK_ERROR_TIMEOUT,            
    CLK_ERROR_UNSUPPORTED,        
    CLK_ERROR_PARAMETER,          
    CLK_ERROR_INVALID_MUX,        
    CLK_ERROR_INVALID_VALUE,      
    CLK_ERROR_CHILDREN_ENABLED    
} clk_status_en;

typedef enum
{
    CLK_STATUS_DISABLED,    
    CLK_STATUS_ENABLED  
} clk_enable_status_en;

 
/*******************************************************************************
* Function Prototypes
*******************************************************************************/
 
/*******************************************************************************
*           Function Name: clk_init_tree
****************************************************************************/
clk_status_en clk_init_tree(clk_pll_config_en pll_config);
 
/*******************************************************************************
*           Function Name: clk_enable
****************************************************************************/
clk_status_en clk_enable(clk_ids_en clk_id);
 
/*******************************************************************************
*           Function Name: clk_disable
****************************************************************************/
clk_status_en clk_disable(clk_ids_en clk_id);
 
/*******************************************************************************
*           Function Name: clk_force_disable
****************************************************************************/
clk_status_en clk_force_disable(clk_ids_en clk_id);
 
/*******************************************************************************
*           Function Name: clk_is_enabled
****************************************************************************/
clk_status_en clk_is_enabled(clk_ids_en clk_id, clk_enable_status_en *out_status);
 
/*******************************************************************************
*           Function Name: clk_get_rate
****************************************************************************/
clk_status_en clk_get_rate(clk_ids_en clk_id, uint32_t *rate);
 
/*******************************************************************************
*           Function Name: clk_set_rate
****************************************************************************/
clk_status_en clk_set_rate(clk_ids_en clk_id, uint32_t requested_rate, uint32_t *actual_rate);
 
/*******************************************************************************
*           Function Name: clk_get_divider
****************************************************************************/
clk_status_en clk_get_divider(clk_ids_en clk_id, int32_t *divider);
 
/*******************************************************************************
*           Function Name: clk_set_pll_config
****************************************************************************/
clk_status_en clk_set_pll_config(clk_pll_en pll, clk_pll_config_en pll_config);
 
/*******************************************************************************
*           Function Name: clk_get_pll_config
****************************************************************************/
clk_status_en clk_get_pll_config(clk_pll_en pll, clk_pll_config_en *pll_config);
 
/****************************************************************************** 
*           Function Name: clk_set_mux 
****************************************************************************/
clk_status_en clk_set_mux(clk_ids_en clk_id, uint8_t mux_out);

 
#endif  /*_CLK_H_*/