net: ipa: update comments
authorAlex Elder <elder@linaro.org>
Fri, 30 Sep 2022 22:45:27 +0000 (17:45 -0500)
committerJakub Kicinski <kuba@kernel.org>
Mon, 3 Oct 2022 23:49:05 +0000 (16:49 -0700)
commitace5dc61620ba1592bf9e24da4c290a357830b8c
treee8a4dd04ca69b414fa0ed0c776cea110c337948c
parent450a580fc4b5e7f7fb8d9b1a0208bf0d1efc53a8
net: ipa: update comments

This patch just updates comments throughout the IPA code.

Transaction state is now tracked using indexes into an array rather
than linked lists, and a few comments refer to the "old way" of
doing things.  The description of how transactions are used was
changed to refer to "operations" rather than "commands", to
(hopefully) remove a possible ambiguity.

IPA register offsets and fields are now handled differently as well,
and the register documentation is updated to better describe the
code.

A few minor updates to comments were made (e.g., adding a missing
word, fixing a typo or punctuation, etc.).

Finally, the local macro atomic_dec_not_zero() is no longer used, so
it is deleted.

Signed-off-by: Alex Elder <elder@linaro.org>
Link: https://lore.kernel.org/r/20220930224527.3503404-1-elder@linaro.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
drivers/net/ipa/gsi.c
drivers/net/ipa/gsi_private.h
drivers/net/ipa/gsi_trans.c
drivers/net/ipa/gsi_trans.h
drivers/net/ipa/ipa_cmd.c
drivers/net/ipa/ipa_data.h
drivers/net/ipa/ipa_endpoint.c
drivers/net/ipa/ipa_reg.h