[mirror_ubuntu-bionic-kernel.git] / include / linux / regulator / consumer.h

/*
 * consumer.h -- SoC Regulator consumer support.
 *
 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
 *
 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
 *
 * This program 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.
 *
 * Regulator Consumer Interface.
 *
 * A Power Management Regulator framework for SoC based devices.
 * Features:-
 *   o Voltage and current level control.
 *   o Operating mode control.
 *   o Regulator status.
 *   o sysfs entries for showing client devices and status
 *
 * EXPERIMENTAL FEATURES:
 *   Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
 *   to use most efficient operating mode depending upon voltage and load and
 *   is transparent to client drivers.
 *
 *   e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
 *   IO and 1mA at idle. Device z draws 100mA when under load and 5mA when
 *   idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
 *   but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
 *   efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
 *   in normal mode for loads > 10mA and in IDLE mode for load <= 10mA.
 *
 */

#ifndef __LINUX_REGULATOR_CONSUMER_H_
#define __LINUX_REGULATOR_CONSUMER_H_

#include <linux/err.h>

struct device;
struct notifier_block;
struct regmap;

/*
 * Regulator operating modes.
 *
 * Regulators can run in a variety of different operating modes depending on
 * output load. This allows further system power savings by selecting the
 * best (and most efficient) regulator mode for a desired load.
 *
 * Most drivers will only care about NORMAL. The modes below are generic and
 * will probably not match the naming convention of your regulator data sheet
 * but should match the use cases in the datasheet.
 *
 * In order of power efficiency (least efficient at top).
 *
 *  Mode       Description
 *  FAST       Regulator can handle fast changes in it's load.
 *             e.g. useful in CPU voltage & frequency scaling where
 *             load can quickly increase with CPU frequency increases.
 *
 *  NORMAL     Normal regulator power supply mode. Most drivers will
 *             use this mode.
 *
 *  IDLE       Regulator runs in a more efficient mode for light
 *             loads. Can be used for devices that have a low power
 *             requirement during periods of inactivity. This mode
 *             may be more noisy than NORMAL and may not be able
 *             to handle fast load switching.
 *
 *  STANDBY    Regulator runs in the most efficient mode for very
 *             light loads. Can be used by devices when they are
 *             in a sleep/standby state. This mode is likely to be
 *             the most noisy and may not be able to handle fast load
 *             switching.
 *
 * NOTE: Most regulators will only support a subset of these modes. Some
 * will only just support NORMAL.
 *
 * These modes can be OR'ed together to make up a mask of valid register modes.
 */

#define REGULATOR_MODE_FAST			0x1
#define REGULATOR_MODE_NORMAL			0x2
#define REGULATOR_MODE_IDLE			0x4
#define REGULATOR_MODE_STANDBY			0x8

/*
 * Regulator notifier events.
 *
 * UNDER_VOLTAGE  Regulator output is under voltage.
 * OVER_CURRENT   Regulator output current is too high.
 * REGULATION_OUT Regulator output is out of regulation.
 * FAIL           Regulator output has failed.
 * OVER_TEMP      Regulator over temp.
 * FORCE_DISABLE  Regulator forcibly shut down by software.
 * VOLTAGE_CHANGE Regulator voltage changed.
 *                Data passed is old voltage cast to (void *).
 * DISABLE        Regulator was disabled.
 * PRE_VOLTAGE_CHANGE   Regulator is about to have voltage changed.
 *                      Data passed is "struct pre_voltage_change_data"
 * ABORT_VOLTAGE_CHANGE Regulator voltage change failed for some reason.
 *                      Data passed is old voltage cast to (void *).
 * PRE_DISABLE    Regulator is about to be disabled
 * ABORT_DISABLE  Regulator disable failed for some reason
 *
 * NOTE: These events can be OR'ed together when passed into handler.
 */

#define REGULATOR_EVENT_UNDER_VOLTAGE		0x01
#define REGULATOR_EVENT_OVER_CURRENT		0x02
#define REGULATOR_EVENT_REGULATION_OUT		0x04
#define REGULATOR_EVENT_FAIL			0x08
#define REGULATOR_EVENT_OVER_TEMP		0x10
#define REGULATOR_EVENT_FORCE_DISABLE		0x20
#define REGULATOR_EVENT_VOLTAGE_CHANGE		0x40
#define REGULATOR_EVENT_DISABLE			0x80
#define REGULATOR_EVENT_PRE_VOLTAGE_CHANGE	0x100
#define REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE	0x200
#define REGULATOR_EVENT_PRE_DISABLE		0x400
#define REGULATOR_EVENT_ABORT_DISABLE		0x800
#define REGULATOR_EVENT_ENABLE			0x1000

/*
 * Regulator errors that can be queried using regulator_get_error_flags
 *
 * UNDER_VOLTAGE  Regulator output is under voltage.
 * OVER_CURRENT   Regulator output current is too high.
 * REGULATION_OUT Regulator output is out of regulation.
 * FAIL           Regulator output has failed.
 * OVER_TEMP      Regulator over temp.
 *
 * NOTE: These errors can be OR'ed together.
 */

