struct_regulation_constraints(9) [centos man page]

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

NAME

       struct_regulation_constraints - regulator operating constraints.

SYNOPSIS

       struct regulation_constraints {
	 const char * name;
	 int min_uV;
	 int max_uV;
	 int uV_offset;
	 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 int ramp_delay;
	 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.

       uV_offset
	   Offset applied to voltages from consumer to compensate for voltage drops.

       min_uA
	   Smallest current 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.

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

       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 3.10					     June 2014						   STRUCT REGULATION_CO(9)

TBRCONFIG(8)						    BSD System Manager's Manual 					      TBRCONFIG(8)

NAME

     tbrconfig -- configure a token bucket regulator for an output queue

SYNOPSIS

     tbrconfig interface [tokenrate [bucketsize]]
     tbrconfig -d interface
     tbrconfig -a

DESCRIPTION

     tbrconfig configures a token bucket regulator for the output network interface queue.  A token bucket regulator limits both the average
     amount and instantaneous amount of packets that the underlying driver can dequeue from the network interface within the kernel.

     Conceptually, tokens accumulate in a bucket at the average tokenrate, up to the bucketsize.  The driver can dequeue packets as long as there
     are positive amount of tokens, and the length of the dequeued packet is subtracted from the remaining tokens.  Tokens can be negative as a
     deficit, and packets are not dequeued from the interface queue until the tokens become positive again.  The tokenrate limits the average
     rate, and the bucketsize limits the maximum burst size.

     Limiting the burst size is essential to packet scheduling, since the scheduler schedules packets backlogged at the network interface.  Limit-
     ing the burst size is also needed for drivers which dequeues more packets than they can send and end up with discarding excess packets.

     When the tokenrate is set to higher than the actual transmission rate, the transmission complete interrupt will trigger the next dequeue.	On
     the other hand, when the tokenrate is set to lower than the actual transmission rate, the transmission complete interrupt would occur before
     the tokens become positive.  In this case, the next dequeue will be triggered by a timer event.  Because the kernel timer has a limited gran-
     ularity, a larger bucketsize is required for a higher tokenrate.

     The interface parameter is a string of the form ``name unit'', for example, ``en0''.

     The tokenrate parameter specifies the average rate in bits per second, and ``K'' or ``M'' can be appended to tokenrate as a short hand of
     ``Kilo-bps'' or ``Mega-bps'', respectively.  When tokenrate is omitted, tbrconfig displays the current parameter values.

     The bucketsize parameter specifies the bucket size in bytes, and ``K'' can be appended to bucketsize as a short hand of ``Kilo-bytes''.  When
     bucketsize is omitted, tbrconfig assumes the regulator is driven by transmission complete interrupts and, using heuristics, assigns a small
     bucket size according to the tokenrate.  When the keyword ``auto'' is given as bucketsize, tbrconfig assumes the regulator is driven by the
     kernel timer, and computes the bucket size from tokenrate and the kernel clock frequency.

     If the -d flag is passed before an interface name, tbrconfig will remove the token bucket regulator for the specified interface.

     Optionally, the -a flag may be used instead of an interface name.	This flag instructs tbrconfig to display information about all interfaces
     in the system.

EXAMPLES

     To configure a token bucket regulator for the interface en0 with 10Mbps token rate and 8KB bucket size,

	   # tbrconfig en0 10M 8K

     To rate-limit the interface en0 up to 3Mbps,

	   # tbrconfig en0 3M auto

SEE ALSO

     altq.conf(5), altqd(8)

HISTORY

     The tbrconfig command first appeared in WIDE/KAME IPv6 protocol stack kit as part of ALTQ tools.

BSD
								   July 25, 2000							       BSD