[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 *).
 *
 * 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

/**
 * 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_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_optimum_mode(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 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 NULL;
}

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_optimum_mode(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 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;
}
#endif

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