#define REGULATOR_ERROR_UNDER_VOLTAGE		BIT(1)
#define REGULATOR_ERROR_OVER_CURRENT		BIT(2)
#define REGULATOR_ERROR_REGULATION_OUT		BIT(3)
#define REGULATOR_ERROR_FAIL			BIT(4)
#define REGULATOR_ERROR_OVER_TEMP		BIT(5)


/**
 * struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
 *
 * @old_uV: Current voltage before change.
 * @min_uV: Min voltage we'll change to.
 * @max_uV: Max voltage we'll change to.
 */
struct pre_voltage_change_data {
	unsigned long old_uV;
	unsigned long min_uV;
	unsigned long max_uV;
};

struct regulator;

/**
 * struct regulator_bulk_data - Data used for bulk regulator operations.
 *
 * @supply:   The name of the supply.  Initialised by the user before
 *            using the bulk regulator APIs.
 * @consumer: The regulator consumer for the supply.  This will be managed
 *            by the bulk API.
 *
 * The regulator APIs provide a series of regulator_bulk_() API calls as
 * a convenience to consumers which require multiple supplies.  This
 * structure is used to manage data for these calls.
 */
struct regulator_bulk_data {
	const char *supply;
	struct regulator *consumer;

	/* private: Internal use */
	int ret;
};

#if defined(CONFIG_REGULATOR)

/* regulator get and put */
struct regulator *__must_check regulator_get(struct device *dev,
					     const char *id);
struct regulator *__must_check devm_regulator_get(struct device *dev,
					     const char *id);
struct regulator *__must_check regulator_get_exclusive(struct device *dev,
						       const char *id);
struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
							const char *id);
struct regulator *__must_check regulator_get_optional(struct device *dev,
						      const char *id);
struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
							   const char *id);
void regulator_put(struct regulator *regulator);
void devm_regulator_put(struct regulator *regulator);

int regulator_register_supply_alias(struct device *dev, const char *id,
				    struct device *alias_dev,
				    const char *alias_id);
void regulator_unregister_supply_alias(struct device *dev, const char *id);

int regulator_bulk_register_supply_alias(struct device *dev,
					 const char *const *id,
					 struct device *alias_dev,
					 const char *const *alias_id,
					 int num_id);
void regulator_bulk_unregister_supply_alias(struct device *dev,
					    const char * const *id, int num_id);

int devm_regulator_register_supply_alias(struct device *dev, const char *id,
					 struct device *alias_dev,
					 const char *alias_id);
void devm_regulator_unregister_supply_alias(struct device *dev,
					    const char *id);

int devm_regulator_bulk_register_supply_alias(struct device *dev,
					      const char *const *id,
					      struct device *alias_dev,
					      const char *const *alias_id,
					      int num_id);
void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
						 const char *const *id,
						 int num_id);

/* regulator output control and status */
int __must_check regulator_enable(struct regulator *regulator);
int regulator_disable(struct regulator *regulator);
int regulator_force_disable(struct regulator *regulator);
int regulator_is_enabled(struct regulator *regulator);
int regulator_disable_deferred(struct regulator *regulator, int ms);

int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
				    struct regulator_bulk_data *consumers);
int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
					 struct regulator_bulk_data *consumers);
int __must_check regulator_bulk_enable(int num_consumers,
				       struct regulator_bulk_data *consumers);
int regulator_bulk_disable(int num_consumers,
			   struct regulator_bulk_data *consumers);
int regulator_bulk_force_disable(int num_consumers,
			   struct regulator_bulk_data *consumers);
void regulator_bulk_free(int num_consumers,
			 struct regulator_bulk_data *consumers);

int regulator_count_voltages(struct regulator *regulator);
int regulator_list_voltage(struct regulator *regulator, unsigned selector);
int regulator_is_supported_voltage(struct regulator *regulator,
				   int min_uV, int max_uV);
unsigned int regulator_get_linear_step(struct regulator *regulator);
int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
int regulator_set_voltage_time(struct regulator *regulator,
			       int old_uV, int new_uV);
int regulator_get_voltage(struct regulator *regulator);
int regulator_sync_voltage(struct regulator *regulator);
int regulator_set_current_limit(struct regulator *regulator,
			       int min_uA, int max_uA);
int regulator_get_current_limit(struct regulator *regulator);

int regulator_set_mode(struct regulator *regulator, unsigned int mode);
unsigned int regulator_get_mode(struct regulator *regulator);
int regulator_get_error_flags(struct regulator *regulator,
				unsigned int *flags);
int regulator_set_load(struct regulator *regulator, int load_uA);

int regulator_allow_bypass(struct regulator *regulator, bool allow);

struct regmap *regulator_get_regmap(struct regulator *regulator);
int regulator_get_hardware_vsel_register(struct regulator *regulator,
					 unsigned *vsel_reg,
					 unsigned *vsel_mask);
int regulator_list_hardware_vsel(struct regulator *regulator,
				 unsigned selector);

/* regulator notifier block */
int regulator_register_notifier(struct regulator *regulator,
			      struct notifier_block *nb);
int devm_regulator_register_notifier(struct regulator *regulator,
				     struct notifier_block *nb);
int regulator_unregister_notifier(struct regulator *regulator,
				struct notifier_block *nb);
void devm_regulator_unregister_notifier(struct regulator *regulator,
					struct notifier_block *nb);

