mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-01-12 16:19:53 +00:00
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>
This commit is contained in:
parent
12b31d07b0
commit
a0c43a4692
@ -110,12 +110,24 @@ enum fifo_fill_condition {
|
||||
};
|
||||
|
||||
enum packet_format {
|
||||
/*
|
||||
* Used when the size of payload is fixed in advance. This mode of
|
||||
* operation may be of interest to minimize RF overhead by 1 byte as
|
||||
* no length byte field is required
|
||||
*/
|
||||
packet_length_fix,
|
||||
/*
|
||||
* Used when the size of payload isn't known in advance. It requires the
|
||||
* transmitter to send the length byte in each packet so the receiver
|
||||
* would know how to operate properly
|
||||
*/
|
||||
packet_length_var
|
||||
};
|
||||
|
||||
enum tx_start_condition {
|
||||
/* the number of bytes in the FIFO exceeds FIFO_THRESHOLD */
|
||||
fifo_level,
|
||||
/* at least one byte in the FIFO */
|
||||
fifo_not_empty
|
||||
};
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user