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 <lrg@slimlogic.co.uk> 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 21struct 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 system states 45 * 46 * This describes a regulators state during a system wide low power 47 * state. One of enabled or disabled must be set for the 48 * configuration to be applied. 49 * 50 * @uV: Operating voltage during suspend. 51 * @mode: Operating mode during suspend. 52 * @enabled: Enabled during suspend. 53 * @disabled: Disabled during suspend. 54 */ 55struct regulator_state { 56 int uV; /* suspend voltage */ 57 unsigned int mode; /* suspend regulator operating mode */ 58 int enabled; /* is regulator enabled in this suspend state */ 59 int disabled; /* is the regulator disbled in this suspend state */ 60}; 61 62/** 63 * struct regulation_constraints - regulator operating constraints. 64 * 65 * This struct describes regulator and board/machine specific constraints. 66 * 67 * @name: Descriptive name for the constraints, used for display purposes. 68 * 69 * @min_uV: Smallest voltage consumers may set. 70 * @max_uV: Largest voltage consumers may set. 71 * 72 * @min_uA: Smallest consumers consumers may set. 73 * @max_uA: Largest current consumers may set. 74 * 75 * @valid_modes_mask: Mask of modes which may be configured by consumers. 76 * @valid_ops_mask: Operations which may be performed by consumers. 77 * 78 * @always_on: Set if the regulator should never be disabled. 79 * @boot_on: Set if the regulator is enabled when the system is initially 80 * started. If the regulator is not enabled by the hardware or 81 * bootloader then it will be enabled when the constraints are 82 * applied. 83 * @apply_uV: Apply the voltage constraint when initialising. 84 * 85 * @input_uV: Input voltage for regulator when supplied by another regulator. 86 * 87 * @state_disk: State for regulator when system is suspended in disk mode. 88 * @state_mem: State for regulator when system is suspended in mem mode. 89 * @state_standby: State for regulator when system is suspended in standby 90 * mode. 91 * @initial_state: Suspend state to set by default. 92 * @initial_mode: Mode to set at startup. 93 */ 94struct regulation_constraints { 95 96 char *name; 97 98 /* voltage output range (inclusive) - for voltage control */ 99 int min_uV; 100 int max_uV; 101 102 /* current output range (inclusive) - for current control */ 103 int min_uA; 104 int max_uA; 105 106 /* valid regulator operating modes for this machine */ 107 unsigned int valid_modes_mask; 108 109 /* valid operations for regulator on this machine */ 110 unsigned int valid_ops_mask; 111 112 /* regulator input voltage - only if supply is another regulator */ 113 int input_uV; 114 115 /* regulator suspend states for global PMIC STANDBY/HIBERNATE */ 116 struct regulator_state state_disk; 117 struct regulator_state state_mem; 118 struct regulator_state state_standby; 119 suspend_state_t initial_state; /* suspend state to set at init */ 120 121 /* mode to set on startup */ 122 unsigned int initial_mode; 123 124 /* constraint flags */ 125 unsigned always_on:1; /* regulator never off when system is on */ 126 unsigned boot_on:1; /* bootloader/firmware enabled regulator */ 127 unsigned apply_uV:1; /* apply uV constraint if min == max */ 128}; 129 130/** 131 * struct regulator_consumer_supply - supply -> device mapping 132 * 133 * This maps a supply name to a device. Only one of dev or dev_name 134 * can be specified. Use of dev_name allows support for buses which 135 * make struct device available late such as I2C and is the preferred 136 * form. 137 * 138 * @dev: Device structure for the consumer. 139 * @dev_name: Result of dev_name() for the consumer. 140 * @supply: Name for the supply. 141 */ 142struct regulator_consumer_supply { 143 struct device *dev; /* consumer */ 144 const char *dev_name; /* dev_name() for consumer */ 145 const char *supply; /* consumer supply - e.g. "vcc" */ 146}; 147 148/* Initialize struct regulator_consumer_supply */ 149#define REGULATOR_SUPPLY(_name, _dev_name) \ 150{ \ 151 .supply = _name, \ 152 .dev_name = _dev_name, \ 153} 154 155/** 156 * struct regulator_init_data - regulator platform initialisation data. 157 * 158 * Initialisation constraints, our supply and consumers supplies. 159 * 160 * @supply_regulator: Parent regulator. Specified using the regulator name 161 * as it appears in the name field in sysfs, which can 162 * be explicitly set using the constraints field 'name'. 163 * @supply_regulator_dev: Parent regulator (if any) - DEPRECATED in favour 164 * of supply_regulator. 165 * 166 * @constraints: Constraints. These must be specified for the regulator to 167 * be usable. 168 * @num_consumer_supplies: Number of consumer device supplies. 169 * @consumer_supplies: Consumer device supply configuration. 170 * 171 * @regulator_init: Callback invoked when the regulator has been registered. 172 * @driver_data: Data passed to regulator_init. 173 */ 174struct regulator_init_data { 175 const char *supply_regulator; /* or NULL for system supply */ 176 struct device *supply_regulator_dev; /* or NULL for system supply */ 177 178 struct regulation_constraints constraints; 179 180 int num_consumer_supplies; 181 struct regulator_consumer_supply *consumer_supplies; 182 183 /* optional regulator machine specific init */ 184 int (*regulator_init)(void *driver_data); 185 void *driver_data; /* core does not touch this */ 186}; 187 188int regulator_suspend_prepare(suspend_state_t state); 189 190#ifdef CONFIG_REGULATOR 191void regulator_has_full_constraints(void); 192#else 193static inline void regulator_has_full_constraints(void) 194{ 195} 196#endif 197 198#endif 199