/* driver data - core doesn't touch */
void *regulator_get_drvdata(struct regulator *regulator);
void regulator_set_drvdata(struct regulator *regulator, void *data);

#else

/*
 * Make sure client drivers will still build on systems with no software
 * controllable voltage or current regulators.
 */
static inline struct regulator *__must_check regulator_get(struct device *dev,
	const char *id)
{
	/* Nothing except the stubbed out regulator API should be
	 * looking at the value except to check if it is an error
	 * value. Drivers are free to handle NULL specifically by
	 * skipping all regulator API calls, but they don't have to.
	 * Drivers which don't, should make sure they properly handle
	 * corner cases of the API, such as regulator_get_voltage()
	 * returning 0.
	 */
	return NULL;
}

static inline struct regulator *__must_check
devm_regulator_get(struct device *dev, const char *id)
{
	return NULL;
}

static inline struct regulator *__must_check
regulator_get_exclusive(struct device *dev, const char *id)
{
	return ERR_PTR(-ENODEV);
}

static inline struct regulator *__must_check
regulator_get_optional(struct device *dev, const char *id)
{
	return ERR_PTR(-ENODEV);
}


static inline struct regulator *__must_check
devm_regulator_get_optional(struct device *dev, const char *id)
{
	return ERR_PTR(-ENODEV);
}

static inline void regulator_put(struct regulator *regulator)
{
}

static inline void devm_regulator_put(struct regulator *regulator)
{
}

static inline int regulator_register_supply_alias(struct device *dev,
						  const char *id,
						  struct device *alias_dev,
						  const char *alias_id)
{
	return 0;
}

static inline void regulator_unregister_supply_alias(struct device *dev,
						    const char *id)
{
}

static inline int regulator_bulk_register_supply_alias(struct device *dev,
						const char *const *id,
						struct device *alias_dev,
						const char * const *alias_id,
						int num_id)
{
	return 0;
}

static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
						const char * const *id,
						int num_id)
{
}

static inline int devm_regulator_register_supply_alias(struct device *dev,
						       const char *id,
						       struct device *alias_dev,
						       const char *alias_id)
{
	return 0;
}

static inline void devm_regulator_unregister_supply_alias(struct device *dev,
							  const char *id)
{
}

static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
						const char *const *id,
						struct device *alias_dev,
						const char *const *alias_id,
						int num_id)
{
	return 0;
}

static inline void devm_regulator_bulk_unregister_supply_alias(
	struct device *dev, const char *const *id, int num_id)
{
}

static inline int regulator_enable(struct regulator *regulator)
{
	return 0;
}

static inline int regulator_disable(struct regulator *regulator)
{
	return 0;
}

static inline int regulator_force_disable(struct regulator *regulator)
{
	return 0;
}

static inline int regulator_disable_deferred(struct regulator *regulator,
					     int ms)
{
	return 0;
}

static inline int regulator_is_enabled(struct regulator *regulator)
{
	return 1;
}

static inline int regulator_bulk_get(struct device *dev,
				     int num_consumers,
				     struct regulator_bulk_data *consumers)
{
	return 0;
}

static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
					  struct regulator_bulk_data *consumers)
{
	return 0;
}

static inline int regulator_bulk_enable(int num_consumers,
					struct regulator_bulk_data *consumers)
{
	return 0;
}

static inline int regulator_bulk_disable(int num_consumers,
					 struct regulator_bulk_data *consumers)
{
	return 0;
}

static inline int regulator_bulk_force_disable(int num_consumers,
					struct regulator_bulk_data *consumers)
{
	return 0;
}

static inline void regulator_bulk_free(int num_consumers,
				       struct regulator_bulk_data *consumers)
{
}

static inline int regulator_set_voltage(struct regulator *regulator,
					int min_uV, int max_uV)
{
	return 0;
}

static inline int regulator_set_voltage_time(struct regulator *regulator,
					     int old_uV, int new_uV)
{
	return 0;
}

static inline int regulator_get_voltage(struct regulator *regulator)
{
	return -EINVAL;
}

static inline int regulator_is_supported_voltage(struct regulator *regulator,
				   int min_uV, int max_uV)
{
	return 0;
}

static inline int regulator_set_current_limit(struct regulator *regulator,
					     int min_uA, int max_uA)
{
	return 0;
}

static inline int regulator_get_current_limit(struct regulator *regulator)
{
	return 0;
}

static inline int regulator_set_mode(struct regulator *regulator,
	unsigned int mode)
{
	return 0;
}

static inline unsigned int regulator_get_mode(struct regulator *regulator)
{
	return REGULATOR_MODE_NORMAL;
}

static inline int regulator_get_error_flags(struct regulator *regulator,
					    unsigned int *flags)
{
	return -EINVAL;
}

static inline int regulator_set_load(struct regulator *regulator, int load_uA)
{
	return REGULATOR_MODE_NORMAL;
}

static inline int regulator_allow_bypass(struct regulator *regulator,
					 bool allow)
{
	return 0;
}

static inline struct regmap *regulator_get_regmap(struct regulator *regulator)
{
	return ERR_PTR(-EOPNOTSUPP);
}

static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,
						       unsigned *vsel_reg,
						       unsigned *vsel_mask)
{
	return -EOPNOTSUPP;
}

