Power.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 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 <stdint.h>
#include <ti/drivers/utils/List.h>

#ifdef __cplusplus
extern "C" {
#endif

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

typedef void (*Power_PolicyFxn)(void);

typedef int (*Power_NotifyFxn)(unsigned int eventType, uintptr_t eventArg,
                               uintptr_t clientArg);

typedef struct Power_NotifyObj {
    List_Elem link;            
    unsigned int eventTypes;    
    Power_NotifyFxn notifyFxn;  
    uintptr_t clientArg;        
} Power_NotifyObj;

void Power_enablePolicy(void);

unsigned int Power_getConstraintMask(void);

unsigned int Power_getDependencyCount(unsigned int resourceId);

unsigned int Power_getPerformanceLevel(void);

uint32_t Power_getTransitionLatency(unsigned int sleepState, unsigned int type);

unsigned int Power_getTransitionState(void);

void Power_idleFunc(void);

void Power_init(void);

unsigned int Power_registerNotify(Power_NotifyObj *pNotifyObj,
                                  unsigned int eventTypes,
                                  Power_NotifyFxn notifyFxn,
                                  uintptr_t clientArg);

void Power_releaseConstraint(unsigned int constraintId);

void Power_releaseDependency(unsigned int resourceId);

void Power_setConstraint(unsigned int constraintId);

void Power_setDependency(unsigned int resourceId);

unsigned int Power_setPerformanceLevel(unsigned int level);

unsigned int Power_shutdown(unsigned int shutdownState, uint32_t shutdownTime);

unsigned int Power_sleep(unsigned int sleepState);

void Power_unregisterNotify(Power_NotifyObj *pNotifyObj);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_Power__include */