[mirror_ubuntu-artful-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/device.h>

/*
 * 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.
 * DISABLE        Regulator was disabled.
 *
 * 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

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 regulator_get_exclusive(struct device *dev,
						       const char *id);
void regulator_put(struct regulator *regulator);

/* regulator output control and status */
int 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 regulator_bulk_get(struct device *dev, int num_consumers,
		       struct regulator_bulk_data *consumers);
int regulator_bulk_enable(int num_consumers,
			  struct regulator_bulk_data *consumers);
int regulator_bulk_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);
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);

/* 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 void regulator_put(struct regulator *regulator)
{
}

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

static inline int regulator_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 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 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_get_voltage(struct regulator *regulator)
{
	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_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)
{
}

#endif

#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
b56daf13 LG	38	#include <linux/device.h>
b56daf13 LG	39
e2ce4eaa LG	40	/*
	41	* Regulator operating modes.
	42	*
	43	* Regulators can run in a variety of different operating modes depending on
	44	* output load. This allows further system power savings by selecting the
	45	* best (and most efficient) regulator mode for a desired load.
	46	*
	47	* Most drivers will only care about NORMAL. The modes below are generic and
	48	* will probably not match the naming convention of your regulator data sheet
	49	* but should match the use cases in the datasheet.
	50	*
	51	* In order of power efficiency (least efficient at top).
	52	*
	53	* Mode Description
	54	* FAST Regulator can handle fast changes in it's load.
	55	* e.g. useful in CPU voltage & frequency scaling where
	56	* load can quickly increase with CPU frequency increases.
	57	*
	58	* NORMAL Normal regulator power supply mode. Most drivers will
	59	* use this mode.
	60	*
	61	* IDLE Regulator runs in a more efficient mode for light
	62	* loads. Can be used for devices that have a low power
	63	* requirement during periods of inactivity. This mode
	64	* may be more noisy than NORMAL and may not be able
	65	* to handle fast load switching.
	66	*
	67	* STANDBY Regulator runs in the most efficient mode for very
	68	* light loads. Can be used by devices when they are
	69	* in a sleep/standby state. This mode is likely to be
	70	* the most noisy and may not be able to handle fast load
	71	* switching.
	72	*
	73	* NOTE: Most regulators will only support a subset of these modes. Some
	74	* will only just support NORMAL.
	75	*
	76	* These modes can be OR'ed together to make up a mask of valid register modes.
	77	*/
	78
	79	#define REGULATOR_MODE_FAST 0x1
	80	#define REGULATOR_MODE_NORMAL 0x2
	81	#define REGULATOR_MODE_IDLE 0x4
	82	#define REGULATOR_MODE_STANDBY 0x8
	83
	84	/*
	85	* Regulator notifier events.
	86	*
	87	* UNDER_VOLTAGE Regulator output is under voltage.
	88	* OVER_CURRENT Regulator output current is too high.
	89	* REGULATION_OUT Regulator output is out of regulation.
	90	* FAIL Regulator output has failed.
	91	* OVER_TEMP Regulator over temp.
84b68263	92	* FORCE_DISABLE Regulator forcibly shut down by software.
b136fb44	93	* VOLTAGE_CHANGE Regulator voltage changed.
84b68263	94	* DISABLE Regulator was disabled.
e2ce4eaa LG	95	*
	96	* NOTE: These events can be OR'ed together when passed into handler.
	97	*/
	98
	99	#define REGULATOR_EVENT_UNDER_VOLTAGE 0x01
	100	#define REGULATOR_EVENT_OVER_CURRENT 0x02
	101	#define REGULATOR_EVENT_REGULATION_OUT 0x04
	102	#define REGULATOR_EVENT_FAIL 0x08
	103	#define REGULATOR_EVENT_OVER_TEMP 0x10
	104	#define REGULATOR_EVENT_FORCE_DISABLE 0x20
b136fb44	105	#define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
84b68263	106	#define REGULATOR_EVENT_DISABLE 0x80
e2ce4eaa LG	107
	108	struct regulator;
	109
	110	/**
	111	* struct regulator_bulk_data - Data used for bulk regulator operations.
	112	*
69279fb9 MB	113	* @supply: The name of the supply. Initialised by the user before
	114	* using the bulk regulator APIs.
	115	* @consumer: The regulator consumer for the supply. This will be managed
	116	* by the bulk API.
e2ce4eaa LG	117	*
	118	* The regulator APIs provide a series of regulator_bulk_() API calls as
	119	* a convenience to consumers which require multiple supplies. This
	120	* structure is used to manage data for these calls.
	121	*/
	122	struct regulator_bulk_data {
	123	const char *supply;
	124	struct regulator *consumer;
f21e0e81	125
bff747c5	126	/* private: Internal use */
f21e0e81	127	int ret;
e2ce4eaa LG	128	};
	129
	130	#if defined(CONFIG_REGULATOR)
	131
	132	/* regulator get and put */
	133	struct regulator __must_check regulator_get(struct device dev,
	134	const char *id);
5ffbd136 MB	135	struct regulator __must_check regulator_get_exclusive(struct device dev,
5ffbd136 MB	136	const char *id);
e2ce4eaa LG	137	void regulator_put(struct regulator *regulator);
	138
	139	/* regulator output control and status */
	140	int regulator_enable(struct regulator *regulator);
	141	int regulator_disable(struct regulator *regulator);
	142	int regulator_force_disable(struct regulator *regulator);
	143	int regulator_is_enabled(struct regulator *regulator);
