[deliverable/linux.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

/**
 * 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.
 * @optional: The supply should be considered optional. 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;
	bool optional;
	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_can_change_voltage(struct regulator *regulator);
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_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_can_change_voltage(struct regulator *regulator)
{
	return 0;
}

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_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
7179569a HS	122
	123	/**
	124	* struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
	125	*
	126	* @old_uV: Current voltage before change.
	127	* @min_uV: Min voltage we'll change to.
	128	* @max_uV: Max voltage we'll change to.
	129	*/
	130	struct pre_voltage_change_data {
	131	unsigned long old_uV;
	132	unsigned long min_uV;
	133	unsigned long max_uV;
	134	};
e2ce4eaa LG	135
	136	struct regulator;
	137
	138	/**
	139	* struct regulator_bulk_data - Data used for bulk regulator operations.
	140	*
69279fb9 MB	141	* @supply: The name of the supply. Initialised by the user before
69279fb9 MB	142	* using the bulk regulator APIs.
3ff3f518 BA	143	* @optional: The supply should be considered optional. Initialised by the user
3ff3f518 BA	144	* before using the bulk regulator APIs.
69279fb9 MB	145	* @consumer: The regulator consumer for the supply. This will be managed
69279fb9 MB	146	* by the bulk API.
e2ce4eaa LG	147	*
	148	* The regulator APIs provide a series of regulator_bulk_() API calls as
	149	* a convenience to consumers which require multiple supplies. This
	150	* structure is used to manage data for these calls.
	151	*/
	152	struct regulator_bulk_data {
	153	const char *supply;
3ff3f518	154	bool optional;
e2ce4eaa	155	struct regulator *consumer;
f21e0e81	156
bff747c5	157	/* private: Internal use */
f21e0e81	158	int ret;
e2ce4eaa LG	159	};
	160
	161	#if defined(CONFIG_REGULATOR)
	162
	163	/* regulator get and put */
	164	struct regulator __must_check regulator_get(struct device dev,
	165	const char *id);
070b9079 SB	166	struct regulator __must_check devm_regulator_get(struct device dev,
070b9079 SB	167	const char *id);
5ffbd136 MB	168	struct regulator __must_check regulator_get_exclusive(struct device dev,
5ffbd136 MB	169	const char *id);
9efdd276 MK	170	struct regulator __must_check devm_regulator_get_exclusive(struct device dev,
9efdd276 MK	171	const char *id);
de1dd9fd MB	172	struct regulator __must_check regulator_get_optional(struct device dev,
	173	const char *id);
	174	struct regulator __must_check devm_regulator_get_optional(struct device dev,
	175	const char *id);
e2ce4eaa	176	void regulator_put(struct regulator *regulator);
2950c4bb	177	void devm_regulator_put(struct regulator *regulator);
e2ce4eaa	178
a06ccd9c CK	179	int regulator_register_supply_alias(struct device dev, const char id,
	180	struct device *alias_dev,
	181	const char *alias_id);
	182	void regulator_unregister_supply_alias(struct device dev, const char id);
	183
9f8c0fe9 LJ	184	int regulator_bulk_register_supply_alias(struct device *dev,
9f8c0fe9 LJ	185	const char const id,
a06ccd9c	186	struct device *alias_dev,
9f8c0fe9 LJ	187	const char const alias_id,
9f8c0fe9 LJ	188	int num_id);
a06ccd9c	189	void regulator_bulk_unregister_supply_alias(struct device *dev,
9f8c0fe9	190	const char * const *id, int num_id);
a06ccd9c CK	191
	192	int devm_regulator_register_supply_alias(struct device dev, const char id,
	193	struct device *alias_dev,
	194	const char *alias_id);
	195	void devm_regulator_unregister_supply_alias(struct device *dev,
	196	const char *id);
	197
	198	int devm_regulator_bulk_register_supply_alias(struct device *dev,
9f8c0fe9	199	const char const id,
a06ccd9c	200	struct device *alias_dev,
9f8c0fe9	201	const char const alias_id,
a06ccd9c CK	202	int num_id);
a06ccd9c CK	203	void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
9f8c0fe9	204	const char const id,
a06ccd9c CK	205	int num_id);
a06ccd9c CK	206
e2ce4eaa	207	/* regulator output control and status */
c8801a8e	208	int __must_check regulator_enable(struct regulator *regulator);
e2ce4eaa LG	209	int regulator_disable(struct regulator *regulator);
	210	int regulator_force_disable(struct regulator *regulator);
	211	int regulator_is_enabled(struct regulator *regulator);
