src/hw/plls/pllapi.h

   1 /*
   2  *
   3  * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/
   4  *
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions
   8  *  are met:
   9  *
  10  *    Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  *    Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  *    Neither the name of Texas Instruments Incorporated nor the names of
  19  *    its contributors may be used to endorse or promote products derived
  20  *    from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34 */
  35
  36
  37
  38 #ifndef _PLLAPI_H
  39 #define _PLLAPI_H
  40 /*************************************************************************************
  41  * FILE PURPOSE: Define the public pll api
  42  *************************************************************************************
  43  * FILE NAME: pllapi.h
  44  *
  45  * DESCRIPTION: Defines the public api for the pll driver
  46  *
  47  * @file  pllapi.h
  48  *
  49  * @brief
  50  *    This file defines the API used by all PLL drivers
  51  *
  52  *************************************************************************************/
  53 #include "types.h"
  54
  55 /* Prototypes */
  56 uint16 hwPllResetType (uint16 pllNum);
  57 int16 hwPllSetPll (uint16 pllNum, uint16 prediv, uint16 mult, uint16 postdiv);
  58 int16 hwPllDisable (uint16 pllNum);
  59 int16 hwPllEnable (uint16 pllNum);
  60
  61
  62 /**
  63  * @def pll_POR_RESET
  64  */
  65 #define pll_POR_RESET   500     /**< last reset was a power on reset */
  66
  67 /**
  68  * @def pll_WARM_RESET
  69  */
  70 #define pll_WARM_RESET  501     /**< last reset was a warm reset */
  71
  72
  73
  74 #endif /* _PLLAPI_H */
  75
  76