soundwire: bus: add comments to explain interrupt loop filter
authorPierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Tue, 24 Nov 2020 01:33:14 +0000 (09:33 +0800)
committerVinod Koul <vkoul@kernel.org>
Wed, 25 Nov 2020 05:02:25 +0000 (10:32 +0530)
commit6e06a85556f9725865af91c9fe502c9669518ed5
treef10e067ea1bc03c8d6860b559cb4d73259297f12
parentb7cab9be7c16128a0de21ed7ae67211838813437
soundwire: bus: add comments to explain interrupt loop filter

The interrupt handling in SoundWire requires software to re-read the
interrupt status after clearing an interrupt. In case the interrupt is
still outstanding, the code in bus.c will loop a number of times,
however that loop is limited to the interrupts detected in the first
read. This strategy helps meet SoundWire requirements without
remaining forever in an interrupt handler.

Add a couple of comments to document this design.

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Reviewed-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Link: https://lore.kernel.org/r/20201124013318.8963-2-yung-chuan.liao@linux.intel.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
drivers/soundwire/bus.c