From c80e31f190351d463eb20261b72c4950d3ae184d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Nohlg=C3=A5rd?= Date: Thu, 17 Aug 2017 14:29:55 +0200 Subject: [PATCH] netopt: Improve documentation for NETOPT_CSMA_RETRIES --- sys/include/net/netopt.h | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/sys/include/net/netopt.h b/sys/include/net/netopt.h index ff26659f29..70fe72ab90 100644 --- a/sys/include/net/netopt.h +++ b/sys/include/net/netopt.h @@ -162,8 +162,19 @@ typedef enum { * NETOPT_CSMA_* options. */ NETOPT_CSMA, - NETOPT_CSMA_RETRIES, /**< get/set the number of retries when - when channel is busy */ + + /** + * @brief get/set the maximum number of CSMA retries + * + * (uint8_t) + * The maximum number of backoffs the CSMA-CA algorithm will attempt before + * declaring a channel access failure. Named macMaxCsmaBackoffs in + * IEEE Std 802.15.4-2015. + * + * 802.15.4 default: 4 + */ + NETOPT_CSMA_RETRIES, + /** * @brief read-only check for a wired interface. *