qnx/src/ipc3x_dev/ti/syslink/inc/Dm8168Clock.h

   1 /**
   2  *  @file   Dm8168Clock.h
   3  *
   4  *  @brief      RTOS side Clock interface for DM8168
   5  *
   6  *
   7  *
   8  */
   9 /*
  10  *  ============================================================================
  11  *
  12  *  Copyright (c) 2008-2012, Texas Instruments Incorporated
  13  *
  14  *  Redistribution and use in source and binary forms, with or without
  15  *  modification, are permitted provided that the following conditions
  16  *  are met:
  17  *
  18  *  *  Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *
  21  *  *  Redistributions in binary form must reproduce the above copyright
  22  *     notice, this list of conditions and the following disclaimer in the
  23  *     documentation and/or other materials provided with the distribution.
  24  *
  25  *  *  Neither the name of Texas Instruments Incorporated nor the names of
  26  *     its contributors may be used to endorse or promote products derived
  27  *     from this software without specific prior written permission.
  28  *
  29  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  30  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  31  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  32  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  33  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  34  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  35  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  36  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  37  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  38  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *  Contact information for paper mail:
  41  *  Texas Instruments
  42  *  Post Office Box 655303
  43  *  Dallas, Texas 75265
  44  *  Contact information:
  45  *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
  46  *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
  47  *  ============================================================================
  48  *
  49  */
  50
  51
  52 #ifndef DM8168CLOCK_H_0xbbec
  53 #define DM8168CLOCK_H_0xbbec
  54
  55 #include <ClockOps.h>
  56
  57
  58 #if defined (__cplusplus)
  59 extern "C" {
  60 #endif
  61
  62
  63 /* =============================================================================
  64  *  APIs
  65  * =============================================================================
  66  */
  67 /* Function creates the clock object */
  68 ClockOps_Handle DM8168CLOCK_create(Void);
  69 /* Function deletes the clock object */
  70 Int DM8168CLOCK_delete (ClockOps_Handle handle);
  71 /* Function to get handle to a clock given its name */
  72 Ptr DM8168CLOCK_get(String clkname);
  73 /* Function to release a Clock. */
  74 Void DM8168CLOCK_put(Ptr clkHandle);
  75 /* Function to enable a clock. */
  76 Int32 DM8168CLOCK_enable(Ptr clkHandle);
  77 /* Function to disable a clock */
  78 Void DM8168CLOCK_disable(Ptr clkHandle);
  79 /* Function to get clock speed */
  80 ULong DM8168CLOCK_getRate(Ptr clkHandle);
  81 /* Function to set clock speed */
  82 Int32 DM8168CLOCK_setRate(Ptr clkHandle, ULong rate);
  83
  84
  85 #if defined (__cplusplus)
  86 }
  87 #endif /* defined (__cplusplus) */
  88
  89 #endif /* omap3530_hal_mmu_H_0xbbec */