da07ecd9	212	int regulator_disable_deferred(struct regulator *regulator, int ms);
e2ce4eaa	213
c8801a8e MB	214	int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
	215	struct regulator_bulk_data *consumers);
	216	int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
	217	struct regulator_bulk_data *consumers);
	218	int __must_check regulator_bulk_enable(int num_consumers,
	219	struct regulator_bulk_data *consumers);
e2ce4eaa LG	220	int regulator_bulk_disable(int num_consumers,
e2ce4eaa LG	221	struct regulator_bulk_data *consumers);
e1de2f42 DK	222	int regulator_bulk_force_disable(int num_consumers,
e1de2f42 DK	223	struct regulator_bulk_data *consumers);
e2ce4eaa LG	224	void regulator_bulk_free(int num_consumers,
	225	struct regulator_bulk_data *consumers);
	226
ec4c4366	227	int regulator_can_change_voltage(struct regulator *regulator);
4367cfdc DB	228	int regulator_count_voltages(struct regulator *regulator);
4367cfdc DB	229	int regulator_list_voltage(struct regulator *regulator, unsigned selector);
a7a1ad90 MB	230	int regulator_is_supported_voltage(struct regulator *regulator,
a7a1ad90 MB	231	int min_uV, int max_uV);
2a668a8b	232	unsigned int regulator_get_linear_step(struct regulator *regulator);
e2ce4eaa	233	int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
88cd222b LW	234	int regulator_set_voltage_time(struct regulator *regulator,
88cd222b LW	235	int old_uV, int new_uV);
e2ce4eaa	236	int regulator_get_voltage(struct regulator *regulator);
606a2562	237	int regulator_sync_voltage(struct regulator *regulator);
e2ce4eaa LG	238	int regulator_set_current_limit(struct regulator *regulator,
	239	int min_uA, int max_uA);
	240	int regulator_get_current_limit(struct regulator *regulator);
	241
	242	int regulator_set_mode(struct regulator *regulator, unsigned int mode);
	243	unsigned int regulator_get_mode(struct regulator *regulator);
e39ce48f	244	int regulator_set_load(struct regulator *regulator, int load_uA);
e2ce4eaa	245
f59c8f9f MB	246	int regulator_allow_bypass(struct regulator *regulator, bool allow);
f59c8f9f MB	247
04eca28c TT	248	struct regmap regulator_get_regmap(struct regulator regulator);
	249	int regulator_get_hardware_vsel_register(struct regulator *regulator,
	250	unsigned *vsel_reg,
	251	unsigned *vsel_mask);
	252	int regulator_list_hardware_vsel(struct regulator *regulator,
	253	unsigned selector);
	254
e2ce4eaa LG	255	/* regulator notifier block */
	256	int regulator_register_notifier(struct regulator *regulator,
	257	struct notifier_block *nb);
046db763 CK	258	int devm_regulator_register_notifier(struct regulator *regulator,
046db763 CK	259	struct notifier_block *nb);
e2ce4eaa LG	260	int regulator_unregister_notifier(struct regulator *regulator,
e2ce4eaa LG	261	struct notifier_block *nb);
046db763 CK	262	void devm_regulator_unregister_notifier(struct regulator *regulator,
046db763 CK	263	struct notifier_block *nb);
e2ce4eaa LG	264
	265	/* driver data - core doesn't touch */
	266	void regulator_get_drvdata(struct regulator regulator);
	267	void regulator_set_drvdata(struct regulator regulator, void data);
	268
	269	#else
	270
	271	/*
	272	* Make sure client drivers will still build on systems with no software
	273	* controllable voltage or current regulators.
	274	*/
	275	static inline struct regulator __must_check regulator_get(struct device dev,
	276	const char *id)
	277	{
	278	/* Nothing except the stubbed out regulator API should be
	279	* looking at the value except to check if it is an error
be1a50d4 JD	280	* value. Drivers are free to handle NULL specifically by
	281	* skipping all regulator API calls, but they don't have to.
	282	* Drivers which don't, should make sure they properly handle
	283	* corner cases of the API, such as regulator_get_voltage()
	284	* returning 0.
e2ce4eaa	285	*/
be1a50d4	286	return NULL;
e2ce4eaa	287	}
070b9079 SB	288
	289	static inline struct regulator *__must_check
	290	devm_regulator_get(struct device dev, const char id)
	291	{
	292	return NULL;
	293	}
	294