static inline int regulator_list_hardware_vsel(struct regulator *regulator,
					       unsigned selector)
{
	return -EOPNOTSUPP;
}

static inline int regulator_register_notifier(struct regulator *regulator,
			      struct notifier_block *nb)
{
	return 0;
}

static inline int devm_regulator_register_notifier(struct regulator *regulator,
						   struct notifier_block *nb)
{
	return 0;
}

static inline int regulator_unregister_notifier(struct regulator *regulator,
				struct notifier_block *nb)
{
	return 0;
}

static inline int devm_regulator_unregister_notifier(struct regulator *regulator,
						     struct notifier_block *nb)
{
	return 0;
}

static inline void *regulator_get_drvdata(struct regulator *regulator)
{
	return NULL;
}

static inline void regulator_set_drvdata(struct regulator *regulator,
	void *data)
{
}

static inline int regulator_count_voltages(struct regulator *regulator)
{
	return 0;
}

static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)
{
	return -EINVAL;
}

#endif

static inline int regulator_set_voltage_triplet(struct regulator *regulator,
						int min_uV, int target_uV,
						int max_uV)
{
	if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)
		return 0;

	return regulator_set_voltage(regulator, min_uV, max_uV);
}

static inline int regulator_set_voltage_tol(struct regulator *regulator,
					    int new_uV, int tol_uV)
{
	if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
		return 0;
	else
		return regulator_set_voltage(regulator,
					     new_uV - tol_uV, new_uV + tol_uV);
}

static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
						     int target_uV, int tol_uV)
{
	return regulator_is_supported_voltage(regulator,
					      target_uV - tol_uV,
					      target_uV + tol_uV);
}

#endif
Commit	Line	Data
e2ce4eaa LG	1	/*
	2	* consumer.h -- SoC Regulator consumer support.
	3	*
	4	* Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
	5	*
1dd68f01	6	* Author: Liam Girdwood <lrg@slimlogic.co.uk>
e2ce4eaa LG	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*
	12	* Regulator Consumer Interface.
	13	*
	14	* A Power Management Regulator framework for SoC based devices.
	15	* Features:-
	16	* o Voltage and current level control.
	17	* o Operating mode control.
	18	* o Regulator status.
	19	* o sysfs entries for showing client devices and status
	20	*
	21	* EXPERIMENTAL FEATURES:
	22	* Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
	23	* to use most efficient operating mode depending upon voltage and load and
	24	* is transparent to client drivers.
	25	*
	26	* e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
	27	* IO and 1mA at idle. Device z draws 100mA when under load and 5mA when
	28	* idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
	29	* but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
	30	* efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
	31	* in normal mode for loads > 10mA and in IDLE mode for load <= 10mA.
	32	*
	33	*/
	34
	35	#ifndef __LINUX_REGULATOR_CONSUMER_H_
	36	#define __LINUX_REGULATOR_CONSUMER_H_
	37
174e964e GR	38	#include <linux/err.h>
174e964e GR	39
313162d0 PG	40	struct device;
313162d0 PG	41	struct notifier_block;
04eca28c	42	struct regmap;
b56daf13	43
e2ce4eaa LG	44	/*
	45	* Regulator operating modes.
	46	*
	47	* Regulators can run in a variety of different operating modes depending on
	48	* output load. This allows further system power savings by selecting the
	49	* best (and most efficient) regulator mode for a desired load.
	50	*
	51	* Most drivers will only care about NORMAL. The modes below are generic and
	52	* will probably not match the naming convention of your regulator data sheet
	53	* but should match the use cases in the datasheet.
	54	*
	55	* In order of power efficiency (least efficient at top).
	56	*
	57	* Mode Description
	58	* FAST Regulator can handle fast changes in it's load.
	59	* e.g. useful in CPU voltage & frequency scaling where
	60	* load can quickly increase with CPU frequency increases.
	61	*
	62	* NORMAL Normal regulator power supply mode. Most drivers will
	63	* use this mode.
	64	*
	65	* IDLE Regulator runs in a more efficient mode for light
	66	* loads. Can be used for devices that have a low power
	67	* requirement during periods of inactivity. This mode
	68	* may be more noisy than NORMAL and may not be able
	69	* to handle fast load switching.
	70	*
	71	* STANDBY Regulator runs in the most efficient mode for very
	72	* light loads. Can be used by devices when they are
	73	* in a sleep/standby state. This mode is likely to be
	74	* the most noisy and may not be able to handle fast load
	75	* switching.
	76	*
	77	* NOTE: Most regulators will only support a subset of these modes. Some
	78	* will only just support NORMAL.
	79	*
	80	* These modes can be OR'ed together to make up a mask of valid register modes.
	81	*/
	82
	83	#define REGULATOR_MODE_FAST 0x1
	84	#define REGULATOR_MODE_NORMAL 0x2
	85	#define REGULATOR_MODE_IDLE 0x4
	86	#define REGULATOR_MODE_STANDBY 0x8
	87
	88	/*
	89	* Regulator notifier events.
	90	*
	91	* UNDER_VOLTAGE Regulator output is under voltage.
	92	* OVER_CURRENT Regulator output current is too high.
	93	* REGULATION_OUT Regulator output is out of regulation.
	94	* FAIL Regulator output has failed.
	95	* OVER_TEMP Regulator over temp.
84b68263	96	* FORCE_DISABLE Regulator forcibly shut down by software.
b136fb44	97	* VOLTAGE_CHANGE Regulator voltage changed.
7179569a	98	* Data passed is old voltage cast to (void *).
84b68263	99	* DISABLE Regulator was disabled.
7179569a HS	100	* PRE_VOLTAGE_CHANGE Regulator is about to have voltage changed.
	101	* Data passed is "struct pre_voltage_change_data"
	102	* ABORT_VOLTAGE_CHANGE Regulator voltage change failed for some reason.
	103	* Data passed is old voltage cast to (void *).
a1c8a551 RF	104	* PRE_DISABLE Regulator is about to be disabled
a1c8a551 RF	105	* ABORT_DISABLE Regulator disable failed for some reason
e2ce4eaa LG	106	*
	107	* NOTE: These events can be OR'ed together when passed into handler.
	108	*/
	109
	110	#define REGULATOR_EVENT_UNDER_VOLTAGE 0x01
	111	#define REGULATOR_EVENT_OVER_CURRENT 0x02
	112	#define REGULATOR_EVENT_REGULATION_OUT 0x04
	113	#define REGULATOR_EVENT_FAIL 0x08
	114	#define REGULATOR_EVENT_OVER_TEMP 0x10
	115	#define REGULATOR_EVENT_FORCE_DISABLE 0x20
