qnx/src/ipc3x_dev/ti/syslink/inc/knl/_Dm8168DspPwr.h

   1 /**
   2  *  @file   _Dm8168DspPwr.h
   3  *
   4  *  @brief      Internal header for Power Manager interface for dm8168dsp.
   5  *
   6  *
   7  */
   8 /*
   9  *  ============================================================================
  10  *
  11  *  Copyright (c) 2008-2012, Texas Instruments Incorporated
  12  *
  13  *  Redistribution and use in source and binary forms, with or without
  14  *  modification, are permitted provided that the following conditions
  15  *  are met:
  16  *
  17  *  *  Redistributions of source code must retain the above copyright
  18  *     notice, this list of conditions and the following disclaimer.
  19  *
  20  *  *  Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *
  24  *  *  Neither the name of Texas Instruments Incorporated nor the names of
  25  *     its contributors may be used to endorse or promote products derived
  26  *     from this software without specific prior written permission.
  27  *
  28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  29  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  30  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  31  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  32  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  33  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  34  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  35  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  36  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  37  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  38  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  *  Contact information for paper mail:
  40  *  Texas Instruments
  41  *  Post Office Box 655303
  42  *  Dallas, Texas 75265
  43  *  Contact information:
  44  *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
  45  *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
  46  *  ============================================================================
  47  *
  48  */
  49
  50
  51
  52 #ifndef _DM8168DSPPWR_H_0xa861
  53 #define _DM8168DSPPWR_H_0xa861
  54
  55
  56 /* Module level headers */
  57 #include <PwrDefs.h>
  58 #include <ti/syslink/ProcMgr.h>
  59
  60
  61 #if defined (__cplusplus)
  62 extern "C" {
  63 #endif
  64
  65
  66 /* =============================================================================
  67  *  Macros and types
  68  *  See PwrDefs.h and Dm8168DspPwr.h
  69  * =============================================================================
  70  */
  71
  72
  73 /* =============================================================================
  74  *  Internal functions accessed through function table
  75  * =============================================================================
  76  */
  77 /* Function to attach to the PwrMgr. */
  78 Int DM8168DSPPWR_attach (PwrMgr_Handle handle, PwrMgr_AttachParams * params);
  79
  80 /* Function to detach from the PwrMgr. */
  81 Int DM8168DSPPWR_detach (PwrMgr_Handle handle);
  82
  83 /* Function to power on the slave processor. */
  84 Int DM8168DSPPWR_on (PwrMgr_Handle handle);
  85
  86 /* Function to power off the slave processor. */
  87 Int DM8168DSPPWR_off (PwrMgr_Handle handle, Bool force);
  88
  89 /* TBD: Other functions. */
  90
  91
  92 #if defined (__cplusplus)
  93 }
  94 #endif /* defined (__cplusplus) */
  95
  96 #endif /* _DM8168DSPPWR_H_0xa860 */