2 * machine.h -- SoC Regulator support, machine/board driver API.
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
6 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
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.
12 * Regulator Machine/Board Interface.
15 #ifndef __LINUX_REGULATOR_MACHINE_H_
16 #define __LINUX_REGULATOR_MACHINE_H_
18 #include <linux/regulator/consumer.h>
19 #include <linux/suspend.h>
24 * Regulator operation constraint flags. These flags are used to enable
25 * certain regulator operations and can be OR'ed together.
27 * VOLTAGE: Regulator output voltage can be changed by software on this
29 * CURRENT: Regulator output current can be changed by software on this
31 * MODE: Regulator operating mode can be changed by software on this
33 * STATUS: Regulator can be enabled and disabled.
34 * DRMS: Dynamic Regulator Mode Switching is enabled for this regulator.
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
44 * struct regulator_state - regulator state during low power syatem states
46 * This describes a regulators state during a system wide low power state.
48 * @uV: Operating voltage during suspend.
49 * @mode: Operating mode during suspend.
50 * @enabled: Enabled during suspend.
52 struct regulator_state
{
53 int uV
; /* suspend voltage */
54 unsigned int mode
; /* suspend regulator operating mode */
55 int enabled
; /* is regulator enabled in this suspend state */
59 * struct regulation_constraints - regulator operating constraints.
61 * This struct describes regulator and board/machine specific constraints.
63 * @name: Descriptive name for the constraints, used for display purposes.
65 * @min_uV: Smallest voltage consumers may set.
66 * @max_uV: Largest voltage consumers may set.
68 * @min_uA: Smallest consumers consumers may set.
69 * @max_uA: Largest current consumers may set.
71 * @valid_modes_mask: Mask of modes which may be configured by consumers.
72 * @valid_ops_mask: Operations which may be performed by consumers.
74 * @always_on: Set if the regulator should never be disabled.
75 * @boot_on: Set if the regulator is enabled when the system is initially
77 * @apply_uV: Apply the voltage constraint when initialising.
79 * @input_uV: Input voltage for regulator when supplied by another regulator.
81 * @state_disk: State for regulator when system is suspended in disk mode.
82 * @state_mem: State for regulator when system is suspended in mem mode.
83 * @state_standby: State for regulator when system is suspended in standby
85 * @initial_state: Suspend state to set by default.
87 struct regulation_constraints
{
91 /* voltage output range (inclusive) - for voltage control */
95 /* current output range (inclusive) - for current control */
99 /* valid regulator operating modes for this machine */
100 unsigned int valid_modes_mask
;
102 /* valid operations for regulator on this machine */
103 unsigned int valid_ops_mask
;
105 /* regulator input voltage - only if supply is another regulator */
108 /* regulator suspend states for global PMIC STANDBY/HIBERNATE */
109 struct regulator_state state_disk
;
110 struct regulator_state state_mem
;
111 struct regulator_state state_standby
;
112 suspend_state_t initial_state
; /* suspend state to set at init */
114 /* constriant flags */
115 unsigned always_on
:1; /* regulator never off when system is on */
116 unsigned boot_on
:1; /* bootloader/firmware enabled regulator */
117 unsigned apply_uV
:1; /* apply uV constraint iff min == max */
121 * struct regulator_consumer_supply - supply -> device mapping
123 * This maps a supply name to a device.
125 * @dev: Device structure for the consumer.
126 * @supply: Name for the supply.
128 struct regulator_consumer_supply
{
129 struct device
*dev
; /* consumer */
130 const char *supply
; /* consumer supply - e.g. "vcc" */
134 * struct regulator_init_data - regulator platform initialisation data.
136 * Initialisation constraints, our supply and consumers supplies.
138 * @supply_regulator_dev: Parent regulator (if any).
140 * @constraints: Constraints. These must be specified for the regulator to
142 * @num_consumer_supplies: Number of consumer device supplies.
143 * @consumer_supplies: Consumer device supply configuration.
145 * @regulator_init: Callback invoked when the regulator has been registered.
146 * @driver_data: Data passed to regulator_init.
148 struct regulator_init_data
{
149 struct device
*supply_regulator_dev
; /* or NULL for LINE */
151 struct regulation_constraints constraints
;
153 int num_consumer_supplies
;
154 struct regulator_consumer_supply
*consumer_supplies
;
156 /* optional regulator machine specific init */
157 int (*regulator_init
)(void *driver_data
);
158 void *driver_data
; /* core does not touch this */
161 int regulator_suspend_prepare(suspend_state_t state
);