b136fb44	116	#define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
5c9e7196	117	#define REGULATOR_EVENT_DISABLE 0x80
7179569a HS	118	#define REGULATOR_EVENT_PRE_VOLTAGE_CHANGE 0x100
7179569a HS	119	#define REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE 0x200
a1c8a551 RF	120	#define REGULATOR_EVENT_PRE_DISABLE 0x400
a1c8a551 RF	121	#define REGULATOR_EVENT_ABORT_DISABLE 0x800
264b88c9	122	#define REGULATOR_EVENT_ENABLE 0x1000
7179569a	123
1b5b4221 AH	124	/*
	125	* Regulator errors that can be queried using regulator_get_error_flags
	126	*
	127	* UNDER_VOLTAGE Regulator output is under voltage.
	128	* OVER_CURRENT Regulator output current is too high.
	129	* REGULATION_OUT Regulator output is out of regulation.
	130	* FAIL Regulator output has failed.
	131	* OVER_TEMP Regulator over temp.
	132	*
	133	* NOTE: These errors can be OR'ed together.
	134	*/
	135
	136	#define REGULATOR_ERROR_UNDER_VOLTAGE BIT(1)
	137	#define REGULATOR_ERROR_OVER_CURRENT BIT(2)
	138	#define REGULATOR_ERROR_REGULATION_OUT BIT(3)
	139	#define REGULATOR_ERROR_FAIL BIT(4)
	140	#define REGULATOR_ERROR_OVER_TEMP BIT(5)
	141
	142
7179569a HS	143	/**
	144	* struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
	145	*
	146	* @old_uV: Current voltage before change.
	147	* @min_uV: Min voltage we'll change to.
	148	* @max_uV: Max voltage we'll change to.
	149	*/
	150	struct pre_voltage_change_data {
	151	unsigned long old_uV;
	152	unsigned long min_uV;
	153	unsigned long max_uV;
	154	};
e2ce4eaa LG	155
	156	struct regulator;
	157
	158	/**
	159	* struct regulator_bulk_data - Data used for bulk regulator operations.
	160	*
69279fb9 MB	161	* @supply: The name of the supply. Initialised by the user before
	162	* using the bulk regulator APIs.
	163	* @consumer: The regulator consumer for the supply. This will be managed
	164	* by the bulk API.
e2ce4eaa LG	165	*
	166	* The regulator APIs provide a series of regulator_bulk_() API calls as
	167	* a convenience to consumers which require multiple supplies. This
	168	* structure is used to manage data for these calls.
	169	*/
	170	struct regulator_bulk_data {
	171	const char *supply;
	172	struct regulator *consumer;
f21e0e81	173
bff747c5	174	/* private: Internal use */
f21e0e81	175	int ret;
e2ce4eaa LG	176	};
	177
	178	#if defined(CONFIG_REGULATOR)
	179
	180	/* regulator get and put */
	181	struct regulator __must_check regulator_get(struct device dev,
	182	const char *id);
070b9079 SB	183	struct regulator __must_check devm_regulator_get(struct device dev,
070b9079 SB	184	const char *id);
5ffbd136 MB	185	struct regulator __must_check regulator_get_exclusive(struct device dev,
5ffbd136 MB	186	const char *id);
9efdd276 MK	187	struct regulator __must_check devm_regulator_get_exclusive(struct device dev,
9efdd276 MK	188	const char *id);
de1dd9fd MB	189	struct regulator __must_check regulator_get_optional(struct device dev,
	190	const char *id);
	191	struct regulator __must_check devm_regulator_get_optional(struct device dev,
	192	const char *id);
