~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/regulator/machine.h

Version: ~ [ linux-5.14-rc3 ] ~ [ linux-5.13.5 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.53 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.135 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.198 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.240 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.276 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.276 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp