From bde7fabad93ddea8fbefa8da90a4142801b03d37 Mon Sep 17 00:00:00 2001 From: Rob Herring Date: Mon, 8 Feb 2016 10:55:55 -0600 Subject: [PATCH] dt/bindings: add documentation on standard property unit suffixes A common review comment is to add units to DT property names. The naming convention is inconsistent unfortunately although there are clear majorities in use already. This makes it hard to remember the exact name preferred, so I'm documenting this to provide an easy point of reference. Signed-off-by: Rob Herring Cc: Pawel Moll Acked-by: Mark Rutland Cc: Ian Campbell Cc: Kumar Gala --- .../devicetree/bindings/property-units.txt | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 Documentation/devicetree/bindings/property-units.txt diff --git a/Documentation/devicetree/bindings/property-units.txt b/Documentation/devicetree/bindings/property-units.txt new file mode 100644 index 000000000000..12278d79f6c0 --- /dev/null +++ b/Documentation/devicetree/bindings/property-units.txt @@ -0,0 +1,39 @@ +Standard Unit Suffixes for Property names + +Properties which have a unit of measure are recommended to have a unit +suffix appended to the property name. The list below contains the +recommended suffixes. Other variations exist in bindings, but should not +be used in new bindings or added here. The inconsistency in the unit +prefixes is due to selecting the most commonly used variants. + +It is also recommended to use the units listed here and not add additional +unit prefixes. + +Time/Frequency +---------------------------------------- +-mhz : megahertz +-hz : Hertz (preferred) +-sec : seconds +-ms : milliseconds +-us : microseconds +-ns : nanoseconds + +Distance +---------------------------------------- +-mm : millimeters + +Electricity +---------------------------------------- +-microamp : micro amps +-ohms : Ohms +-micro-ohms : micro Ohms +-microvolt : micro volts + +Temperature +---------------------------------------- +-celsius : Degrees Celsius +-millicelsius : Degreee milli-Celsius + +Pressure +---------------------------------------- +-kpascal : kiloPascal -- 2.39.5