staging: pi433: add docs to packet_format and tx_start_condition enum
authorPaulo Miguel Almeida <paulo.miguel.almeida.rodenas@gmail.com>
Fri, 31 Dec 2021 00:19:33 +0000 (13:19 +1300)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 3 Jan 2022 13:30:01 +0000 (14:30 +0100)
commita0c43a469239ab6fedaaa101b15bc6cc9e8baa1d
tree4ad2cf1e431eb5a74cc21c15200ea7f2e524aad0
parent12b31d07b0ceb723821394b414c02db64468f1f2
staging: pi433: add docs to packet_format and tx_start_condition enum

While pi433 driver deals with the nuances of the different possible
config combinations, it's hard (at first) to understand the rationale
for some of the tx/rx-related source code unless you're fairly familiar
with the rf69's inner workings.

This patch documents the expected behaviour and limits of both
packet_format and tx_start_condition enum fields.

Signed-off-by: Paulo Miguel Almeida <paulo.miguel.almeida.rodenas@gmail.com>
Link: https://lore.kernel.org/r/20211231001933.GA6779@mail.google.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/pi433/rf69_enum.h