ASoC: dt-bindings: cs42l42: Correct description of ts-inv
authorRichard Fitzgerald <rf@opensource.cirrus.com>
Thu, 28 Oct 2021 14:09:00 +0000 (15:09 +0100)
committerMark Brown <broonie@kernel.org>
Fri, 29 Oct 2021 11:28:46 +0000 (12:28 +0100)
commit2a2df2a755172afb25f0883a52aedba3b67d8a48
tree39f0ce517bf80fb58267c185e57b045ec16c1248
parentc6c203bc4dfed6812cf77e7737074b9cff8dd78d
ASoC: dt-bindings: cs42l42: Correct description of ts-inv

This swaps the descriptions of the 0 and 1 values to match
what the driver actually does with this property.

The background here is somewhat confusing. The codec has two
invert bits for the tip sense. The DT property should have been
for the TIP_SENSE_INV bit, which is the one that controls the
detect block. Due to some misunderstanding of the hardware the
driver actually implemented setting of the TS_INV bit, which is
only for swapping the sense of the interrupt bits. The description
was taken from the datasheet and refers to TIP_SENSE_INV but
unfortunately TS_INV has a different purpose and the net effect
of changing it is the reverse of what was intended (this is not
clearly described in the datasheet). So the ts-inv settings have
always done the exact opposite of what the description said.

Given the age of the driver, it's too late now to swap the meanings
of the values, so the description is changed to match the behaviour.
They have been annotated with the terminology used in the datasheet
to avoid the confusion of which one corresponds to what the datasheet
calls "inverted tip sense".

Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>
Fixes: da16c5579353 ("ASoC: cs42l42: Add devicetree bindings for CS42L42")
Link: https://lore.kernel.org/r/20211028140902.11786-2-rf@opensource.cirrus.com
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/sound/cs42l42.txt