[linux-2.6-block.git] / include / linux / regulator / machine.h

/*
 * machine.h -- SoC Regulator support, machine/board driver API.
 *
 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
 *
 * Author: Liam Girdwood <lg@opensource.wolfsonmicro.com>
 *
 * 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 Machine/Board Interface.
 */

#ifndef __LINUX_REGULATOR_MACHINE_H_
#define __LINUX_REGULATOR_MACHINE_H_

#include <linux/regulator/consumer.h>
#include <linux/suspend.h>

struct regulator;

/*
 * Regulator operation constraint flags. These flags are used to enable
 * certain regulator operations and can be OR'ed together.
 *
 * VOLTAGE:  Regulator output voltage can be changed by software on this
 *           board/machine.
 * CURRENT:  Regulator output current can be changed by software on this
 *           board/machine.
 * MODE:     Regulator operating mode can be changed by software on this
 *           board/machine.
 * STATUS:   Regulator can be enabled and disabled.
 * DRMS:     Dynamic Regulator Mode Switching is enabled for this regulator.
 */

#define REGULATOR_CHANGE_VOLTAGE	0x1
#define REGULATOR_CHANGE_CURRENT	0x2
#define REGULATOR_CHANGE_MODE		0x4
#define REGULATOR_CHANGE_STATUS		0x8
#define REGULATOR_CHANGE_DRMS		0x10

/**
 * struct regulator_state - regulator state during low power syatem states
 *
 * This describes a regulators state during a system wide low power state.
 */
struct regulator_state {
	int uV;	/* suspend voltage */
	unsigned int mode; /* suspend regulator operating mode */
	int enabled; /* is regulator enabled in this suspend state */
};

/**
 * struct regulation_constraints - regulator operating constraints.
 *
 * This struct describes regulator and board/machine specific constraints.
 */
struct regulation_constraints {

	char *name;

	/* voltage output range (inclusive) - for voltage control */
	int min_uV;
	int max_uV;

	/* current output range (inclusive) - for current control */
	int min_uA;
	int max_uA;

	/* valid regulator operating modes for this machine */
	unsigned int valid_modes_mask;

	/* valid operations for regulator on this machine */
	unsigned int valid_ops_mask;

	/* regulator input voltage - only if supply is another regulator */
	int input_uV;

	/* regulator suspend states for global PMIC STANDBY/HIBERNATE */
	struct regulator_state state_disk;
	struct regulator_state state_mem;
	struct regulator_state state_standby;
	suspend_state_t initial_state; /* suspend state to set at init */

	/* constriant flags */
	unsigned always_on:1;	/* regulator never off when system is on */
	unsigned boot_on:1;	/* bootloader/firmware enabled regulator */
	unsigned apply_uV:1;	/* apply uV constraint iff min == max */
};

/**
 * struct regulator_consumer_supply - supply -> device mapping
 *
 * This maps a supply name to a device.
 */
struct regulator_consumer_supply {
	struct device *dev;	/* consumer */
	const char *supply;	/* consumer supply - e.g. "vcc" */
};

/**
 * struct regulator_init_data - regulator platform initialisation data.
 *
 * Initialisation constraints, our supply and consumers supplies.
 */
struct regulator_init_data {
	struct device *supply_regulator_dev; /* or NULL for LINE */

	struct regulation_constraints constraints;

	int num_consumer_supplies;
	struct regulator_consumer_supply *consumer_supplies;

	/* optional regulator machine specific init */
	int (*regulator_init)(void *driver_data);
	void *driver_data;	/* core does not touch this */
};

int regulator_suspend_prepare(suspend_state_t state);

