sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget,/translations/zh_CN/power/regulator/consumermodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/zh_TW/power/regulator/consumermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/it_IT/power/regulator/consumermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ja_JP/power/regulator/consumermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ko_KR/power/regulator/consumermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/pt_BR/power/regulator/consumermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/sp_SP/power/regulator/consumermodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(h#Regulator Consumer Driver Interfaceh]h#Regulator Consumer Driver Interface}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhF/var/lib/git/docbuild/linux/Documentation/power/regulator/consumer.rsthKubh paragraph)}(hThis text describes the regulator interface for consumer device drivers. Please see overview.txt for a description of the terms used in this text.h]hThis text describes the regulator interface for consumer device drivers. Please see overview.txt for a description of the terms used in this text.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h71. Consumer Regulator Access (static & dynamic drivers)h]h71. Consumer Regulator Access (static & dynamic drivers)}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh)}(hFA consumer driver can get access to its supply regulator by calling ::h]hCA consumer driver can get access to its supply regulator by calling}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh literal_block)}(h®ulator = regulator_get(dev, "Vcc");h]h®ulator = regulator_get(dev, "Vcc");}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhKhhhhubh)}(hXThe consumer passes in its struct device pointer and power supply ID. The core then finds the correct regulator by consulting a machine specific lookup table. If the lookup is successful then this call will return a pointer to the struct regulator that supplies this consumer.h]hXThe consumer passes in its struct device pointer and power supply ID. The core then finds the correct regulator by consulting a machine specific lookup table. If the lookup is successful then this call will return a pointer to the struct regulator that supplies this consumer.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(h;To release the regulator the consumer driver should call ::h]h8To release the regulator the consumer driver should call}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hregulator_put(regulator);h]hregulator_put(regulator);}hj(sbah}(h]h ]h"]h$]h&]j j uh1hhhhKhhhhubh)}(hConsumers can be supplied by more than one regulator e.g. codec consumer with analog and digital supplies by means of bulk operations ::h]hConsumers can be supplied by more than one regulator e.g. codec consumer with analog and digital supplies by means of bulk operations}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hX<struct regulator_bulk_data supplies[2]; supplies[0].supply = "Vcc"; /* digital core */ supplies[1].supply = "Avdd"; /* analog */ ret = regulator_bulk_get(dev, ARRAY_SIZE(supplies), supplies); // convenience helper to call regulator_put() on multiple regulators regulator_bulk_free(ARRAY_SIZE(supplies), supplies);h]hX<struct regulator_bulk_data supplies[2]; supplies[0].supply = "Vcc"; /* digital core */ supplies[1].supply = "Avdd"; /* analog */ ret = regulator_bulk_get(dev, ARRAY_SIZE(supplies), supplies); // convenience helper to call regulator_put() on multiple regulators regulator_bulk_free(ARRAY_SIZE(supplies), supplies);}hjDsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhhhhubh)}(hThe regulator access functions regulator_get() and regulator_put() will usually be called in your device drivers probe() and remove() respectively.h]hThe regulator access functions regulator_get() and regulator_put() will usually be called in your device drivers probe() and remove() respectively.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK'hhhhubeh}(h]0consumer-regulator-access-static-dynamic-driversah ]h"]71. consumer regulator access (static & dynamic drivers)ah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(h?2. Regulator Output Enable & Disable (static & dynamic drivers)h]h?2. Regulator Output Enable & Disable (static & dynamic drivers)}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhhK,ubh)}(h3A consumer can enable its power supply by calling::h]h2A consumer can enable its power supply by calling:}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK/hjhhhubh)}(h int regulator_enable(regulator);h]h int regulator_enable(regulator);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhK1hjhhhubhdefinition_list)}(hhh]hdefinition_list_item)}(hNOTE: The supply may already be enabled before regulator_enable() is called. This may happen if the consumer shares the regulator or the regulator has been previously enabled by bootloader or kernel board initialization code. h](hterm)}(hNOTE:h]hNOTE:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK6hjubh definition)}(hhh]h)}(hThe supply may already be enabled before regulator_enable() is called. This may happen if the consumer shares the regulator or the regulator has been previously enabled by bootloader or kernel board initialization code.h]hThe supply may already be enabled before regulator_enable() is called. This may happen if the consumer shares the regulator or the regulator has been previously enabled by bootloader or kernel board initialization code.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK4hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhK6hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhhNubh)}(h?A consumer can determine if a regulator is enabled by calling::h]h>A consumer can determine if a regulator is enabled by calling:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK8hjhhhubh)}(h$int regulator_is_enabled(regulator);h]h$int regulator_is_enabled(regulator);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhK:hjhhhubh)}(h6This will return > zero when the regulator is enabled.h]h6This will return > zero when the regulator is enabled.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhhubh)}(hnint regulator_bulk_enable(int num_consumers, struct regulator_bulk_data *consumers);h]hnint regulator_bulk_enable(int num_consumers, struct regulator_bulk_data *consumers);}hj sbah}(h]h ]h"]h$]h&]j j uh1hhhhK@hjhhhubh)}(hDA consumer can disable its supply when no longer needed by calling::h]hCA consumer can disable its supply when no longer needed by calling:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKDhjhhhubh)}(h!int regulator_disable(regulator);h]h!int regulator_disable(regulator);}hj)sbah}(h]h ]h"]h$]h&]j j uh1hhhhKFhjhhhubh)}(hOr a number of them ::h]hOr a number of them}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKHhjhhhubh)}(hpint regulator_bulk_disable(int num_consumers, struct regulator_bulk_data *consumers);h]hpint regulator_bulk_disable(int num_consumers, struct regulator_bulk_data *consumers);}hjEsbah}(h]h ]h"]h$]h&]j j uh1hhhhKJhjhhhubj)}(hhh]j)}(hNOTE: This may not disable the supply if it's shared with other consumers. The regulator will only be disabled when the enabled reference count is zero. h](j)}(hNOTE:h]hNOTE:}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKOhjVubj)}(hhh]h)}(hThis may not disable the supply if it's shared with other consumers. The regulator will only be disabled when the enabled reference count is zero.h]hThis may not disable the supply if it’s shared with other consumers. The regulator will only be disabled when the enabled reference count is zero.}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhjhubah}(h]h ]h"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]uh1jhhhKOhjSubah}(h]h ]h"]h$]h&]uh1jhjhhhhhhNubh)}(hMFinally, a regulator can be forcefully disabled in the case of an emergency::h]hLFinally, a regulator can be forcefully disabled in the case of an emergency:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKQhjhhhubh)}(h'int regulator_force_disable(regulator);h]h'int regulator_force_disable(regulator);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKShjhhhubh)}(h;This operation is also supported for multiple regulators ::h]h8This operation is also supported for multiple regulators}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKUhjhhhubh)}(h|int regulator_bulk_force_disable(int num_consumers, struct regulator_bulk_data *consumers);h]h|int regulator_bulk_force_disable(int num_consumers, struct regulator_bulk_data *consumers);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKWhjhhhubj)}(hhh]j)}(hmNOTE: this will immediately and forcefully shutdown the regulator output. All consumers will be powered off. h](j)}(hNOTE:h]hNOTE:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK\hjubj)}(hhh]h)}(hfthis will immediately and forcefully shutdown the regulator output. All consumers will be powered off.h]hfthis will immediately and forcefully shutdown the regulator output. All consumers will be powered off.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK[hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhK\hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhhNubeh}(h]6regulator-output-enable-disable-static-dynamic-driversah ]h"]?2. regulator output enable & disable (static & dynamic drivers)ah$]h&]uh1hhhhhhhhK,ubh)}(hhh](h)}(h73. Regulator Voltage Control & Status (dynamic drivers)h]h73. Regulator Voltage Control & Status (dynamic drivers)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK_ubh)}(hSome consumer drivers need to be able to dynamically change their supply voltage to match system operating points. e.g. CPUfreq drivers can scale voltage along with frequency to save power, SD drivers may need to select the correct card voltage, etc.h]hSome consumer drivers need to be able to dynamically change their supply voltage to match system operating points. e.g. CPUfreq drivers can scale voltage along with frequency to save power, SD drivers may need to select the correct card voltage, etc.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKahjhhubh)}(h7Consumers can control their supply voltage by calling::h]h6Consumers can control their supply voltage by calling:}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKfhjhhubh)}(h5int regulator_set_voltage(regulator, min_uV, max_uV);h]h5int regulator_set_voltage(regulator, min_uV, max_uV);}hj0sbah}(h]h ]h"]h$]h&]j j uh1hhhhKhhjhhubh)}(hVWhere min_uV and max_uV are the minimum and maximum acceptable voltages in microvolts.h]hVWhere min_uV and max_uV are the minimum and maximum acceptable voltages in microvolts.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKjhjhhubh)}(hNOTE: this can be called when the regulator is enabled or disabled. If called when enabled, then the voltage changes instantly, otherwise the voltage configuration changes and the voltage is physically set when the regulator is next enabled.h]hNOTE: this can be called when the regulator is enabled or disabled. If called when enabled, then the voltage changes instantly, otherwise the voltage configuration changes and the voltage is physically set when the regulator is next enabled.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKmhjhhubh)}(hBThe regulators configured voltage output can be found by calling::h]hAThe regulators configured voltage output can be found by calling:}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKrhjhhubh)}(h%int regulator_get_voltage(regulator);h]h%int regulator_get_voltage(regulator);}hjhsbah}(h]h ]h"]h$]h&]j j uh1hhhhKthjhhubj)}(hhh]j)}(hXNOTE: get_voltage() will return the configured output voltage whether the regulator is enabled or disabled and should NOT be used to determine regulator output state. However this can be used in conjunction with is_enabled() to determine the regulator physical output voltage. h](j)}(hNOTE:h]hNOTE:}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK{hjyubj)}(hhh]h)}(hXget_voltage() will return the configured output voltage whether the regulator is enabled or disabled and should NOT be used to determine regulator output state. However this can be used in conjunction with is_enabled() to determine the regulator physical output voltage.h]hXget_voltage() will return the configured output voltage whether the regulator is enabled or disabled and should NOT be used to determine regulator output state. However this can be used in conjunction with is_enabled() to determine the regulator physical output voltage.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKwhjubah}(h]h ]h"]h$]h&]uh1jhjyubeh}(h]h ]h"]h$]h&]uh1jhhhK{hjvubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubeh}(h]0regulator-voltage-control-status-dynamic-driversah ]h"]73. regulator voltage control & status (dynamic drivers)ah$]h&]uh1hhhhhhhhK_ubh)}(hhh](h)}(h=4. Regulator Current Limit Control & Status (dynamic drivers)h]h=4. Regulator Current Limit Control & Status (dynamic drivers)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK~ubh)}(hXSome consumer drivers need to be able to dynamically change their supply current limit to match system operating points. e.g. LCD backlight driver can change the current limit to vary the backlight brightness, USB drivers may want to set the limit to 500mA when supplying power.h]hXSome consumer drivers need to be able to dynamically change their supply current limit to match system operating points. e.g. LCD backlight driver can change the current limit to vary the backlight brightness, USB drivers may want to set the limit to 500mA when supplying power.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h=Consumers can control their supply current limit by calling::h]h5. Regulator Operating Mode Control & Status (dynamic drivers)h]h>5. Regulator Operating Mode Control & Status (dynamic drivers)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hSome consumers can further save system power by changing the operating mode of their supply regulator to be more efficient when the consumers operating state changes. e.g. consumer driver is idle and subsequently draws less currenth]hSome consumers can further save system power by changing the operating mode of their supply regulator to be more efficient when the consumers operating state changes. e.g. consumer driver is idle and subsequently draws less current}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h?Regulator operating mode can be changed indirectly or directly.h]h?Regulator operating mode can be changed indirectly or directly.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hhh](h)}(h Indirect operating mode control.h]h Indirect operating mode control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(h[Consumer drivers can request a change in their supply regulator operating mode by calling::h]hZConsumer drivers can request a change in their supply regulator operating mode by calling:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hAint regulator_set_load(struct regulator *regulator, int load_uA);h]hAint regulator_set_load(struct regulator *regulator, int load_uA);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubh)}(hThis will cause the core to recalculate the total load on the regulator (based on all its consumers) and change operating mode (if necessary and permitted) to best match the current operating load.h]hThis will cause the core to recalculate the total load on the regulator (based on all its consumers) and change operating mode (if necessary and permitted) to best match the current operating load.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hThe load_uA value can be determined from the consumer's datasheet. e.g. most datasheets have tables showing the maximum current consumed in certain situations.h]hThe load_uA value can be determined from the consumer’s datasheet. e.g. most datasheets have tables showing the maximum current consumed in certain situations.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hMost consumers will use indirect operating mode control since they have no knowledge of the regulator or whether the regulator is shared with other consumers.h]hMost consumers will use indirect operating mode control since they have no knowledge of the regulator or whether the regulator is shared with other consumers.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]indirect-operating-mode-controlah ]h"] indirect operating mode control.ah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(hDirect operating mode control.h]hDirect operating mode control.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hBespoke or tightly coupled drivers may want to directly control regulator operating mode depending on their operating point. This can be achieved by calling::h]hBespoke or tightly coupled drivers may want to directly control regulator operating mode depending on their operating point. This can be achieved by calling:}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hint regulator_set_mode(struct regulator *regulator, unsigned int mode); unsigned int regulator_get_mode(struct regulator *regulator);h]hint regulator_set_mode(struct regulator *regulator, unsigned int mode); unsigned int regulator_get_mode(struct regulator *regulator);}hj>sbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubh)}(hDirect mode will only be used by consumers that *know* about the regulator and are not sharing the regulator with other consumers.h](h0Direct mode will only be used by consumers that }(hjLhhhNhNubhemphasis)}(h*know*h]hknow}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1jThjLubhL about the regulator and are not sharing the regulator with other consumers.}(hjLhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]direct-operating-mode-controlah ]h"]direct operating mode control.ah$]h&]uh1hhjhhhhhKubeh}(h]7regulator-operating-mode-control-status-dynamic-driversah ]h"]>5. regulator operating mode control & status (dynamic drivers)ah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h6. Regulator Eventsh]h6. Regulator Events}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~hhhhhKubh)}(hRegulators can notify consumers of external events. Events could be received by consumers under regulator stress or failure conditions.h]hRegulators can notify consumers of external events. Events could be received by consumers under regulator stress or failure conditions.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj~hhubh)}(h@Consumers can register interest in regulator events by calling::h]h?Consumers can register interest in regulator events by calling:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj~hhubh)}(hxint regulator_register_notifier(struct regulator *regulator, struct notifier_block *nb);h]hxint regulator_register_notifier(struct regulator *regulator, struct notifier_block *nb);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhj~hhubh)}(h.Consumers can unregister interest by calling::h]h-Consumers can unregister interest by calling:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj~hhubh)}(h|int regulator_unregister_notifier(struct regulator *regulator, struct notifier_block *nb);h]h|int regulator_unregister_notifier(struct regulator *regulator, struct notifier_block *nb);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhj~hhubh)}(hYRegulators use the kernel notifier framework to send event to their interested consumers.h]hYRegulators use the kernel notifier framework to send event to their interested consumers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj~hhubeh}(h]regulator-eventsah ]h"]6. regulator eventsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h#7. Regulator Direct Register Accessh]h#7. Regulator Direct Register Access}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hSome kinds of power management hardware or firmware are designed such that they need to do low-level hardware access to regulators, with no involvement from the kernel. Examples of such devices are:h]hSome kinds of power management hardware or firmware are designed such that they need to do low-level hardware access to regulators, with no involvement from the kernel. Examples of such devices are:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh bullet_list)}(hhh](h list_item)}(hclocksource with a voltage-controlled oscillator and control logic to change the supply voltage over I2C to achieve a desired output clock rateh]h)}(hclocksource with a voltage-controlled oscillator and control logic to change the supply voltage over I2C to achieve a desired output clock rateh]hclocksource with a voltage-controlled oscillator and control logic to change the supply voltage over I2C to achieve a desired output clock rate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhj hhhhhNubj)}(hthermal management firmware that can issue an arbitrary I2C transaction to perform system poweroff during overtemperature conditions h]h)}(hthermal management firmware that can issue an arbitrary I2C transaction to perform system poweroff during overtemperature conditionsh]hthermal management firmware that can issue an arbitrary I2C transaction to perform system poweroff during overtemperature conditions}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj)ubah}(h]h ]h"]h$]h&]uh1jhj hhhhhNubeh}(h]h ]h"]h$]h&]bullet-uh1j hhhKhjhhubh)}(hTo set up such a device/firmware, various parameters like I2C address of the regulator, addresses of various regulator registers etc. need to be configured to it. The regulator framework provides the following helpers for querying these details.h]hTo set up such a device/firmware, various parameters like I2C address of the regulator, addresses of various regulator registers etc. need to be configured to it. The regulator framework provides the following helpers for querying these details.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hBus-specific details, like I2C addresses or transfer rates are handled by the regmap framework. To get the regulator's regmap (if supported), use::h]hBus-specific details, like I2C addresses or transfer rates are handled by the regmap framework. To get the regulator’s regmap (if supported), use:}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hAstruct regmap *regulator_get_regmap(struct regulator *regulator);h]hAstruct regmap *regulator_get_regmap(struct regulator *regulator);}hjesbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubh)}(hgTo obtain the hardware register offset and bitmask for the regulator's voltage selector register, use::h]hhTo obtain the hardware register offset and bitmask for the regulator’s voltage selector register, use:}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hint regulator_get_hardware_vsel_register(struct regulator *regulator, unsigned *vsel_reg, unsigned *vsel_mask);h]hint regulator_get_hardware_vsel_register(struct regulator *regulator, unsigned *vsel_reg, unsigned *vsel_mask);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubh)}(hTo convert a regulator framework voltage selector code (used by regulator_list_voltage) to a hardware-specific voltage selector that can be directly written to the voltage selector register, use::h]hTo convert a regulator framework voltage selector code (used by regulator_list_voltage) to a hardware-specific voltage selector that can be directly written to the voltage selector register, use:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hrint regulator_list_hardware_vsel(struct regulator *regulator, unsigned selector);h]hrint regulator_list_hardware_vsel(struct regulator *regulator, unsigned selector);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubh)}(hTo access the hardware for enabling/disabling the regulator, consumers must use regulator_get_exclusive(), as it can't work if there's more than one consumer. To enable/disable regulator use::h]hTo access the hardware for enabling/disabling the regulator, consumers must use regulator_get_exclusive(), as it can’t work if there’s more than one consumer. To enable/disable regulator use:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hHint regulator_hardware_enable(struct regulator *regulator, bool enable);h]hHint regulator_hardware_enable(struct regulator *regulator, bool enable);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhMhjhhubeh}(h] regulator-direct-register-accessah ]h"]#7. regulator direct register accessah$]h&]uh1hhhhhhhhKubeh}(h]#regulator-consumer-driver-interfaceah ]h"]#regulator consumer driver interfaceah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehʌ _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(jjjejbjjjjjjj{jxjjjsjpjjjju nametypes}(jjejjjj{jjsjjuh}(jhjbhjjhjjjjjxjjjjpjjj~jju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.