Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | /*
* pwr.h
*
* DSP-BIOS Bridge driver support functions for TI OMAP processors.
*
* Copyright (C) 2005-2006 Texas Instruments, Inc.
*
* This package is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
* WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*/
#ifndef PWR_
#define PWR_
#include <dspbridge/dbdefs.h>
#include <dspbridge/pwr_sh.h>
/*
* ======== pwr_sleep_dsp ========
* Signal the DSP to go to sleep.
*
* Parameters:
* sleep_code: New sleep state for DSP. (Initially, valid codes
* are PWR_DEEPSLEEP or PWR_EMERGENCYDEEPSLEEP; both of
* these codes will simply put the DSP in deep sleep.)
*
* timeout: Maximum time (msec) that PWR should wait for
* confirmation that the DSP sleep state has been
* reached. If PWR should simply send the command to
* the DSP to go to sleep and then return (i.e.,
* asynchrounous sleep), the timeout should be
* specified as zero.
*
* Returns:
* 0: Success.
* 0: Success, but the DSP was already asleep.
* -EINVAL: The specified sleep_code is not supported.
* -ETIME: A timeout occured while waiting for DSP sleep
* confirmation.
* -EPERM: General failure, unable to send sleep command to
* the DSP.
*/
extern int pwr_sleep_dsp(const u32 sleep_code, const u32 timeout);
/*
* ======== pwr_wake_dsp ========
* Signal the DSP to wake from sleep.
*
* Parameters:
* timeout: Maximum time (msec) that PWR should wait for
* confirmation that the DSP is awake. If PWR should
* simply send a command to the DSP to wake and then
* return (i.e., asynchrounous wake), timeout should
* be specified as zero.
*
* Returns:
* 0: Success.
* 0: Success, but the DSP was already awake.
* -ETIME: A timeout occured while waiting for wake
* confirmation.
* -EPERM: General failure, unable to send wake command to
* the DSP.
*/
extern int pwr_wake_dsp(const u32 timeout);
/*
* ======== pwr_pm_pre_scale ========
* Prescale notification to DSP.
*
* Parameters:
* voltage_domain: The voltage domain for which notification is sent
* level: The level of voltage domain
*
* Returns:
* 0: Success.
* 0: Success, but the DSP was already awake.
* -ETIME: A timeout occured while waiting for wake
* confirmation.
* -EPERM: General failure, unable to send wake command to
* the DSP.
*/
extern int pwr_pm_pre_scale(u16 voltage_domain, u32 level);
/*
* ======== pwr_pm_post_scale ========
* PostScale notification to DSP.
*
* Parameters:
* voltage_domain: The voltage domain for which notification is sent
* level: The level of voltage domain
*
* Returns:
* 0: Success.
* 0: Success, but the DSP was already awake.
* -ETIME: A timeout occured while waiting for wake
* confirmation.
* -EPERM: General failure, unable to send wake command to
* the DSP.
*/
extern int pwr_pm_post_scale(u16 voltage_domain, u32 level);
#endif /* PWR_ */
|