Pull request #43: Add files for release/2.16.100_minor_rfp_gh_review from CI Generation

Merge in MCUCORE/mcux-sdk-wifi-nxp from release/2.16.100_minor_rfp_gh_review to release/2.16.100_minor_rfp_gh

Author: McuxCIBot

cli/cli.c

@@ -46,12 +46,12 @@
 static void uart_task(osa_task_param_t arg);
 
 #if CONFIG_UART_INTERACTIVE
-static OSA_TASK_DEFINE(uart_task, PRIORITY_RTOS_TO_OSA(3), 1, CONFIG_UART_STACK_SIZE, 0);
+static OSA_TASK_DEFINE(uart_task, WLAN_TASK_PRI_HIGH, 1, CONFIG_UART_STACK_SIZE, 0);
 #else
 #if CONFIG_NCP
-static OSA_TASK_DEFINE(uart_task, PRIORITY_RTOS_TO_OSA(1), 1, CONFIG_UART_STACK_SIZE, 0);
+static OSA_TASK_DEFINE(uart_task, WLAN_TASK_PRI_LOW, 1, CONFIG_UART_STACK_SIZE, 0);
 #else
-static OSA_TASK_DEFINE(uart_task, PRIORITY_RTOS_TO_OSA(0), 1, CONFIG_UART_STACK_SIZE, 0);
+static OSA_TASK_DEFINE(uart_task, WLAN_TASK_PRI_IDLE, 1, CONFIG_UART_STACK_SIZE, 0);
 #endif
 #endif
 #endif
@@ -75,9 +75,9 @@ static void cli_task(osa_task_param_t arg);
 
 /* OSA_TASKS: name, priority, instances, stackSz, useFloat */
 #if CONFIG_UART_INTERACTIVE
-static OSA_TASK_DEFINE(cli_task, PRIORITY_RTOS_TO_OSA(3), 1, CONFIG_CLI_STACK_SIZE, 0);
+static OSA_TASK_DEFINE(cli_task, WLAN_TASK_PRI_HIGH, 1, CONFIG_CLI_STACK_SIZE, 0);
 #else
-static OSA_TASK_DEFINE(cli_task, PRIORITY_RTOS_TO_OSA(1), 1, CONFIG_CLI_STACK_SIZE, 0);
+static OSA_TASK_DEFINE(cli_task, WLAN_TASK_PRI_LOW, 1, CONFIG_CLI_STACK_SIZE, 0);
 #endif
 
 OSA_TASK_HANDLE_DEFINE(cli_task_Handle);

dhcpd/dhcp-server-main.c

@@ -27,7 +27,7 @@ static bool dhcpd_running;
 void dhcpd_task(osa_task_param_t arg);
 
 /* OSA_TASKS: name, priority, instances, stackSz, useFloat */
-static OSA_TASK_DEFINE(dhcpd_task, OSA_PRIORITY_NORMAL, 1, CONFIG_DHCP_SERVER_STACK_SIZE, 0);
+static OSA_TASK_DEFINE(dhcpd_task, WLAN_TASK_PRI_HIGH, 1, CONFIG_DHCP_SERVER_STACK_SIZE, 0);
 
 OSA_TASK_HANDLE_DEFINE(dhcpd_task_Handle);
 

dhcpd/dns-server.c

@@ -222,8 +222,15 @@ void dhcp_enable_dns_server(char **domain_names)
         {
             dnss.count_qnames++;
         }
+#if !CONFIG_MEM_POOLS
         dnss.list_qnames = OSA_MemoryAllocate(dnss.count_qnames * sizeof(struct dns_qname));
+#else
+        /*TODO:This function is not called from anywhere .
+         * Please make sure to assign correct memory pool
+         * whenever this function will be used. */
 
