mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-28 02:35:28 +00:00
3dd6e71828
The same code exists in four (soon to be five!) different power sequencing drivers, so move it up to common. BUG=None TEST=Manual on Samus. Run "pause_in_s5 on" on EC console, verify that system stops in S5 on shutdown. Run "pause_in_s5 off" on EC console, verify that system again goes to G3 on shutdown. BRANCH=None Signed-off-by: Shawn Nematbakhsh <shawnn@chromium.org> Change-Id: Iaf05ef7ce017be4f9d173e83e985a7a879ba278c Reviewed-on: https://chromium-review.googlesource.com/269566 Reviewed-by: Randall Spangler <rspangler@chromium.org>
121 lines
3.0 KiB
C
121 lines
3.0 KiB
C
/* Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
/* Common power interface for all chipsets */
|
|
|
|
#ifndef __CROS_EC_POWER_H
|
|
#define __CROS_EC_POWER_H
|
|
|
|
#include "common.h"
|
|
#include "gpio.h"
|
|
|
|
enum power_state {
|
|
/* Steady states */
|
|
POWER_G3 = 0, /*
|
|
* System is off (not technically all the way into G3,
|
|
* which means totally unpowered...)
|
|
*/
|
|
POWER_S5, /* System is soft-off */
|
|
POWER_S3, /* Suspend; RAM on, processor is asleep */
|
|
POWER_S0, /* System is on */
|
|
|
|
/* Transitions */
|
|
POWER_G3S5, /* G3 -> S5 (at system init time) */
|
|
POWER_S5S3, /* S5 -> S3 */
|
|
POWER_S3S0, /* S3 -> S0 */
|
|
POWER_S0S3, /* S0 -> S3 */
|
|
POWER_S3S5, /* S3 -> S5 */
|
|
POWER_S5G3, /* S5 -> G3 */
|
|
};
|
|
|
|
/* Information on an power signal */
|
|
struct power_signal_info {
|
|
enum gpio_signal gpio; /* GPIO for signal */
|
|
int level; /* GPIO level which sets signal bit */
|
|
const char *name; /* Name of signal */
|
|
};
|
|
|
|
/*
|
|
* Each board must provide its signal list and a corresponding enum
|
|
* power_signal.
|
|
*/
|
|
extern const struct power_signal_info power_signal_list[];
|
|
|
|
/* Convert enum power_signal to a mask for signal functions */
|
|
#define POWER_SIGNAL_MASK(signal) (1 << (signal))
|
|
|
|
/**
|
|
* Return current input signal state (one or more POWER_SIGNAL_MASK()s).
|
|
*/
|
|
uint32_t power_get_signals(void);
|
|
|
|
/**
|
|
* Check for required inputs
|
|
*
|
|
* @param want Mask of signals which must be present (one or more
|
|
* POWER_SIGNAL_MASK()s).
|
|
*
|
|
* @return Non-zero if all present; zero if a required signal is missing.
|
|
*/
|
|
int power_has_signals(uint32_t want);
|
|
|
|
/**
|
|
* Wait for power input signals to be present
|
|
*
|
|
* @param want Mask of signals which must be present (one or more
|
|
* POWER_SIGNAL_MASK()s). If want=0, stops waiting for
|
|
* signals.
|
|
* @return EC_SUCCESS when all inputs are present, or ERROR_TIMEOUT if timeout
|
|
* before reaching the desired state.
|
|
*/
|
|
int power_wait_signals(uint32_t want);
|
|
|
|
/**
|
|
* Set the low-level power chipset state.
|
|
*
|
|
* @param new_state New chipset state.
|
|
*/
|
|
void power_set_state(enum power_state new_state);
|
|
|
|
/**
|
|
* Chipset-specific initialization
|
|
*
|
|
* @return The state the chipset should start in. Usually POWER_G3, but may
|
|
* be POWER_G0 if the chipset was already on and we've jumped to this image.
|
|
*/
|
|
enum power_state power_chipset_init(void);
|
|
|
|
/**
|
|
* Chipset-specific state handler
|
|
*
|
|
* @return The updated state for the chipset.
|
|
*/
|
|
enum power_state power_handle_state(enum power_state state);
|
|
|
|
/**
|
|
* Interrupt handler for power signal GPIOs.
|
|
*/
|
|
#ifdef HAS_TASK_CHIPSET
|
|
void power_signal_interrupt(enum gpio_signal signal);
|
|
#else
|
|
static inline void power_signal_interrupt(enum gpio_signal signal) { }
|
|
#endif /* !HAS_TASK_CHIPSET */
|
|
|
|
/**
|
|
* pause_in_s5 getter method.
|
|
*
|
|
* @return Whether we should pause in S5 when shutting down.
|
|
*/
|
|
inline int power_get_pause_in_s5(void);
|
|
|
|
/**
|
|
* pause_in_s5 setter method.
|
|
*
|
|
* @param pause True if we should pause in S5 when shutting down.
|
|
*/
|
|
inline void power_set_pause_in_s5(int pause);
|
|
|
|
#endif /* __CROS_EC_POWER_H */
|