e2ce4eaa	193	void regulator_put(struct regulator *regulator);
2950c4bb	194	void devm_regulator_put(struct regulator *regulator);
e2ce4eaa	195
a06ccd9c CK	196	int regulator_register_supply_alias(struct device dev, const char id,
	197	struct device *alias_dev,
	198	const char *alias_id);
	199	void regulator_unregister_supply_alias(struct device dev, const char id);
	200
9f8c0fe9 LJ	201	int regulator_bulk_register_supply_alias(struct device *dev,
9f8c0fe9 LJ	202	const char const id,
a06ccd9c	203	struct device *alias_dev,
9f8c0fe9 LJ	204	const char const alias_id,
9f8c0fe9 LJ	205	int num_id);
a06ccd9c	206	void regulator_bulk_unregister_supply_alias(struct device *dev,
9f8c0fe9	207	const char * const *id, int num_id);
a06ccd9c CK	208
	209	int devm_regulator_register_supply_alias(struct device dev, const char id,
	210	struct device *alias_dev,
	211	const char *alias_id);
	212	void devm_regulator_unregister_supply_alias(struct device *dev,
	213	const char *id);
	214
	215	int devm_regulator_bulk_register_supply_alias(struct device *dev,
9f8c0fe9	216	const char const id,
a06ccd9c	217	struct device *alias_dev,
9f8c0fe9	218	const char const alias_id,
a06ccd9c CK	219	int num_id);
a06ccd9c CK	220	void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
9f8c0fe9	221	const char const id,
a06ccd9c CK	222	int num_id);
a06ccd9c CK	223
e2ce4eaa	224	/* regulator output control and status */
c8801a8e	225	int __must_check regulator_enable(struct regulator *regulator);
e2ce4eaa LG	226	int regulator_disable(struct regulator *regulator);
	227	int regulator_force_disable(struct regulator *regulator);
	228	int regulator_is_enabled(struct regulator *regulator);
da07ecd9	229	int regulator_disable_deferred(struct regulator *regulator, int ms);
e2ce4eaa	230
c8801a8e MB	231	int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
	232	struct regulator_bulk_data *consumers);
	233	int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
	234	struct regulator_bulk_data *consumers);
	235	int __must_check regulator_bulk_enable(int num_consumers,
	236	struct regulator_bulk_data *consumers);
e2ce4eaa LG	237	int regulator_bulk_disable(int num_consumers,
e2ce4eaa LG	238	struct regulator_bulk_data *consumers);
e1de2f42 DK	239	int regulator_bulk_force_disable(int num_consumers,
e1de2f42 DK	240	struct regulator_bulk_data *consumers);
e2ce4eaa LG	241	void regulator_bulk_free(int num_consumers,
	242	struct regulator_bulk_data *consumers);
	243
4367cfdc DB	244	int regulator_count_voltages(struct regulator *regulator);
4367cfdc DB	245	int regulator_list_voltage(struct regulator *regulator, unsigned selector);
a7a1ad90 MB	246	int regulator_is_supported_voltage(struct regulator *regulator,
a7a1ad90 MB	247	int min_uV, int max_uV);
2a668a8b	248	unsigned int regulator_get_linear_step(struct regulator *regulator);
e2ce4eaa	249	int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
88cd222b LW	250	int regulator_set_voltage_time(struct regulator *regulator,
88cd222b LW	251	int old_uV, int new_uV);
e2ce4eaa	252	int regulator_get_voltage(struct regulator *regulator);
606a2562	253	int regulator_sync_voltage(struct regulator *regulator);
e2ce4eaa LG	254	int regulator_set_current_limit(struct regulator *regulator,
	255	int min_uA, int max_uA);
	256	int regulator_get_current_limit(struct regulator *regulator);
	257
	258	int regulator_set_mode(struct regulator *regulator, unsigned int mode);
	259	unsigned int regulator_get_mode(struct regulator *regulator);
1b5b4221 AH	260	int regulator_get_error_flags(struct regulator *regulator,
1b5b4221 AH	261	unsigned int *flags);
e39ce48f	262	int regulator_set_load(struct regulator *regulator, int load_uA);
e2ce4eaa	263
f59c8f9f MB	264	int regulator_allow_bypass(struct regulator *regulator, bool allow);
f59c8f9f MB	265
04eca28c TT	266	struct regmap regulator_get_regmap(struct regulator regulator);
	267	int regulator_get_hardware_vsel_register(struct regulator *regulator,
	268	unsigned *vsel_reg,
	269	unsigned *vsel_mask);
	270	int regulator_list_hardware_vsel(struct regulator *regulator,
	271	unsigned selector);
	272
e2ce4eaa LG	273	/* regulator notifier block */
	274	int regulator_register_notifier(struct regulator *regulator,
	275	struct notifier_block *nb);
