src/hw/pscs/pscapi.h

   1 #ifndef _PSCAPI_H
   2 #define _PSCAPI_H
   3 /**********************************************************************************
   4  * FILE PURPOSE: Define the power save controller api
   5  **********************************************************************************
   6  * FILE NAME: pscapi.h
   7  *
   8  * DESCRIPTION: Defines the driver interface for the psc controller driver.
   9  *
  10  * Copyright (C) 2006, Texas Instruments, Inc.
  11  * @file pscapi.h
  12  *
  13  * @brief
  14  *  Defines the API used by all power controllers
  15  *
  16  *  Redistribution and use in source and binary forms, with or without
  17  *  modification, are permitted provided that the following conditions
  18  *  are met:
  19  *
  20  *    Redistributions of source code must retain the above copyright
  21  *    notice, this list of conditions and the following disclaimer.
  22  *
  23  *    Redistributions in binary form must reproduce the above copyright
  24  *    notice, this list of conditions and the following disclaimer in the
  25  *    documentation and/or other materials provided with the
  26  *    distribution.
  27  *
  28  *    Neither the name of Texas Instruments Incorporated nor the names of
  29  *    its contributors may be used to endorse or promote products derived
  30  *    from this software without specific prior written permission.
  31  *
  32  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  35  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  37  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  38  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  39  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  40  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  41  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  42  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  43  *
  44 */
  45 #include "types.h"
  46
  47 int16 pscEnableModule (uint32 modNum);
  48 int16 pscDisableModule (uint32 modNum);
  49 BOOL pscModuleIsEnabled (uint32 modNum);
  50 int16 pscSetResetIso (uint32 modNum);
  51 int16 pscDisableDomain (uint32 domainNum);
  52 void pscDisableModAndDomain (uint32 modNum, uint32 domainNum);
  53
  54
  55
  56
  57
  58 #endif /* _PSCAPI_H */