da07ecd9	144	int regulator_disable_deferred(struct regulator *regulator, int ms);
e2ce4eaa LG	145
	146	int regulator_bulk_get(struct device *dev, int num_consumers,
	147	struct regulator_bulk_data *consumers);
	148	int regulator_bulk_enable(int num_consumers,
	149	struct regulator_bulk_data *consumers);
	150	int regulator_bulk_disable(int num_consumers,
	151	struct regulator_bulk_data *consumers);
	152	void regulator_bulk_free(int num_consumers,
	153	struct regulator_bulk_data *consumers);
	154
4367cfdc DB	155	int regulator_count_voltages(struct regulator *regulator);
4367cfdc DB	156	int regulator_list_voltage(struct regulator *regulator, unsigned selector);
a7a1ad90 MB	157	int regulator_is_supported_voltage(struct regulator *regulator,
a7a1ad90 MB	158	int min_uV, int max_uV);
e2ce4eaa	159	int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
88cd222b LW	160	int regulator_set_voltage_time(struct regulator *regulator,
88cd222b LW	161	int old_uV, int new_uV);
e2ce4eaa	162	int regulator_get_voltage(struct regulator *regulator);
606a2562	163	int regulator_sync_voltage(struct regulator *regulator);
e2ce4eaa LG	164	int regulator_set_current_limit(struct regulator *regulator,
	165	int min_uA, int max_uA);
	166	int regulator_get_current_limit(struct regulator *regulator);
	167
	168	int regulator_set_mode(struct regulator *regulator, unsigned int mode);
	169	unsigned int regulator_get_mode(struct regulator *regulator);
	170	int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
	171
	172	/* regulator notifier block */
	173	int regulator_register_notifier(struct regulator *regulator,
	174	struct notifier_block *nb);
	175	int regulator_unregister_notifier(struct regulator *regulator,
	176	struct notifier_block *nb);
	177
	178	/* driver data - core doesn't touch */
	179	void regulator_get_drvdata(struct regulator regulator);
	180	void regulator_set_drvdata(struct regulator regulator, void data);
	181
	182	#else
	183
	184	/*
	185	* Make sure client drivers will still build on systems with no software
	186	* controllable voltage or current regulators.
	187	*/
	188	static inline struct regulator __must_check regulator_get(struct device dev,
	189	const char *id)
	190	{
	191	/* Nothing except the stubbed out regulator API should be
	192	* looking at the value except to check if it is an error
be1a50d4 JD	193	* value. Drivers are free to handle NULL specifically by
	194	* skipping all regulator API calls, but they don't have to.
	195	* Drivers which don't, should make sure they properly handle
	196	* corner cases of the API, such as regulator_get_voltage()
	197	* returning 0.
e2ce4eaa	198	*/
be1a50d4	199	return NULL;
e2ce4eaa LG	200	}
	201	static inline void regulator_put(struct regulator *regulator)
	202	{
	203	}
	204
	205	static inline int regulator_enable(struct regulator *regulator)
	206	{
	207	return 0;
	208	}
	209
	210	static inline int regulator_disable(struct regulator *regulator)
	211	{
	212	return 0;
	213	}
	214
da07ecd9 MB	215	static inline int regulator_disable_deferred(struct regulator *regulator,
	216	int ms)
	217	{
	218	return 0;
	219	}
	220
e2ce4eaa LG	221	static inline int regulator_is_enabled(struct regulator *regulator)
	222	{
	223	return 1;
	224	}
	225
	226	static inline int regulator_bulk_get(struct device *dev,
	227	int num_consumers,
	228	struct regulator_bulk_data *consumers)
	229	{
	230	return 0;
	231	}
	232
	233	static inline int regulator_bulk_enable(int num_consumers,
	234	struct regulator_bulk_data *consumers)
	235	{
	236	return 0;
	237	}
	238
	239	static inline int regulator_bulk_disable(int num_consumers,
	240	struct regulator_bulk_data *consumers)
	241	{
	242	return 0;
	243	}
	244
	245	static inline void regulator_bulk_free(int num_consumers,
	246	struct regulator_bulk_data *consumers)
	247	{
	248	}
	249
	250	static inline int regulator_set_voltage(struct regulator *regulator,
	251	int min_uV, int max_uV)
	252	{
	253	return 0;
	254	}
	255
	256	static inline int regulator_get_voltage(struct regulator *regulator)
	257	{
	258	return 0;
	259	}
	260
	261	static inline int regulator_set_current_limit(struct regulator *regulator,
	262	int min_uA, int max_uA)
	263	{
	264	return 0;
	265	}
	266
	267	static inline int regulator_get_current_limit(struct regulator *regulator)
	268	{
	269	return 0;
	270	}
	271
	272	static inline int regulator_set_mode(struct regulator *regulator,
	273	unsigned int mode)
	274	{
	275	return 0;
	276	}
	277
	278	static inline unsigned int regulator_get_mode(struct regulator *regulator)
	279	{
	280	return REGULATOR_MODE_NORMAL;
	281	}
	282
	283	static inline int regulator_set_optimum_mode(struct regulator *regulator,
	284	int load_uA)
285	{
286	return REGULATOR_MODE_NORMAL;
287	}
288
289	static inline int regulator_register_notifier(struct regulator *regulator,
290	struct notifier_block *nb)
291	{
292	return 0;
293	}
294
295	static inline int regulator_unregister_notifier(struct regulator *regulator,
296	struct notifier_block *nb)
297	{
298	return 0;
299	}
300
301	static inline void regulator_get_drvdata(struct regulator regulator)
302	{
303	return NULL;
304	}
305
306	static inline void regulator_set_drvdata(struct regulator *regulator,
307	void *data)
308	{
309	}
310
311	#endif
312
313	#endif