4bdfb272 MB	295	static inline struct regulator *__must_check
	296	regulator_get_exclusive(struct device dev, const char id)
	297	{
70b946f9	298	return ERR_PTR(-ENODEV);
4bdfb272 MB	299	}
4bdfb272 MB	300
de1dd9fd MB	301	static inline struct regulator *__must_check
	302	regulator_get_optional(struct device dev, const char id)
	303	{
df7926ff	304	return ERR_PTR(-ENODEV);
de1dd9fd MB	305	}
de1dd9fd MB	306
4bdfb272	307
070b9079	308	static inline struct regulator *__must_check
de1dd9fd	309	devm_regulator_get_optional(struct device dev, const char id)
070b9079	310	{
df7926ff	311	return ERR_PTR(-ENODEV);
070b9079 SB	312	}
070b9079 SB	313
e2ce4eaa LG	314	static inline void regulator_put(struct regulator *regulator)
	315	{
	316	}
	317
2950c4bb AL	318	static inline void devm_regulator_put(struct regulator *regulator)
	319	{
	320	}
	321
a06ccd9c CK	322	static inline int regulator_register_supply_alias(struct device *dev,
	323	const char *id,
	324	struct device *alias_dev,
	325	const char *alias_id)
	326	{
	327	return 0;
	328	}
	329
	330	static inline void regulator_unregister_supply_alias(struct device *dev,
	331	const char *id)
	332	{
	333	}
	334
	335	static inline int regulator_bulk_register_supply_alias(struct device *dev,
9f8c0fe9 LJ	336	const char const id,
	337	struct device *alias_dev,
	338	const char * const *alias_id,
	339	int num_id)
a06ccd9c CK	340	{
	341	return 0;
	342	}
	343
	344	static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
9f8c0fe9 LJ	345	const char * const *id,
9f8c0fe9 LJ	346	int num_id)
a06ccd9c CK	347	{
	348	}
	349
	350	static inline int devm_regulator_register_supply_alias(struct device *dev,
	351	const char *id,
	352	struct device *alias_dev,
	353	const char *alias_id)
	354	{
	355	return 0;
	356	}
	357
	358	static inline void devm_regulator_unregister_supply_alias(struct device *dev,
	359	const char *id)
	360	{
	361	}
	362
9f8c0fe9 LJ	363	static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
	364	const char const id,
	365	struct device *alias_dev,
	366	const char const alias_id,
	367	int num_id)
a06ccd9c CK	368	{
	369	return 0;
	370	}
	371
	372	static inline void devm_regulator_bulk_unregister_supply_alias(
9f8c0fe9	373	struct device dev, const char const *id, int num_id)
a06ccd9c CK	374	{
	375	}
	376
e2ce4eaa LG	377	static inline int regulator_enable(struct regulator *regulator)
	378	{
	379	return 0;
	380	}
	381
	382	static inline int regulator_disable(struct regulator *regulator)
	383	{
	384	return 0;
	385	}
	386
935a5210 MH	387	static inline int regulator_force_disable(struct regulator *regulator)
	388	{
	389	return 0;
	390	}
	391
da07ecd9 MB	392	static inline int regulator_disable_deferred(struct regulator *regulator,
	393	int ms)
	394	{
	395	return 0;
	396	}
	397
e2ce4eaa LG	398	static inline int regulator_is_enabled(struct regulator *regulator)
	399	{
	400	return 1;
	401	}
	402
	403	static inline int regulator_bulk_get(struct device *dev,
	404	int num_consumers,
	405	struct regulator_bulk_data *consumers)
	406	{
	407	return 0;
	408	}
	409
e24abd6e AL	410	static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
	411	struct regulator_bulk_data *consumers)
	412	{
	413	return 0;
	414	}
	415
e2ce4eaa LG	416	static inline int regulator_bulk_enable(int num_consumers,
	417	struct regulator_bulk_data *consumers)
	418	{
	419	return 0;
	420	}
	421
	422	static inline int regulator_bulk_disable(int num_consumers,
	423	struct regulator_bulk_data *consumers)
	424	{
	425	return 0;
	426	}
	427
e1de2f42 DK	428	static inline int regulator_bulk_force_disable(int num_consumers,
	429	struct regulator_bulk_data *consumers)
	430	{
	431	return 0;
	432	}
	433
e2ce4eaa LG	434	static inline void regulator_bulk_free(int num_consumers,
	435	struct regulator_bulk_data *consumers)
	436	{
	437	}
	438
ec4c4366	439	static inline int regulator_can_change_voltage(struct regulator *regulator)
b14903e1 AB	440	{
	441	return 0;
	442	}
e2ce4eaa LG	443
	444	static inline int regulator_set_voltage(struct regulator *regulator,
	445	int min_uV, int max_uV)
	446	{
	447	return 0;
	448	}
	449
