linux-kernel - RE: [PATCH v3 1/2] ASoC: da7218: Add bindings documentation for DA7218 audio codec

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <2E89032DDAA8B9408CB92943514A0337D460ED28@SW-EX-MBX01.diasemi.com>
Date:	Mon, 23 Nov 2015 11:51:39 +0000
From:	"Opensource [Adam Thomson]" <Adam.Thomson.Opensource@...semi.com>
To:	Rob Herring <robh@...nel.org>,
	"Opensource [Adam Thomson]" <Adam.Thomson.Opensource@...semi.com>
CC:	Mark Brown <broonie@...nel.org>,
	Liam Girdwood <lgirdwood@...il.com>,
	Jaroslav Kysela <perex@...ex.cz>,
	Takashi Iwai <tiwai@...e.com>, Pawel Moll <pawel.moll@....com>,
	Mark Rutland <mark.rutland@....com>,
	Ian Campbell <ijc+devicetree@...lion.org.uk>,
	Kumar Gala <galak@...eaurora.org>,
	"alsa-devel@...a-project.org" <alsa-devel@...a-project.org>,
	"devicetree@...r.kernel.org" <devicetree@...r.kernel.org>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	"Support Opensource" <Support.Opensource@...semi.com>
Subject: RE: [PATCH v3 1/2] ASoC: da7218: Add bindings documentation for
 DA7218 audio codec

On November 20, 2015 15:54, Rob Herring wrote:

> > +- dlg,micbias1-lvl-millivolt : Voltage (mV) for Mic Bias 1
> > +	[<1200>, <1600>, <1800>, <2000>, <2200>, <2400>, <2600>, <2800>,
> <3000>]
> > +- dlg,micbias2-lvl-millivolt : Voltage (mV) for Mic Bias 2
> > +	[<1200>, <1600>, <1800>, <2000>, <2200>, <2400>, <2600>, <2800>,
> <3000>]
> > +- dlg,mic1-amp-in-sel : Mic1 input source type
> > +	["diff", "se_p", "se_n"]
> > +- dlg,mic2-amp-in-sel : Mic2 input source type
> > +	["diff", "se_p", "se_n"]
> > +- dlg,dmic1-data-sel : DMIC1 channel select based on clock edge.
> > +	["lrise_rfall", "lfall_rrise"]
> > +- dlg,dmic1-samplephase : When to sample audio from DMIC1.
> > +	["on_clkedge", "between_clkedge"]
> > +- dlg,dmic1-clkrate-hertz : DMic1 clock frequency (Hz).
> 
> -hz
> 
> Documenting the unit suffixes is on my todo list...

So is the general rule to use abbreviated suffixes, apart from millivolts,
microvolts, etc, or are there some other rules that I should be aware of? I
don't want to have to keep re-submitting patches in the future because I'm not
following a rule I have no way of knowing about?

> > +	[<1500000>, <3000000>]
> > +- dlg,dmic2-data-sel : DMic2 channel select based on clock edge.
> > +	["lrise_rfall", "lfall_rrise"]
> > +- dlg,dmic2-samplephase : When to sample audio from DMic2.
> > +	["on_clkedge", "between_clkedge"]
> > +- dlg,dmic2-clkrate-hertz : DMic2 clock frequency (Hz).
> 
> -hz
> 
> > +	[<1500000>, <3000000>]
> > +- dlg,hp-diff-single-supply : Boolean flag, use single supply for HP
> > +			      (DA7217 only)
> > +
> > +======
> > +
> > +Optional Child node - 'da7218_hpldet' (DA7218 only):
> > +
> > +Optional properties:
> > +- dlg,jack-rate-microsecond : Time between jack detect measurements (us)
> 
> -us
> 
> Completely consistent, isn't it. Why we did -microvolt I don't know.

I would guess this is due to the all lower-case rule, as 'uv' doesn't look right
when indicating microvolts. Maybe the lower-case rule should not apply for
abbreviations like this so we can use 'mV', 'uV', etc...? In theory then it
could be 'Hz' as well, if we're being absolutely correct.