iio: imu: adis: add a note better explaining state_lock
authorAlexandru Ardelean <alexandru.ardelean@analog.com>
Tue, 25 Feb 2020 10:33:19 +0000 (12:33 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 8 Mar 2020 17:28:51 +0000 (17:28 +0000)
commit2303248b291f537f0414a644a53483c71023136f
treebf004798d8952726117f91d52b1b3d8fd49adb2d
parent2dd86ba821330840661e7102e3304309299aa635
iio: imu: adis: add a note better explaining state_lock

The 'state_lock' mutex was renamed from 'txrx_lock' in a previous patch and
is intended to be used by ADIS drivers to protect the state of devices
during consecutive R/W ops.
The initial patch that introduced this change did not do a good [well, any]
job at explaining this. This patch adds a comment to the 'state_lock'
better explaining it's use.

Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
include/linux/iio/imu/adis.h