d660e92a VK	450	static inline int regulator_set_voltage_time(struct regulator *regulator,
	451	int old_uV, int new_uV)
	452	{
	453	return 0;
	454	}
	455
e2ce4eaa LG	456	static inline int regulator_get_voltage(struct regulator *regulator)
e2ce4eaa LG	457	{
08aed2f6	458	return -EINVAL;
e2ce4eaa LG	459	}
e2ce4eaa LG	460
4fe23791 PR	461	static inline int regulator_is_supported_voltage(struct regulator *regulator,
	462	int min_uV, int max_uV)
	463	{
	464	return 0;
	465	}
	466
e2ce4eaa LG	467	static inline int regulator_set_current_limit(struct regulator *regulator,
	468	int min_uA, int max_uA)
	469	{
	470	return 0;
	471	}
	472
	473	static inline int regulator_get_current_limit(struct regulator *regulator)
	474	{
	475	return 0;
	476	}
	477
	478	static inline int regulator_set_mode(struct regulator *regulator,
	479	unsigned int mode)
	480	{
	481	return 0;
	482	}
	483
	484	static inline unsigned int regulator_get_mode(struct regulator *regulator)
	485	{
	486	return REGULATOR_MODE_NORMAL;
	487	}
	488
e39ce48f	489	static inline int regulator_set_load(struct regulator *regulator, int load_uA)
e2ce4eaa LG	490	{
	491	return REGULATOR_MODE_NORMAL;
	492	}
	493
f59c8f9f MB	494	static inline int regulator_allow_bypass(struct regulator *regulator,
	495	bool allow)
	496	{
	497	return 0;
	498	}
	499
3bc0312e	500	static inline struct regmap regulator_get_regmap(struct regulator regulator)
04eca28c TT	501	{
	502	return ERR_PTR(-EOPNOTSUPP);
	503	}
	504
3bc0312e MB	505	static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,
	506	unsigned *vsel_reg,
	507	unsigned *vsel_mask)
04eca28c TT	508	{
	509	return -EOPNOTSUPP;
	510	}
	511
3bc0312e MB	512	static inline int regulator_list_hardware_vsel(struct regulator *regulator,
3bc0312e MB	513	unsigned selector)
04eca28c TT	514	{
	515	return -EOPNOTSUPP;
	516	}
	517
e2ce4eaa LG	518	static inline int regulator_register_notifier(struct regulator *regulator,
	519	struct notifier_block *nb)
	520	{
	521	return 0;
	522	}
	523
046db763 CK	524	static inline int devm_regulator_register_notifier(struct regulator *regulator,
	525	struct notifier_block *nb)
	526	{
	527	return 0;
	528	}
	529
e2ce4eaa LG	530	static inline int regulator_unregister_notifier(struct regulator *regulator,
	531	struct notifier_block *nb)
	532	{
	533	return 0;
	534	}
	535
046db763 CK	536	static inline int devm_regulator_unregister_notifier(struct regulator *regulator,
	537	struct notifier_block *nb)
	538	{
	539	return 0;
	540	}
	541
e2ce4eaa LG	542	static inline void regulator_get_drvdata(struct regulator regulator)
	543	{
	544	return NULL;
	545	}
	546
	547	static inline void regulator_set_drvdata(struct regulator *regulator,
	548	void *data)
	549	{
	550	}
	551
1a8f85d4 PR	552	static inline int regulator_count_voltages(struct regulator *regulator)
	553	{
	554	return 0;
	555	}
5127e31a SP	556
	557	static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)
	558	{
	559	return -EINVAL;
	560	}
	561
e2ce4eaa LG	562	#endif
e2ce4eaa LG	563
30f93ca8 VK	564	static inline int regulator_set_voltage_triplet(struct regulator *regulator,
	565	int min_uV, int target_uV,
	566	int max_uV)
	567	{
	568	if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)
	569	return 0;
	570
	571	return regulator_set_voltage(regulator, min_uV, max_uV);
	572	}
	573
3f196577 SG	574	static inline int regulator_set_voltage_tol(struct regulator *regulator,
	575	int new_uV, int tol_uV)
	576	{
dc9ceed6 MB	577	if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
	578	return 0;
	579	else
	580	return regulator_set_voltage(regulator,
	581	new_uV - tol_uV, new_uV + tol_uV);
3f196577 SG	582	}
3f196577 SG	583
fe1e43f7 MB	584	static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
	585	int target_uV, int tol_uV)
	586	{
	587	return regulator_is_supported_voltage(regulator,
	588	target_uV - tol_uV,
	589	target_uV + tol_uV);
	590	}
	591
e2ce4eaa	592	#endif