+        dnss.list_qnames = OSA_MemoryPoolAllocate(buf_1280_MemoryPool);
+#endif
         for (i = 0; i < dnss.count_qnames; i++)
         {
             (void)memset(dnss.list_qnames[i].qname, 0, sizeof(struct dns_qname));
@@ -301,7 +308,11 @@ void dns_free_allocations(void)
     if (dnss.list_qnames != NULL)
     {
         dnss.count_qnames = 0;
+#if !CONFIG_MEM_POOLS
         OSA_MemoryFree(dnss.list_qnames);
+#else
+        OSA_MemoryPoolFree(buf_1280_MemoryPool, dnss.list_qnames);
+#endif
         dnss.list_qnames = NULL;
     }
     if (dnss.dnssock != -1)

incl/cli.h

@@ -1,19 +1,15 @@
 /*
- *  Copyright 2008-2022 NXP
- *
- *  SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2008-2022, 2024 NXP
+ * SPDX-License-Identifier: BSD-3-Clause
  *
  */
 
-/*! \file cli.h
- * \brief CLI module
- *
- *  \section cli_usage Usage
- *  The CLI module lets you register commands with the CLI interface. Modules
- *  that wish to register the commands should initialize the struct cli_command
- *  structure and pass this to cli_register_command(). These commands will then
- *  be available on the CLI.
+/*!\file cli.h
+ *\brief This file provides CLI interfaces to register commands in CLI mode.
  *
+ * Modules that wish to register the commands should initialize the struct cli_command
+ * structure and pass it to cli_register_command(). These commands will then
+ * be available on the CLI.
  */
 
 #ifndef __CLI_H__

incl/cli_utils.h

@@ -1,11 +1,8 @@
-/** @file cli_utils.h
- *
- *  @brief CLI Utils
- *
- *  Copyright 2008-2020 NXP
- *
- *  SPDX-License-Identifier: BSD-3-Clause
- *
+/* Copyright 2008-2020, 2024 NXP
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/*!\file cli_utils.h
+ *\brief This file provides Wi-Fi console utility interfaces.
  */
 
 #ifndef __CLI_UTILS_H__

incl/dhcp-server.h

@@ -1,12 +1,12 @@
 /*
- *  Copyright 2008-2022 NXP
+ *  Copyright 2008-2022, 2024 NXP
  *
  *  SPDX-License-Identifier: BSD-3-Clause
  *
  */
 
-/*! \file dhcp-server.h
- *  \brief DHCP server
+/*!\file dhcp-server.h
+ *\brief The file provides DHCP server configuration interfaces.
  *
  * The DHCP Server is required in the provisioning mode of the application to
  * assign IP Address to Wireless Clients that connect to the WM.
@@ -119,7 +119,7 @@ int dhcp_server_start(void *intrfc_handle);
  *
  * However, application can also start dns server without any domain names
  * specified to solve following issue.
- * Some of the client devices do not show WiFi signal strength symbol when
+ * Some of the client devices do not show Wi-Fi signal strength symbol when
  * connected to micro-AP in open mode, if dns queries are not resolved.
  * With dns server support enabled, dns server responds with ERROR_REFUSED
  * indicating that the DNS server refuses to provide whatever data client is

incl/iperf.h

@@ -1,9 +1,8 @@
-/** @file iperf.h
- *
- *  @brief  This file provides the support for network utility iperf
+/*!\file iperf.h
+ *\brief This file provides support for iperf console commands.
  */
 /*
- *  Copyright 2008-2020 NXP
+ *  Copyright 2008-2020, 2024 NXP
  *
  *  SPDX-License-Identifier: BSD-3-Clause
  *

incl/nxp_wifi.h

@@ -1,9 +1,11 @@
-/*
- *  Copyright 2023 NXP
+/*  Copyright 2023-2024 NXP
  *
  *  SPDX-License-Identifier: BSD-3-Clause
  *
  */
+/*!\file nxp_wifi.h
+ *\brief This file provides macros mapping between zephyr Kconfig and Wi-Fi driver.
+ */
 
 #ifndef __NXP_WIFI_H__
 #define __NXP_WIFI_H__
@@ -323,6 +325,10 @@ extern "C" {
 #define CONFIG_WIFI_CLOCKSYNC CONFIG_NXP_WIFI_CLOCKSYNC
 #endif
 
+#if CONFIG_NXP_WIFI_RTS_THRESHOLD
+#define CONFIG_WIFI_RTS_THRESHOLD 1
+#endif
+
 #if CONFIG_NXP_WIFI_UAP_WORKAROUND_STICKY_TIM
 #define CONFIG_UAP_WORKAROUND_STICKY_TIM CONFIG_NXP_WIFI_UAP_WORKAROUND_STICKY_TIM
 #endif

incl/port/net/hooks/lwip_default_hooks.h

@@ -1,11 +1,13 @@
-/** @file lwip_default_hooks.h
- *
- *  @brief This file provides lwip porting code
- *
- *  Copyright 2008-2023 NXP
+/*
+ *  Copyright 2008-2024 NXP
  *
  *  SPDX-License-Identifier: BSD-3-Clause
  */
+
+/*!\file lwip_default_hooks.h
+ *\brief This file provides interfaces for lwip hook.
+*/
+
 #ifndef _LWIP_DEFAULT_HOOKS_H_
 #define _LWIP_DEFAULT_HOOKS_H_
 #include <osa.h>
@@ -15,6 +17,11 @@
 #include "lwip/tcp.h"
 #include "lwip/pbuf.h"
 
+/**To find the valid net
+*\param[in] src  the source ipv4 address
+*\param[in] dest the destination ipv4 address
+*\return the match net if find, otherwise return NULL.
+*/
 struct netif *lwip_hook_ip4_route_src(const ip4_addr_t *src, const ip4_addr_t *dest);
 
 #define LWIP_HOOK_TCP_OUT_ADD_TCPOPTS(p, hdr, pcb, opts) lwip_hook_tcp_out_add_tcpopts(p, hdr, pcb, opts)

incl/port/net/wm_net.h

@@ -1,16 +1,14 @@
 /*
  * Copyright (c) 2016 Intel Corporation.
- * Copyright 2008-2023 NXP
+ * Copyright 2008-2024 NXP
  *
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/*! \file wm_net.h
- *  \brief Network Abstraction Layer
+/*!\file wm_net.h
+ *\brief This file provides interface for network abstraction layer.
  *
  * This provides the calls related to the network layer.
- *
- *
  */
 
 #ifndef _WM_NET_H_
@@ -538,14 +536,13 @@ int net_wlan_deinit(void);
 
 /** Get STA interface netif structure pointer
  *
- * \rerurn A pointer to STA interface netif structure
- *
+ * \return A pointer to STA interface netif structure
  */
 struct netif *net_get_sta_interface(void);
 
 /** Get uAP interface netif structure pointer
  *
- * \rerurn A pointer to uAP interface netif structure
+ * \return A pointer to uAP interface netif structure
  *
  */
 struct netif *net_get_uap_interface(void);
@@ -756,10 +753,10 @@ int net_get_if_ip_addr(uint32_t *ip, void *intrfc_handle);
  * net_get_sta_handle(), net_get_uap_handle() to get
  * interface handle.
  *
- * \param[in] mask Subnet Mask pointer
+ * \param[in] mask Subnet   Mask pointer
  * \param[in] intrfc_handle interface
  *
- * \return WM_SUCCESS on success or error code.
+ * \return WM_SUCCESS on success otherwise error code.
  */
 int net_get_if_ip_mask(uint32_t *nm, void *intrfc_handle);
 

incl/port/osa/mem_pool.h

@@ -1,9 +1,12 @@
 /*
- *  Copyright 2023 NXP
+ *  Copyright 2023-2024 NXP
  *
  *  SPDX-License-Identifier: BSD-3-Clause
  *
  */
+/*!\file mem_pool.h
+ *\brief This file provides OSA memory pool interfaces for Wi-Fi driver static memory operation.
+ */
 
 #ifndef MEM_POOL_H_
 #define MEM_POOL_H_
@@ -59,39 +62,35 @@ typedef TX_BLOCK_POOL MemPool_t;
 
 #endif
 
-/**
- *  Create a MemoryPool
- *
- *  @param ItemSize How big is an allocation.
- *  @param PreallocatedMemory Pointer to the preallocated memory
- *  you are dedicating to this pool.
- *  @param PreallocatedMemorySize How big is the buffer you are
- *  passing in.
- *  @param Alignment Power of 2 value denoting on which address boundary the
- *  memory will be aligned to. Must be at least sizeof(unsigned char *).
- *  @return A Handle to the pool, or NULL on failure.
+/** Create a MemoryPool
+ *\param[in,out] MemPool the created memory pool.
+ *\param[in] ItemSize How big is an allocation.
+ *\param[in] PreallocatedMemory Pointer to the preallocated memory
+ *           you are dedicating to this pool.
+ *\param[in] PreallocatedMemorySize How big is the buffer you are
+ *           passing in.
+ *\param[in] Alignment Power of 2 value denoting on which address boundary the
+ *           memory will be aligned to. Must be at least sizeof(unsigned char *).
+ *\return A Handle to the pool, or NULL on failure.
  */
 MemoryPool_t OSA_MemoryPoolCreate(
     MemPool_t *MemPool, int ItemSize, void *PreallocatedMemory, int PreallocatedMemorySize, int Alignment);
 
-/**
- *  Get a memory buffer from the pool.
- *
- *  Note that this can block, and cannnot be used from ISR context.
+/**Get a memory buffer from the pool.
+ * Note that this can block, and cannnot be used from ISR context.
  *
- *  @param pool A handle to a MemoryPool.
- *  @return A pointer or NULL on failure.
+ *\param[in] pool A handle to a MemoryPool.
+ *\return A pointer or NULL on failure.
  */
 void *OSA_MemoryPoolAllocate(MemoryPool_t pool);
 
-/**
- *  Return a memory buffer to the pool.
+/**free a memory buffer to the pool.
  *
- *  @note This can block, and cannnot be used from ISR context.
- *  @note There is no check that the memory passed in is valid.
+ *  note This can block, and cannnot be used from ISR context.
+ *  note There is no check that the memory passed in is valid.
  *
- *  @param pool A handle to a MemoryPool.
- *  @param memory memory obtained from OSA_MemoryPoolAllocate().
+ *\param[in] pool A handle to a MemoryPool.
+ *\param[in] memory memory obtained from OSA_MemoryPoolAllocate().
  */
 void OSA_MemoryPoolFree(MemoryPool_t pool, void *memory);
 

incl/port/osa/mem_pool_config.h

@@ -1,9 +1,11 @@
-/*
- *  Copyright 2023 NXP
+/*  Copyright 2023-2024 NXP
  *
  *  SPDX-License-Identifier: BSD-3-Clause
  *
  */
+/*!\file mem_pool_config.h
+ *\brief This file declares interface for memeory pool.
+ */
 
 #ifndef _MEM_POOL_CONFIG_H_
 #define _MEM_POOL_CONFIG_H_

incl/port/osa/osa.h

@@ -4,6 +4,10 @@
  *  SPDX-License-Identifier: BSD-3-Clause
  *
  */
+/*!\file osa.h
+ *\brief This file contains OSA wrapper declarations for timer, read/write lock and idle hook.
+*/
+
 
 #ifndef _OSA_H_
 #define _OSA_H_

incl/port/osa/slist.h

@@ -1,9 +1,5 @@
-/****************************************************************************
- *
- *  Copyright (c) 2023, Michael Becker (michael.f.becker@gmail.com)
- *
- *  This file is part of the FreeRTOS Add-ons project.
- *
+ /* Copyright (c) 2023, Michael Becker (michael.f.becker@gmail.com)
+ *  Copyright 2023-2024 NXP
  *  Source Code:
  *  https://github.com/michaelbecker/freertos-addons
  *
@@ -36,12 +32,9 @@
  *  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  *  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  *
- ***************************************************************************/
-/*
- *  Copyright 2023 NXP
- *
- *  SPDX-License-Identifier: BSD-3-Clause
- *
+ */
+/*!\file slist.h
+ *\brief This file is a part of the FreeRTOS Add-ons project.
  */
 
 #ifndef SLIST_H_