The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
regulator_put – "free" the regulator source Synopsis void regulator_put(struct regulator *regulator); Arguments regulator regulator source Note drivers must ensure that all regulator_enable calls made on this regulator source are balanced by regulator_disable calls prior to calling this function. Authors Liam Girdwood <lrg [at] slimlogic.co.uk> Author. Mark Brown <broonie [at] opensource.wolfsonmicro.com> Wolfson Microelectronics, Author. Copyright
regulator_notifier_call_chain – call regulator event notifier Synopsis int regulator_notifier_call_chain(struct regulator_dev *rdev, unsigned long event, void *data); Arguments rdev regulator source event notifier block data callback-specific data. Description Called by regulator drivers to notify clients a regulator event has occurred. We also notify regulator clients downstream. Note lock must be held by caller. Authors Liam Girdwood…
regulator_mode_to_status – convert a regulator mode into a status Synopsis int regulator_mode_to_status(unsigned int mode); Arguments mode Mode to convert Description Convert a regulator mode into a status. Authors Liam Girdwood <lrg [at] slimlogic.co.uk> Author. Mark Brown <broonie [at] opensource.wolfsonmicro.com> Wolfson Microelectronics, Author. Copyright
regulator_list_voltage – enumerate supported voltages Synopsis int regulator_list_voltage(struct regulator *regulator, unsigned selector); Arguments regulator regulator source selector identify voltage to list Context can sleep Description Returns a voltage that can be passed to regulator_set_voltage(), zero if this selector code can’t be used on this system, or a negative errno. Authors Liam Girdwood <lrg [at] slimlogic.co.uk>…
regulator_list_hardware_vsel – get the HW-specific register value for a selector Synopsis int regulator_list_hardware_vsel(struct regulator *regulator, unsigned selector); Arguments regulator regulator source selector identify voltage to list Description Converts the selector to a hardware-specific voltage selector that can be directly written to the regulator registers. The address of the voltage register can be determined by calling…
regulator_is_supported_voltage – check if a voltage range can be supported Synopsis int regulator_is_supported_voltage(struct regulator *regulator, int min_uV, int max_uV); Arguments regulator Regulator to check. min_uV Minimum required voltage in uV. max_uV Maximum required voltage in uV. Description Returns a boolean or a negative error code. Authors Liam Girdwood <lrg [at] slimlogic.co.uk> Author. Mark Brown <broonie…
regulator_is_enabled – is the regulator output enabled Synopsis int regulator_is_enabled(struct regulator *regulator); Arguments regulator regulator source Description Returns positive if the regulator driver backing the source/client has requested that the device be enabled, zero if it hasn’t, else a negative errno code. Note that the device backing this regulator handle can have multiple users, so…
regulator_has_full_constraints – the system has fully specified constraints Synopsis void regulator_has_full_constraints(void); Arguments void no arguments Description Calling this function will cause the regulator API to disable all regulators which have a zero use count and don’t have an always_on constraint in a late_initcall. The intention is that this will become the default behaviour in a…
regulator_get_voltage – get regulator output voltage Synopsis int regulator_get_voltage(struct regulator *regulator); Arguments regulator regulator source Description This returns the current regulator voltage in uV. Note If the regulator is disabled it will return the voltage value. This function should not be used to determine regulator state. Authors Liam Girdwood <lrg [at] slimlogic.co.uk> Author. Mark Brown…
regulator_get_optional – obtain optional access to a regulator. Synopsis struct regulator *regulator_get_optional(struct device *dev, const char *id); Arguments dev device for regulator “consumer” id Supply name or regulator ID. Description Returns a struct regulator corresponding to the regulator producer, or IS_ERR condition containing errno. This is intended for use by consumers for devices which can…
regulator_get_mode – get regulator operating mode Synopsis unsigned int regulator_get_mode(struct regulator *regulator); Arguments regulator regulator source Description Get the current regulator operating mode. Authors Liam Girdwood <lrg [at] slimlogic.co.uk> Author. Mark Brown <broonie [at] opensource.wolfsonmicro.com> Wolfson Microelectronics, Author. Copyright
regulator_get_linear_step – return the voltage step size between VSEL values Synopsis unsigned int regulator_get_linear_step(struct regulator *regulator); Arguments regulator regulator source Description Returns the voltage step size between VSEL values for linear regulators, or return 0 if the regulator isn’t a linear regulator. Authors Liam Girdwood <lrg [at] slimlogic.co.uk> Author. Mark Brown <broonie [at] opensource.wolfsonmicro.com> Wolfson…
regulator_get_hardware_vsel_register – get the HW voltage selector register Synopsis int regulator_get_hardware_vsel_register(struct regulator *regulator, unsigned *vsel_reg, unsigned *vsel_mask); Arguments regulator regulator source vsel_reg voltage selector register, output parameter vsel_mask mask for voltage selector bitfield, output parameter Description Returns the hardware register offset and bitmask used for setting the regulator voltage. This might be useful when configuring…
regulator_get_exclusive – obtain exclusive access to a regulator. Synopsis struct regulator *regulator_get_exclusive(struct device *dev, const char *id); Arguments dev device for regulator “consumer” id Supply name or regulator ID. Description Returns a struct regulator corresponding to the regulator producer, or IS_ERR condition containing errno. Other consumers will be unable to obtain this regulator while this…
regulator_get_drvdata – get regulator driver data Synopsis void *regulator_get_drvdata(struct regulator *regulator); Arguments regulator regulator Description Get regulator driver private data. This call can be used in the consumer driver context when non API regulator specific functions need to be called. Authors Liam Girdwood <lrg [at] slimlogic.co.uk> Author. Mark Brown <broonie [at] opensource.wolfsonmicro.com> Wolfson Microelectronics, …
regulator_get_current_limit – get regulator output current Synopsis int regulator_get_current_limit(struct regulator *regulator); Arguments regulator regulator source Description This returns the current supplied by the specified current sink in uA. Note If the regulator is disabled it will return the current value. This function should not be used to determine regulator state. Authors Liam Girdwood <lrg [at]…
regulator_get – lookup and obtain a reference to a regulator. Synopsis struct regulator *regulator_get(struct device *dev, const char *id); Arguments dev device for regulator “consumer” id Supply name or regulator ID. Description Returns a struct regulator corresponding to the regulator producer, or IS_ERR condition containing errno. Use of supply names configured via regulator_set_device_supply is strongly…
regulator_force_disable – force disable regulator output Synopsis int regulator_force_disable(struct regulator *regulator); Arguments regulator regulator source Description Forcibly disable the regulator output voltage or current. Note this *will* disable the regulator output even if other consumer devices have it enabled. This should be used for situations when device damage will likely occur if the regulator is…
regulator_enable – enable regulator output Synopsis int regulator_enable(struct regulator *regulator); Arguments regulator regulator source Description Request that the regulator be enabled with the regulator output at the predefined voltage or current value. Calls to regulator_enable must be balanced with calls to regulator_disable. Note the output value can be set by other drivers, boot loader or…
regulator_disable_deferred – disable regulator output with delay Synopsis int regulator_disable_deferred(struct regulator *regulator, int ms); Arguments regulator regulator source ms miliseconds until the regulator is disabled Description Execute regulator_disable on the regulator after a delay. This is intended for use with devices that require some time to quiesce. Note this will only disable the regulator output…