046db763 CK	276	int devm_regulator_register_notifier(struct regulator *regulator,
046db763 CK	277	struct notifier_block *nb);
e2ce4eaa LG	278	int regulator_unregister_notifier(struct regulator *regulator,
e2ce4eaa LG	279	struct notifier_block *nb);
046db763 CK	280	void devm_regulator_unregister_notifier(struct regulator *regulator,
046db763 CK	281	struct notifier_block *nb);
e2ce4eaa LG	282
	283	/* driver data - core doesn't touch */
	284	void regulator_get_drvdata(struct regulator regulator);
	285	void regulator_set_drvdata(struct regulator regulator, void data);
	286
	287	#else
	288
	289	/*
	290	* Make sure client drivers will still build on systems with no software
	291	* controllable voltage or current regulators.
	292	*/
	293	static inline struct regulator __must_check regulator_get(struct device dev,
	294	const char *id)
	295	{
	296	/* Nothing except the stubbed out regulator API should be
	297	* looking at the value except to check if it is an error
be1a50d4 JD	298	* value. Drivers are free to handle NULL specifically by
	299	* skipping all regulator API calls, but they don't have to.
	300	* Drivers which don't, should make sure they properly handle
	301	* corner cases of the API, such as regulator_get_voltage()
	302	* returning 0.
e2ce4eaa	303	*/
be1a50d4	304	return NULL;
e2ce4eaa	305	}
070b9079 SB	306
	307	static inline struct regulator *__must_check
	308	devm_regulator_get(struct device dev, const char id)
	309	{
	310	return NULL;
	311	}
	312
4bdfb272 MB	313	static inline struct regulator *__must_check
	314	regulator_get_exclusive(struct device dev, const char id)
	315	{
70b946f9	316	return ERR_PTR(-ENODEV);
4bdfb272 MB	317	}
4bdfb272 MB	318
de1dd9fd MB	319	static inline struct regulator *__must_check
	320	regulator_get_optional(struct device dev, const char id)
	321	{
df7926ff	322	return ERR_PTR(-ENODEV);
de1dd9fd MB	323	}
de1dd9fd MB	324
4bdfb272	325
070b9079	326	static inline struct regulator *__must_check
de1dd9fd	327	devm_regulator_get_optional(struct device dev, const char id)
070b9079	328	{
df7926ff	329	return ERR_PTR(-ENODEV);
070b9079 SB	330	}
070b9079 SB	331
e2ce4eaa LG	332	static inline void regulator_put(struct regulator *regulator)
	333	{
	334	}
	335
2950c4bb AL	336	static inline void devm_regulator_put(struct regulator *regulator)
	337	{
	338	}
	339
a06ccd9c CK	340	static inline int regulator_register_supply_alias(struct device *dev,
	341	const char *id,
	342	struct device *alias_dev,
	343	const char *alias_id)
	344	{
	345	return 0;
	346	}
	347
	348	static inline void regulator_unregister_supply_alias(struct device *dev,
	349	const char *id)
	350	{
	351	}
	352
	353	static inline int regulator_bulk_register_supply_alias(struct device *dev,
9f8c0fe9 LJ	354	const char const id,
	355	struct device *alias_dev,
	356	const char * const *alias_id,
	357	int num_id)
a06ccd9c CK	358	{
	359	return 0;
	360	}
	361
	362	static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
9f8c0fe9 LJ	363	const char * const *id,
9f8c0fe9 LJ	364	int num_id)
a06ccd9c CK	365	{
	366	}
	367
	368	static inline int devm_regulator_register_supply_alias(struct device *dev,
	369	const char *id,
	370	struct device *alias_dev,
	371	const char *alias_id)
	372	{
	373	return 0;
	374	}
	375
	376	static inline void devm_regulator_unregister_supply_alias(struct device *dev,
	377	const char *id)
	378	{
	379	}
	380
9f8c0fe9 LJ	381	static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
	382	const char const id,
	383	struct device *alias_dev,
	384	const char const alias_id,
	385	int num_id)
a06ccd9c CK	386	{
	387	return 0;
	388	}
	389
	390	static inline void devm_regulator_bulk_unregister_supply_alias(
9f8c0fe9	391	struct device dev, const char const *id, int num_id)
a06ccd9c CK	392	{
	393	}
	394
e2ce4eaa LG	395	static inline int regulator_enable(struct regulator *regulator)
	396	{
	397	return 0;
	398	}
	399
	400	static inline int regulator_disable(struct regulator *regulator)
	401	{
	402	return 0;
	403	}
	404
935a5210 MH	405	static inline int regulator_force_disable(struct regulator *regulator)
	406	{
	407	return 0;
	408	}
	409
da07ecd9 MB	410	static inline int regulator_disable_deferred(struct regulator *regulator,
	411	int ms)
	412	{
	413	return 0;
	414	}
	415
e2ce4eaa LG	416	static inline int regulator_is_enabled(struct regulator *regulator)
	417	{
	418	return 1;
	419	}
	420
	421	static inline int regulator_bulk_get(struct device *dev,
	422	int num_consumers,
	423	struct regulator_bulk_data *consumers)
	424	{
	425	return 0;
	426	}
	427
e24abd6e AL	428	static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
	429	struct regulator_bulk_data *consumers)
	430	{
	431	return 0;
	432	}
	433
e2ce4eaa LG	434	static inline int regulator_bulk_enable(int num_consumers,
	435	struct regulator_bulk_data *consumers)
	436	{
	437	return 0;
	438	}
	439
	440	static inline int regulator_bulk_disable(int num_consumers,
	441	struct regulator_bulk_data *consumers)
	442	{
	443	return 0;
	444	}
	445
e1de2f42 DK	446	static inline int regulator_bulk_force_disable(int num_consumers,
	447	struct regulator_bulk_data *consumers)
	448	{
	449	return 0;
	450	}
	451
