1STRUCT REGULATION_CO(9)          API reference         STRUCT REGULATION_CO(9)
2
3
4

NAME

6       struct_regulation_constraints - regulator operating constraints.
7

SYNOPSIS

9       struct regulation_constraints {
10         const char * name;
11         int min_uV;
12         int max_uV;
13         int uV_offset;
14         int min_uA;
15         int max_uA;
16         unsigned int valid_modes_mask;
17         unsigned int valid_ops_mask;
18         int input_uV;
19         struct regulator_state state_disk;
20         struct regulator_state state_mem;
21         struct regulator_state state_standby;
22         suspend_state_t initial_state;
23         unsigned int initial_mode;
24         unsigned int ramp_delay;
25         unsigned always_on:1;
26         unsigned boot_on:1;
27         unsigned apply_uV:1;
28       };
29

MEMBERS

31       name
32           Descriptive name for the constraints, used for display purposes.
33
34       min_uV
35           Smallest voltage consumers may set.
36
37       max_uV
38           Largest voltage consumers may set.
39
40       uV_offset
41           Offset applied to voltages from consumer to compensate for voltage
42           drops.
43
44       min_uA
45           Smallest current consumers may set.
46
47       max_uA
48           Largest current consumers may set.
49
50       valid_modes_mask
51           Mask of modes which may be configured by consumers.
52
53       valid_ops_mask
54           Operations which may be performed by consumers.
55
56       input_uV
57           Input voltage for regulator when supplied by another regulator.
58
59       state_disk
60           State for regulator when system is suspended in disk mode.
61
62       state_mem
63           State for regulator when system is suspended in mem mode.
64
65       state_standby
66           State for regulator when system is suspended in standby mode.
67
68       initial_state
69           Suspend state to set by default.
70
71       initial_mode
72           Mode to set at startup.
73
74       ramp_delay
75           Time to settle down after voltage change (unit: uV/us)
76
77       always_on
78           Set if the regulator should never be disabled.
79
80       boot_on
81           Set if the regulator is enabled when the system is initially
82           started. If the regulator is not enabled by the hardware or
83           bootloader then it will be enabled when the constraints are
84           applied.
85
86       apply_uV
87           Apply the voltage constraint when initialising.
88

DESCRIPTION

90       This struct describes regulator and board/machine specific constraints.
91

AUTHORS

93       Liam Girdwood <lrg@slimlogic.co.uk>
94           Author.
95
96       Mark Brown <broonie@opensource.wolfsonmicro.com>
97       Wolfson Microelectronics,
98
99
100           Author.
101

103Kernel Hackers Manual 3.10         June 2019           STRUCT REGULATION_CO(9)
Impressum