csl_pll.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *  ============================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 21-Aug-2008 Created
 * ============================================================================
 */

#ifndef _CSL_PLL_H_
#define _CSL_PLL_H_


#ifdef __cplusplus
extern "C" {
#endif

#include "csl_error.h"
#include "csl_types.h"
#include "soc.h"
#include "csl_general.h"

/*****************************************************************************\
*         PLL global macro declarations
\*****************************************************************************/

#define TIMEOUT                              (0x1fff)

#define CSL_SYS_CGCR2_INIT_VALUE             (0x0806)

/**************************************************************************\
* PLLC global typedef declarations                                         *
\**************************************************************************/

typedef struct PLL_Obj* PLL_Handle;

/**************************************************************************\
* PLLC global enum declaration                                             *
\**************************************************************************/

typedef enum
{
    CSL_PLL_INST_0 = (0u),
    CSL_PLL_INST_INVALID = (1u)
} CSL_PllInsId;
/**************************************************************************\
*               PLLC global data structures                                *
\**************************************************************************/

typedef struct
{
    Uint16    PLLCNTL1;

    Uint16    PLLINCNTL;

    Uint16    PLLCNTL2;

    Uint16    PLLOUTCNTL;

} PLL_Config;

typedef struct PLL_Obj{
    PLL_Config         *pllConfig;
    Uint32             instId;
    CSL_SysRegsOvly    sysAddr;

} PLL_Obj;

/*****************************************************************************\
 * PLL function declarations                                                  *
\*****************************************************************************/

CSL_Status PLL_init( PLL_Obj * pllObj,
                     Uint32 pllInstId
);

CSL_Status PLL_config(
               PLL_Handle hPll,
               PLL_Config *pconfigInfo
);

CSL_Status PLL_enable(
               PLL_Handle hPll
);

CSL_Status PLL_bypass(
               PLL_Handle hPll
);

CSL_Status PLL_reset(
        PLL_Handle hPll
);
#ifdef __cplusplus
}
#endif
#endif /* _CSL_PLL_H_ */