#endif
Commit	Line	Data
4c1184e8 LG	1	/*
	2	* machine.h -- SoC Regulator support, machine/board driver API.
	3	*
	4	* Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
	5	*
	6	* Author: Liam Girdwood <lg@opensource.wolfsonmicro.com>
	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 Machine/Board Interface.
	13	*/
	14
	15	#ifndef __LINUX_REGULATOR_MACHINE_H_
	16	#define __LINUX_REGULATOR_MACHINE_H_
	17
	18	#include <linux/regulator/consumer.h>
	19	#include <linux/suspend.h>
	20
	21	struct regulator;
	22
	23	/*
	24	* Regulator operation constraint flags. These flags are used to enable
	25	* certain regulator operations and can be OR'ed together.
	26	*
	27	* VOLTAGE: Regulator output voltage can be changed by software on this
	28	* board/machine.
	29	* CURRENT: Regulator output current can be changed by software on this
	30	* board/machine.
	31	* MODE: Regulator operating mode can be changed by software on this
	32	* board/machine.
	33	* STATUS: Regulator can be enabled and disabled.
	34	* DRMS: Dynamic Regulator Mode Switching is enabled for this regulator.
	35	*/
	36
	37	#define REGULATOR_CHANGE_VOLTAGE 0x1
	38	#define REGULATOR_CHANGE_CURRENT 0x2
	39	#define REGULATOR_CHANGE_MODE 0x4
	40	#define REGULATOR_CHANGE_STATUS 0x8
	41	#define REGULATOR_CHANGE_DRMS 0x10
	42
	43	/**
	44	* struct regulator_state - regulator state during low power syatem states
	45	*
	46	* This describes a regulators state during a system wide low power state.
	47	*/
	48	struct regulator_state {
	49	int uV; /* suspend voltage */
	50	unsigned int mode; /* suspend regulator operating mode */
	51	int enabled; /* is regulator enabled in this suspend state */
	52	};
	53
	54	/**
	55	* struct regulation_constraints - regulator operating constraints.
	56	*
	57	* This struct describes regulator and board/machine specific constraints.
	58	*/
	59	struct regulation_constraints {
	60
	61	char *name;
	62
	63	/* voltage output range (inclusive) - for voltage control */
	64	int min_uV;
65	int max_uV;
66
67	/* current output range (inclusive) - for current control */
68	int min_uA;
69	int max_uA;
70
71	/* valid regulator operating modes for this machine */
72	unsigned int valid_modes_mask;
73
74	/* valid operations for regulator on this machine */
75	unsigned int valid_ops_mask;
76
77	/* regulator input voltage - only if supply is another regulator */
78	int input_uV;
79
80	/* regulator suspend states for global PMIC STANDBY/HIBERNATE */
81	struct regulator_state state_disk;
82	struct regulator_state state_mem;
83	struct regulator_state state_standby;
84	suspend_state_t initial_state; /* suspend state to set at init */
85
86	/* constriant flags */
87	unsigned always_on:1; /* regulator never off when system is on */
88	unsigned boot_on:1; /* bootloader/firmware enabled regulator */
89	unsigned apply_uV:1; /* apply uV constraint iff min == max */
90	};
91
a5766f11 LG	92	/**
	93	* struct regulator_consumer_supply - supply -> device mapping
	94	*
	95	* This maps a supply name to a device.
	96	*/
	97	struct regulator_consumer_supply {
	98	struct device dev; / consumer */
	99	const char supply; / consumer supply - e.g. "vcc" */
	100	};
4c1184e8	101
a5766f11 LG	102	/**
	103	* struct regulator_init_data - regulator platform initialisation data.
	104	*
	105	* Initialisation constraints, our supply and consumers supplies.
	106	*/
	107	struct regulator_init_data {
	108	struct device supply_regulator_dev; / or NULL for LINE */
4c1184e8	109
a5766f11	110	struct regulation_constraints constraints;
4c1184e8	111
a5766f11 LG	112	int num_consumer_supplies;
	113	struct regulator_consumer_supply *consumer_supplies;
	114
	115	/* optional regulator machine specific init */
	116	int (regulator_init)(void driver_data);
	117	void driver_data; / core does not touch this */
	118	};
4c1184e8 LG	119
	120	int regulator_suspend_prepare(suspend_state_t state);
	121
	122	#endif