From c13291a233bf839349123c7beb7e066af6a22df6 Mon Sep 17 00:00:00 2001 From: Chaitanya Tata Date: Tue, 3 Dec 2024 01:33:59 +0530 Subject: [PATCH] Improve TX power docs Add a separate section in the porting guide with doxygen docs and link to NCS doc about TX power calcualtion. Signed-off-by: Chaitanya Tata --- nrf70_bm_lib/docs/Doxyfile | 1 + .../docs/source/nrf70_bm_porting_guide.rst | 32 +++++++++++++++++++ nrf70_bm_lib/include/nrf70_tx_pwr_ceil_dk.h | 25 +++++++++++---- nrf70_bm_lib/include/nrf70_tx_pwr_ceil_ek.h | 9 +++--- 4 files changed, 57 insertions(+), 10 deletions(-) diff --git a/nrf70_bm_lib/docs/Doxyfile b/nrf70_bm_lib/docs/Doxyfile index 910fc78..4eeff78 100644 --- a/nrf70_bm_lib/docs/Doxyfile +++ b/nrf70_bm_lib/docs/Doxyfile @@ -865,6 +865,7 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = ../include/nrf70_bm_lib.h \ + ../include/nrf70_tx_pwr_ceil_dk.h \ ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc \ ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc/radio_test \ ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc/default diff --git a/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst b/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst index 6de33f9..97654ba 100644 --- a/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst +++ b/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst @@ -97,6 +97,38 @@ For more information, visit the `nRF Connect SDK nrfxlib repository `_. + + +Reference header file structure +------------------------------- + +.. doxygenfile:: nrf70_tx_pwr_ceil_dk.h + + nRF70 OS agnostic layers API documentation ========================================== diff --git a/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_dk.h b/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_dk.h index 80960cb..3891cf6 100644 --- a/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_dk.h +++ b/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_dk.h @@ -7,24 +7,37 @@ /** @file * @brief nRF7002 DK TX power ceiling configuration. - */ - -/* + * * The configuration applies to the nRF7002 DK board targets, as well as * to board targets for nRF7001 and nRF7000 IC variants emulated on the * nRF7002 DK. - */ - -/* The following macros are normally auto-generated from DeviceTree + * + * The following macros are normally auto-generated from DeviceTree * when building the nRF70 driver in a Zephyr environment. They are * copied here as standard preprocessor directives for ease of porting. + * + * The values are represented in 0.25 dB increments.The values for the + * other MCS rates are interpolated from the values for MCS0 and MCS7. + * + * + * @addtogroup nrf70_bm_txpower nRF70 Bare Metal library */ + +/** Maximum power for 2.4 GHz DSSS. */ #define MAX_PWR_2G_DSSS 0x54 +/** Maximum power for 2.4 GHz MCS0. */ #define MAX_PWR_2G_MCS0 0x40 +/** Maximum power for 2.4 GHz MCS7. */ #define MAX_PWR_2G_MCS7 0x40 +/** Maximum power for 5 GHz low band (5150-5330 MHz) MCS0. */ #define MAX_PWR_5G_LOW_MCS0 0x24 +/** Maximum power for 5 GHz low band (5150-5330 MHz) MCS7. */ #define MAX_PWR_5G_LOW_MCS7 0x24 +/** Maximum power for 5 GHz mid band (5330-5670 MHz) MCS0. */ #define MAX_PWR_5G_MID_MCS0 0x2C +/** Maximum power for 5 GHz mid band (5330-5670 MHz) MCS7. */ #define MAX_PWR_5G_MID_MCS7 0x2C +/** Maximum power for 5 GHz high band (5670-5895 MHz) MCS0. */ #define MAX_PWR_5G_HIGH_MCS0 0x34 +/** Maximum power for 5 GHz high band (5670-5895 MHz) MCS7. */ #define MAX_PWR_5G_HIGH_MCS7 0x34 diff --git a/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_ek.h b/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_ek.h index 3cf2694..188fadd 100644 --- a/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_ek.h +++ b/nrf70_bm_lib/include/nrf70_tx_pwr_ceil_ek.h @@ -9,15 +9,16 @@ * @brief nRF7002 EK TX power ceiling configuration. */ -/* +/** * The configuration applies to the nRF7002 EK shield targets, as well as * to shield targets for nRF7001 and nRF7000 IC variants emulated on the * nRF7002 EK. - */ - -/* The following macros are normally auto-generated from DeviceTree + * + * The following macros are normally auto-generated from DeviceTree * when building the nRF70 driver in a Zephyr environment. They are * copied here as standard preprocessor directives for ease of porting. + * + * The values are represented in 0.25 dB increments. */ #define MAX_PWR_2G_DSSS 0x54 #define MAX_PWR_2G_MCS0 0x40