Update COMPONENT_SCL.

Author: dustin-crossman

features/netsocket/emac-drivers/TARGET_Cypress/COMPONENT_SCL/interface/SclSTAInterface.cpp

@@ -43,14 +43,10 @@
 #include "scl_ipc.h"
 #include "mbed_wait_api.h"
 
-#define PARAM_LEN                             (20)
 
-struct network_params_t {
-    char ip_address[PARAM_LEN];
-    char netmask[PARAM_LEN];
-    char gateway[PARAM_LEN];
-    int  connection_status;
-};
+/** @file
+ *  Provides SCL interface functions to be used with WiFiInterface or NetworkInterface Objects
+ */
 
 struct scl_tx_nw_credentials {
     nsapi_security_t network_security_type;
@@ -59,7 +55,8 @@ struct scl_tx_nw_credentials {
     const char* network_ssid;
     const char* network_passphrase;
 } scl_tx_nw_credentials_t;
-struct network_params_t network_parameter;
+
+network_params_t network_parameter;
 
 int scl_toerror(scl_result_t res)
 {
@@ -217,7 +214,7 @@ nsapi_error_t SclSTAInterface::connect()
     //Get the network parameter from NP
     while ((network_parameter.connection_status != NSAPI_STATUS_GLOBAL_UP) && delay_timeout < NW_CONNECT_TIMEOUT) {
         ret_val = scl_get_nw_parameters(&network_parameter);
-        wait_us(NW_DELAY_TIME);
+        wait_us(NW_DELAY_TIME_US);
         delay_timeout++;
     }
 

features/netsocket/emac-drivers/TARGET_Cypress/COMPONENT_SCL/interface/SclSTAInterface.h

@@ -44,11 +44,11 @@
 #include "scl_emac.h"
 #include "scl_wifi_api.h"
 #include "scl_types.h"
-#define MAX_SSID_LENGTH                       (33)
-#define MAX_PASSWORD_LENGTH                   (64)
+#define MAX_SSID_LENGTH                       (33) /**< Maximum ssid length */
+#define MAX_PASSWORD_LENGTH                   (64) /**< Maximum password length */
 
 /** SclSTAInterface class
- *  Implementation of the NetworkStack for the SCL
+ *  Implementation of the Network Stack for the SCL
  */
 class SclSTAInterface : public WiFiInterface, public EMACInterface {
 public:
@@ -63,16 +63,15 @@ class SclSTAInterface : public WiFiInterface, public EMACInterface {
      */
 	static SclSTAInterface *get_default_instance();
 
-	/** Turn ON the WiFi device
+	/** Turns on the Wi-Fi device
     *
     *  @return         void
     */
-    /* Turns ON the WiFi device*/
     void wifi_on();
 
     /** Starts the interface
      *
-     *  Attempts to connect to a WiFi network. Requires ssid and passphrase to be set.
+     *  Attempts to connect to a Wi-Fi network. Requires ssid and passphrase to be set.
      *  If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.
      *
      *  @return         0 on success, negative error code on failure.
@@ -81,34 +80,35 @@ class SclSTAInterface : public WiFiInterface, public EMACInterface {
 
     /** Starts the interface
      *
-     *  Attempts to connect to a WiFi network.
+     *  Attempts to connect to a Wi-Fi network.
      *
      *  @param ssid      Name of the network to connect to.
      *  @param pass      Security passphrase to connect to the network.
      *  @param security  Type of encryption for connection (Default: NSAPI_SECURITY_NONE).
      *  @param channel   This parameter is not supported, setting it to a value other than 0 will result in NSAPI_ERROR_UNSUPPORTED.
-     *  @return          0 on success, or error code on failure.
+     *  @return          0 on success, negative error code on failure.
      */
     nsapi_error_t connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE, uint8_t channel = 0);
 
-    /** Stops the interface
-     *  @return             0 on success, negative on failure.
+    /** Disconnects the interface
+     *
+     *  @return             0 on success, negative error code on failure.
      */
     nsapi_error_t disconnect();
 
-    /** Set the WiFi network credentials
+    /** Set the Wi-Fi network credentials
      *
      *  @param ssid      Name of the network to connect to.
      *  @param pass      Security passphrase to connect to the network.
      *  @param security  Type of encryption for connection.
      *                   (defaults to NSAPI_SECURITY_NONE)
-     *  @return          0 on success, or error code on failure.
+     *  @return          0 on success, negative error code on failure.
      */
     nsapi_error_t set_credentials(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE);
 
-    /** Sets the WiFi network channel - NOT SUPPORTED
+    /** Sets the Wi-Fi network channel - NOT SUPPORTED
      *
-     * This function is not supported and will return NSAPI_ERROR_UNSUPPORTED.
+     *  This function is not supported and will return NSAPI_ERROR_UNSUPPORTED.
      *
      *  @param channel   Channel on which the connection is to be made (Default: 0).
      *  @return          Not supported, returns NSAPI_ERROR_UNSUPPORTED.
@@ -149,11 +149,12 @@ class SclSTAInterface : public WiFiInterface, public EMACInterface {
     int scan(WiFiAccessPoint *res, unsigned count);
 
     /** This function is used to indicate if the device is connected to the network.
+     *
      *  @return          SCL_SUCCESS if device is connected.
      */
     int is_interface_connected();
 
-    /** Gets the BSSID (MAC address of device connected to)
+    /** Gets the BSSID (MAC address of device connected to).
      *
      *  @param bssid   Pointer to the BSSID value.
      *  @return        SCL_SUCCESS if BSSID is obtained successfully.
@@ -162,16 +163,18 @@ class SclSTAInterface : public WiFiInterface, public EMACInterface {
      */
     int get_bssid(uint8_t *bssid);
 
-    /** This function is used to set up the WiFi interface after the WiFi on
-     * @return          SCL_SUCCESS if the WiFi interface is up successfully.
+    /** This function is used to set up the Wi-Fi interface.
+     *  This function should be used after the wifi_on.
+     *
+     * @return          SCL_SUCCESS if the Wi-Fi interface is set up successfully.
      */
     int wifi_set_up(void);
 
 private:
 
-    char _ssid[MAX_SSID_LENGTH]; /* The longest possible name (defined in 802.11) +1 for the \0 */
-    char _pass[MAX_PASSWORD_LENGTH]; /* The longest allowed passphrase + 1 */
-    nsapi_security_t _security;
-    SCL_EMAC &_scl_emac;
+    char _ssid[MAX_SSID_LENGTH]; /**< The longest possible name (defined in 802.11) +1 for the \0 */
+    char _pass[MAX_PASSWORD_LENGTH]; /**< The longest allowed passphrase + 1 */
+    nsapi_security_t _security; /**< Security type */
+    SCL_EMAC &_scl_emac; /**< SCL_EMAC object */
 };
-#endif
+#endif /* ifndef SCL_STA_INTERFACE_H */

features/netsocket/emac-drivers/TARGET_Cypress/COMPONENT_SCL/interface/default_wifi_interface.cpp

@@ -32,6 +32,17 @@
 
 #include "SclSTAInterface.h"
 
+/** @file
+*  Provides function definition to override get_target_default_intance of WiFiInterface and NetworkInterface classes
+*/
+
+/**
+ * Returns the WiFiInterface Object
+ * This function can be called using WiFiInterface or NetworkInterface objects
+ *
+ * @return         pointer to WiFiInterface object.
+ */
+
 WiFiInterface *WiFiInterface::get_target_default_instance()
 {
     static SclSTAInterface wifi;

features/netsocket/emac-drivers/TARGET_Cypress/COMPONENT_SCL/interface/emac_eapol.h

@@ -41,15 +41,13 @@
 #include "lwip/ethip6.h"
 #include "mbed_shared_queues.h"
 #include "scl_buffer_api.h"
-#include "emac_eapol.h"
 #include "cy_result.h"
 #include "cy_pdl.h"
 #include "scl_ipc.h"
 
-extern "C"
-{
-    eapol_packet_handler_t emac_eapol_packet_handler = NULL;
-} // extern "C"
+/** @file
+ *  Provides EMAC interface functions to be used with the SCL_EMAC object
+ */
 
 SCL_EMAC::SCL_EMAC(scl_interface_role_t role)
     : interface_type(role)
@@ -107,7 +105,7 @@ bool SCL_EMAC::power_up()
 {
     if (!powered_up) {      
         if (scl_wifi_on() != true) {
-            SCL_LOG(("returning false in scl_wifi_on()\n"));
+            SCL_LOG(("returning False in scl_wifi_on()\n"));
             return false;
         }
         powered_up = true;
@@ -127,7 +125,7 @@ bool SCL_EMAC::get_hwaddr(uint8_t *addr) const
 		return true;
 	}
 	else {
-		SCL_LOG(("return false in SCL_EMAC::gethwaddr\n"));
+		SCL_LOG(("return False in SCL_EMAC::gethwaddr\n"));
 	    return false;
 	}
 
@@ -190,34 +188,6 @@ void SCL_EMAC::set_activity_cb(mbed::Callback<void(bool)> cb)
 
 extern "C"
 {
-
-    void emac_receive_eapol_packet(scl_buffer_t buffer)
-    {
-        if (buffer != NULL) {
-            if (emac_eapol_packet_handler != NULL) {
-                emac_eapol_packet_handler(buffer);
-            } else {
-                scl_buffer_release(buffer, SCL_NETWORK_RX);
-            }
-        }
-    }
-
-    scl_result_t emac_register_eapol_packet_handler(eapol_packet_handler_t eapol_packet_handler)
-    {
-
-        if (emac_eapol_packet_handler == NULL) {
-            emac_eapol_packet_handler = eapol_packet_handler;
-            return SCL_SUCCESS;
-        }
-
-        return SCL_HANDLER_ALREADY_REGISTERED;
-    }
-
-    void emac_unregister_eapol_packet_handler(void)
-    {
-        emac_eapol_packet_handler = NULL;
-    }
-
     void scl_network_process_ethernet_data(scl_buffer_t buffer)
     {
         emac_mem_buf_t *mem_buf = NULL;