From 7ef385963cc32cd31c0e5523f06103dd8ddb28ec Mon Sep 17 00:00:00 2001 From: David Cermak Date: Wed, 23 Oct 2019 15:17:18 +0200 Subject: [PATCH] esp_netif: minor update of coding style based on clang-tidy guidelines and fix some copyright notices --- components/esp_netif/esp_netif_objects.c | 13 ++--- components/esp_netif/include/esp_netif.h | 3 +- .../esp_netif/include/esp_netif_sta_list.h | 6 +-- components/esp_netif/lwip/esp_netif_lwip.c | 54 ++++++++++--------- 4 files changed, 42 insertions(+), 34 deletions(-) diff --git a/components/esp_netif/esp_netif_objects.c b/components/esp_netif/esp_netif_objects.c index cf53416da..2c23126bf 100644 --- a/components/esp_netif/esp_netif_objects.c +++ b/components/esp_netif/esp_netif_objects.c @@ -133,15 +133,16 @@ esp_netif_t* esp_netif_next_unsafe(esp_netif_t* netif) { ESP_LOGV(TAG, "%s %p", __func__, netif); struct slist_netifs_s *item; + // Getting the first netif if argument is NULL if (netif == NULL) { item = SLIST_FIRST(&s_head); return (item == NULL) ? NULL : item->netif; - } else { - SLIST_FOREACH(item, &s_head, next) { - if (item->netif == netif) { - item = SLIST_NEXT(item, next); - return (item == NULL) ? NULL : item->netif; - } + } + // otherwise the next one (after the supplied netif) + SLIST_FOREACH(item, &s_head, next) { + if (item->netif == netif) { + item = SLIST_NEXT(item, next); + return (item == NULL) ? NULL : item->netif; } } return NULL; diff --git a/components/esp_netif/include/esp_netif.h b/components/esp_netif/include/esp_netif.h index b3d2f72a9..3233d4ec0 100644 --- a/components/esp_netif/include/esp_netif.h +++ b/components/esp_netif/include/esp_netif.h @@ -699,8 +699,9 @@ const char *esp_netif_get_desc(esp_netif_t *esp_netif); * @param event_type (either get or lost IP) * * @return specific event id which is configured to be raised if the interface lost or acquired IP address + * -1 if supplied event_type is not known */ -uint32_t esp_netif_get_event_id(esp_netif_t *esp_netif, esp_netif_ip_event_type_t event_type); +int32_t esp_netif_get_event_id(esp_netif_t *esp_netif, esp_netif_ip_event_type_t event_type); /** * @} diff --git a/components/esp_netif/include/esp_netif_sta_list.h b/components/esp_netif/include/esp_netif_sta_list.h index 3f672ec6e..d5bc6a690 100644 --- a/components/esp_netif/include/esp_netif_sta_list.h +++ b/components/esp_netif/include/esp_netif_sta_list.h @@ -1,4 +1,4 @@ -// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD +// Copyright 2019 Espressif Systems (Shanghai) PTE LTD // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -47,14 +47,14 @@ typedef struct { * @brief Get IP information for stations connected to the Wi-Fi AP interface * * @param[in] wifi_sta_list Wi-Fi station info list, returned from esp_wifi_ap_get_sta_list() - * @param[out] tcpip_sta_list IP layer station info list, corresponding to MAC addresses provided in wifi_sta_list + * @param[out] netif_sta_list IP layer station info list, corresponding to MAC addresses provided in wifi_sta_list * * @return * - ESP_OK * - ESP_ERR_ESP_NETIF_NO_MEM * - ESP_ERR_ESP_NETIF_INVALID_PARAMS */ -esp_err_t esp_netif_get_sta_list(const wifi_sta_list_t *wifi_sta_list, esp_netif_sta_list_t *tcpip_sta_list); +esp_err_t esp_netif_get_sta_list(const wifi_sta_list_t *wifi_sta_list, esp_netif_sta_list_t *netif_sta_list); /** * @} diff --git a/components/esp_netif/lwip/esp_netif_lwip.c b/components/esp_netif/lwip/esp_netif_lwip.c index 3138bb8da..701991a56 100644 --- a/components/esp_netif/lwip/esp_netif_lwip.c +++ b/components/esp_netif/lwip/esp_netif_lwip.c @@ -1,4 +1,4 @@ -// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD +// Copyright 2019 Espressif Systems (Shanghai) PTE LTD // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -44,25 +44,25 @@ #define ESP_NETIF_HOSTNAME_MAX_SIZE 32 +/** + * @brief thread safe tcpip function utility macro + */ +#define _LWIP_TASK_IPC_CALL(function, netif, param) \ +{ \ + return esp_netif_lwip_ipc_call(function, netif, (void *)(param)); \ +} + +// +// Internal types +// typedef enum esp_netif_action { ESP_NETIF_UNDEF, ESP_NETIF_STARTED, ESP_NETIF_STOPPED, } esp_netif_action_t; -extern sys_thread_t g_lwip_task; - -static const char *TAG = "esp_netif_lwip"; - -static sys_sem_t api_sync_sem = NULL; -static sys_sem_t api_lock_sem = NULL; -static bool tcpip_initialized = false; -static esp_netif_t *s_last_default_esp_netif = NULL; - /** * @brief Main esp-netif container with interface related information - * - * */ struct esp_netif_obj { // default interface addresses @@ -97,13 +97,17 @@ struct esp_netif_obj { int route_prio; }; -/** - * @brief thread safe tcpip function utility macro - */ -#define _LWIP_TASK_IPC_CALL(function, netif, param) \ -{ \ - return esp_netif_lwip_ipc_call(function, netif, (void *)param); \ -} +// +// Internal variables for this module +// +extern sys_thread_t g_lwip_task; + +static const char *TAG = "esp_netif_lwip"; + +static sys_sem_t api_sync_sem = NULL; +static sys_sem_t api_lock_sem = NULL; +static bool tcpip_initialized = false; +static esp_netif_t *s_last_default_esp_netif = NULL; /** * @brief Api callback from tcpip thread used to call esp-netif @@ -245,8 +249,9 @@ esp_netif_t* esp_netif_get_handle_from_netif_impl(void *dev) void* esp_netif_get_netif_impl(esp_netif_t *esp_netif) { - if (esp_netif) + if (esp_netif) { return esp_netif->lwip_netif; + } return NULL; } @@ -613,7 +618,7 @@ static esp_err_t esp_netif_stop_api(esp_netif_api_msg_t *msg) } if (esp_netif->flags&ESP_NETIF_DHCPS) { - dhcps_stop(lwip_netif); // TODO: dhcps checks status by its self + dhcps_stop(lwip_netif); // TODO(IDF-1099): dhcps checks status by its self if (ESP_NETIF_DHCP_STOPPED != esp_netif->dhcps_status) { esp_netif->dhcps_status = ESP_NETIF_DHCP_INIT; } @@ -1359,15 +1364,16 @@ const char *esp_netif_get_desc(esp_netif_t *esp_netif) return esp_netif->if_desc; } -uint32_t esp_netif_get_event_id(esp_netif_t *esp_netif, esp_netif_ip_event_type_t event_type) +int32_t esp_netif_get_event_id(esp_netif_t *esp_netif, esp_netif_ip_event_type_t event_type) { switch(event_type) { case ESP_NETIF_IP_EVENT_GOT_IP: return esp_netif->get_ip_event; case ESP_NETIF_IP_EVENT_LOST_IP: return esp_netif->lost_ip_event; + default: + return -1; } - return 0; } esp_err_t esp_netif_dhcps_option(esp_netif_t *esp_netif, esp_netif_dhcp_option_mode_t opt_op, esp_netif_dhcp_option_id_t opt_id, void *opt_val, @@ -1496,7 +1502,7 @@ esp_err_t esp_netif_dhcps_option(esp_netif_t *esp_netif, esp_netif_dhcp_option_m esp_err_t esp_netif_dhcpc_option(esp_netif_t *esp_netif, esp_netif_dhcp_option_mode_t opt_op, esp_netif_dhcp_option_id_t opt_id, void *opt_val, uint32_t opt_len) { - // TODO: when dhcp request timeout,change the retry count + // TODO(IDF-1100): when dhcp request timeout,change the retry count return ESP_ERR_NOT_SUPPORTED; }