Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

struct_regulator_desc(9) [centos man page]

STRUCT 
REGULATOR_DES(9) 					   API reference					   STRUCT REGULATOR_DES(9)

NAME

       struct_regulator_desc - Static regulator descriptor

SYNOPSIS

       struct regulator_desc {
	 const char * name;
	 const char * supply_name;
	 int id;
	 bool continuous_voltage_range;
	 unsigned n_voltages;
	 struct regulator_ops * ops;
	 int irq;
	 enum regulator_type type;
	 struct module * owner;
	 unsigned int min_uV;
	 unsigned int uV_step;
	 unsigned int linear_min_sel;
	 unsigned int ramp_delay;
	 const unsigned int * volt_table;
	 unsigned int vsel_reg;
	 unsigned int vsel_mask;
	 unsigned int apply_reg;
	 unsigned int apply_bit;
	 unsigned int enable_reg;
	 unsigned int enable_mask;
	 bool enable_is_inverted;
	 unsigned int bypass_reg;
	 unsigned int bypass_mask;
	 unsigned int enable_time;
       };

MEMBERS

       name
	   Identifying name for the regulator.

       supply_name
	   Identifying the regulator supply

       id
	   Numerical identifier for the regulator.

       continuous_voltage_range
	   Indicates if the regulator can set any voltage within constrains range.

       n_voltages
	   Number of selectors available for ops.list_voltage.

       ops
	   Regulator operations table.

       irq
	   Interrupt number for the regulator.

       type
	   Indicates if the regulator is a voltage or current regulator.

       owner
	   Module providing the regulator, used for refcounting.

       min_uV
	   Voltage given by the lowest selector (if linear mapping)

       uV_step
	   Voltage increase with each selector (if linear mapping)

       linear_min_sel
	   Minimal selector for starting linear mapping

       ramp_delay
	   Time to settle down after voltage change (unit: uV/us)

       volt_table
	   Voltage mapping table (if table based mapping)

       vsel_reg
	   Register for selector when using regulator_regmap_X_voltage_

       vsel_mask
	   Mask for register bitfield used for selector

       apply_reg
	   Register for initiate voltage change on the output when using regulator_set_voltage_sel_regmap

       apply_bit
	   Register bitfield used for initiate voltage change on the output when using regulator_set_voltage_sel_regmap

       enable_reg
	   Register for control when using regmap enable/disable ops

       enable_mask
	   Mask for control when using regmap enable/disable ops

       enable_is_inverted
	   A flag to indicate set enable_mask bits to disable when using regulator_enable_regmap and friends APIs.

       bypass_reg
	   Register for control when using regmap set_bypass

       bypass_mask
	   Mask for control when using regmap set_bypass

       enable_time
	   Time taken for initial enable of regulator (in uS).

DESCRIPTION

       Each regulator registered with the core is described with a structure of this type and a struct regulator_config. This structure contains
       the non-varying parts of the regulator description.

AUTHORS

       Liam Girdwood <lrg@slimlogic.co.uk>
	   Author.

       Mark Brown <broonie@opensource.wolfsonmicro.com>
       Wolfson Microelectronics,

	   Author.

COPYRIGHT

Kernel Hackers Manual 3.10					     June 2014						   STRUCT REGULATOR_DES(9)

Check Out this Related Man Page

STRUCT 
REGULATION_CO(9) 					   API reference					   STRUCT REGULATION_CO(9)

NAME

       struct_regulation_constraints - regulator operating constraints.

SYNOPSIS

       struct regulation_constraints {
	 char * name;
	 int min_uV;
	 int max_uV;
	 int min_uA;
	 int max_uA;
	 unsigned int valid_modes_mask;
	 unsigned int valid_ops_mask;
	 int input_uV;
	 struct regulator_state state_disk;
	 struct regulator_state state_mem;
	 struct regulator_state state_standby;
	 suspend_state_t initial_state;
	 unsigned int initial_mode;
	 unsigned always_on:1;
	 unsigned boot_on:1;
	 unsigned apply_uV:1;
       };

MEMBERS

       name
	   Descriptive name for the constraints, used for display purposes.

       min_uV
	   Smallest voltage consumers may set.

       max_uV
	   Largest voltage consumers may set.

       min_uA
	   Smallest consumers consumers may set.

       max_uA
	   Largest current consumers may set.

       valid_modes_mask
	   Mask of modes which may be configured by consumers.

       valid_ops_mask
	   Operations which may be performed by consumers.

       input_uV
	   Input voltage for regulator when supplied by another regulator.

       state_disk
	   State for regulator when system is suspended in disk mode.

       state_mem
	   State for regulator when system is suspended in mem mode.

       state_standby
	   State for regulator when system is suspended in standby mode.

       initial_state
	   Suspend state to set by default.

       initial_mode
	   Mode to set at startup.

       always_on
	   Set if the regulator should never be disabled.

       boot_on
	   Set if the regulator is enabled when the system is initially started. If the regulator is not enabled by the hardware or bootloader
	   then it will be enabled when the constraints are applied.

       apply_uV
	   Apply the voltage constraint when initialising.

DESCRIPTION

       This struct describes regulator and board/machine specific constraints.

AUTHORS

       Liam Girdwood <lrg@slimlogic.co.uk>
	   Author.

       Mark Brown <broonie@opensource.wolfsonmicro.com>
       Wolfson Microelectronics,

	   Author.

COPYRIGHT

Kernel Hackers Manual 2.6.					     July 2010						   STRUCT REGULATION_CO(9)
Man Page