blob: 442a6cb6346b6602c3662ca70c8a1004d4c22df9 [file] [log] [blame]
/* Copyright 2012 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 interface to throttle the AP */
#ifndef __CROS_EC_THROTTLE_AP_H
#define __CROS_EC_THROTTLE_AP_H
/**
* Level of throttling desired.
*/
enum throttle_level {
THROTTLE_OFF = 0,
THROTTLE_ON,
};
/**
* Types of throttling desired. These are independent.
*/
enum throttle_type {
THROTTLE_SOFT = 0, /* for example, host events */
THROTTLE_HARD, /* for example, PROCHOT */
NUM_THROTTLE_TYPES
};
/**
* Possible sources for CPU throttling requests.
*/
enum throttle_sources {
THROTTLE_SRC_THERMAL = 0,
THROTTLE_SRC_BAT_DISCHG_CURRENT,
THROTTLE_SRC_BAT_VOLTAGE,
};
/**
* Enable/disable CPU throttling.
*
* This is a virtual "OR" operation. Any caller can enable CPU throttling of
* any type, but all callers must agree in order to disable that type.
*
* @param level Level of throttling desired
* @param type Type of throttling desired
* @param source Which task is requesting throttling
*/
#if defined(CONFIG_THROTTLE_AP) || \
defined(CONFIG_THROTTLE_AP_ON_BAT_DISCHG_CURRENT) || \
defined(CONFIG_THROTTLE_AP_ON_BAT_VOLTAGE)
void throttle_ap(enum throttle_level level,
enum throttle_type type,
enum throttle_sources source);
#else
static inline void throttle_ap(enum throttle_level level,
enum throttle_type type,
enum throttle_sources source)
{}
#endif
#endif /* __CROS_EC_THROTTLE_AP_H */