Power.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_Power__include
#define ti_drivers_Power__include

#include <stdbool.h>
#include <stdint.h>

#include <ti/drivers/utils/List.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Power latency types */
#define Power_TOTAL               (1U)   
#define Power_RESUME              (2U)   
/* Power notify responses */
#define Power_NOTIFYDONE          (0)   
#define Power_NOTIFYERROR         (-1)  
/* Power status */
#define Power_SOK                 (0)    
#define Power_EFAIL               (-1)   
#define Power_EINVALIDINPUT       (-2)   
#define Power_EINVALIDPOINTER     (-3)   
#define Power_ECHANGE_NOT_ALLOWED (-4)   
#define Power_EBUSY               (-5)   
/* Power transition states */
#define Power_ACTIVE              (1U)   
#define Power_ENTERING_SLEEP      (2U)   
#define Power_EXITING_SLEEP       (3U)   
#define Power_ENTERING_SHUTDOWN   (4U)   
#define Power_CHANGING_PERF_LEVEL (5U)   
typedef void (*Power_PolicyInitFxn)(void);

typedef void (*Power_PolicyFxn)(void);

typedef int_fast16_t (*Power_NotifyFxn)(uint_fast16_t eventType,
     uintptr_t eventArg, uintptr_t clientArg);

typedef struct Power_NotifyObj_ {
    List_Elem link;             
    uint_fast16_t eventTypes;   
    Power_NotifyFxn notifyFxn;  
    uintptr_t clientArg;        
} Power_NotifyObj;

bool Power_disablePolicy(void);

void Power_enablePolicy(void);

uint_fast32_t Power_getConstraintMask(void);

int_fast16_t Power_getDependencyCount(uint_fast16_t resourceId);

uint_fast16_t Power_getPerformanceLevel(void);

uint_fast32_t Power_getTransitionLatency(uint_fast16_t sleepState,
    uint_fast16_t type);

uint_fast16_t Power_getTransitionState(void);

void Power_idleFunc(void);

int_fast16_t Power_init(void);

int_fast16_t Power_registerNotify(Power_NotifyObj *pNotifyObj,
                                  uint_fast16_t eventTypes,
                                  Power_NotifyFxn notifyFxn,
                                  uintptr_t clientArg);

int_fast16_t Power_releaseConstraint(uint_fast16_t constraintId);

int_fast16_t Power_releaseDependency(uint_fast16_t resourceId);

int_fast16_t Power_setConstraint(uint_fast16_t constraintId);

int_fast16_t Power_setDependency(uint_fast16_t resourceId);

int_fast16_t Power_setPerformanceLevel(uint_fast16_t level);

void Power_setPolicy(Power_PolicyFxn policy);

int_fast16_t Power_shutdown(uint_fast16_t shutdownState,
    uint_fast32_t shutdownTime);

int_fast16_t Power_sleep(uint_fast16_t sleepState);

void Power_unregisterNotify(Power_NotifyObj *pNotifyObj);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_Power__include */