pmapi_managed.h

   1 /*
   2  *  libslp-pm
   3  *
   4  * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Seunghun Pi <sh.pi@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20 */
  21
  22
  23 #ifndef __POWER_MANAGER_LIBRARY_MANAGED_H__
  24 #define __POWER_MANAGER_LIBRARY_MANAGED_H__
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /**
  31  * @fn int pm_change_state(unsigned int state);
  32  * @brief This API is used to change the power manager state by force.
  33  * @param[in] state power manager state - LCD_NORMAL, LCD_DIM, LCD_OFF
  34  * @return 0 on success, -1 if failed.
  35  * @see pm_lock_state(), pm_unlock_state()
  36  * @pat Example
  37  * @code
  38  *      ...
  39  *      result = pm_change_state(LCD_OFF);
  40  *      if( result < 0 )
  41  *              printf("[ERROR] return value result =%d, \n",result);
  42  *      else
  43  *              printf("[SUCCESS]return value result =%d \n",result);
  44  *      ...
  45  * @endcode
  46  */
  47         int pm_change_state(unsigned int);
  48
  49 #ifdef __cplusplus
  50 }
  51 #endif
  52 #endif                          /* __POWER_MANAGER_LIBRARY_MANAGED_H__ */