e2ce4eaa LG	452	static inline void regulator_bulk_free(int num_consumers,
	453	struct regulator_bulk_data *consumers)
	454	{
	455	}
	456
	457	static inline int regulator_set_voltage(struct regulator *regulator,
	458	int min_uV, int max_uV)
	459	{
	460	return 0;
	461	}
	462
d660e92a VK	463	static inline int regulator_set_voltage_time(struct regulator *regulator,
	464	int old_uV, int new_uV)
	465	{
	466	return 0;
	467	}
	468
e2ce4eaa LG	469	static inline int regulator_get_voltage(struct regulator *regulator)
e2ce4eaa LG	470	{
08aed2f6	471	return -EINVAL;
e2ce4eaa LG	472	}
e2ce4eaa LG	473
4fe23791 PR	474	static inline int regulator_is_supported_voltage(struct regulator *regulator,
	475	int min_uV, int max_uV)
	476	{
	477	return 0;
	478	}
	479
e2ce4eaa LG	480	static inline int regulator_set_current_limit(struct regulator *regulator,
	481	int min_uA, int max_uA)
	482	{
	483	return 0;
	484	}
	485
	486	static inline int regulator_get_current_limit(struct regulator *regulator)
	487	{
	488	return 0;
	489	}
	490
	491	static inline int regulator_set_mode(struct regulator *regulator,
	492	unsigned int mode)
	493	{
	494	return 0;
	495	}
	496
	497	static inline unsigned int regulator_get_mode(struct regulator *regulator)
	498	{
	499	return REGULATOR_MODE_NORMAL;
	500	}
	501
30103b5b DL	502	static inline int regulator_get_error_flags(struct regulator *regulator,
30103b5b DL	503	unsigned int *flags)
1b5b4221 AH	504	{
	505	return -EINVAL;
	506	}
	507
e39ce48f	508	static inline int regulator_set_load(struct regulator *regulator, int load_uA)
e2ce4eaa LG	509	{
	510	return REGULATOR_MODE_NORMAL;
	511	}
	512
f59c8f9f MB	513	static inline int regulator_allow_bypass(struct regulator *regulator,
	514	bool allow)
	515	{
	516	return 0;
	517	}
	518
3bc0312e	519	static inline struct regmap regulator_get_regmap(struct regulator regulator)
04eca28c TT	520	{
	521	return ERR_PTR(-EOPNOTSUPP);
	522	}
	523
3bc0312e MB	524	static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,
	525	unsigned *vsel_reg,
	526	unsigned *vsel_mask)
04eca28c TT	527	{
	528	return -EOPNOTSUPP;
	529	}
	530
3bc0312e MB	531	static inline int regulator_list_hardware_vsel(struct regulator *regulator,
3bc0312e MB	532	unsigned selector)
04eca28c TT	533	{
	534	return -EOPNOTSUPP;
	535	}
	536
e2ce4eaa LG	537	static inline int regulator_register_notifier(struct regulator *regulator,
	538	struct notifier_block *nb)
	539	{
	540	return 0;
	541	}
	542
046db763 CK	543	static inline int devm_regulator_register_notifier(struct regulator *regulator,
	544	struct notifier_block *nb)
	545	{
	546	return 0;
	547	}
	548
e2ce4eaa LG	549	static inline int regulator_unregister_notifier(struct regulator *regulator,
	550	struct notifier_block *nb)
	551	{
	552	return 0;
	553	}
	554
046db763 CK	555	static inline int devm_regulator_unregister_notifier(struct regulator *regulator,
	556	struct notifier_block *nb)
	557	{
	558	return 0;
	559	}
	560
e2ce4eaa LG	561	static inline void regulator_get_drvdata(struct regulator regulator)
	562	{
	563	return NULL;
	564	}
	565
	566	static inline void regulator_set_drvdata(struct regulator *regulator,
	567	void *data)
	568	{
	569	}
	570
1a8f85d4 PR	571	static inline int regulator_count_voltages(struct regulator *regulator)
	572	{
	573	return 0;
	574	}
5127e31a SP	575
	576	static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)
	577	{
	578	return -EINVAL;
	579	}
	580
e2ce4eaa LG	581	#endif
e2ce4eaa LG	582
30f93ca8 VK	583	static inline int regulator_set_voltage_triplet(struct regulator *regulator,
	584	int min_uV, int target_uV,
	585	int max_uV)
	586	{
	587	if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)
	588	return 0;
	589
	590	return regulator_set_voltage(regulator, min_uV, max_uV);
	591	}
	592
3f196577 SG	593	static inline int regulator_set_voltage_tol(struct regulator *regulator,
	594	int new_uV, int tol_uV)
	595	{
dc9ceed6 MB	596	if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
	597	return 0;
	598	else
	599	return regulator_set_voltage(regulator,
	600	new_uV - tol_uV, new_uV + tol_uV);
3f196577 SG	601	}
3f196577 SG	602
fe1e43f7 MB	603	static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
	604	int target_uV, int tol_uV)
	605	{
	606	return regulator_is_supported_voltage(regulator,
	607	target_uV - tol_uV,
	608	target_uV + tol_uV);
	609	}
	610
e2ce4eaa	611	#endif