1111 *
1212 * If no EULA applies, Cypress hereby grants you a personal, non-exclusive,
1313 * non-transferable license to copy, modify, and compile the Software source
14- * code solely for use in connection with Cypress's integrated circuit products.
14+ * code solely for use in connection with Cypress' integrated circuit products.
1515 * Any reproduction, modification, translation, compilation, or representation
1616 * of this Software except as specified above is prohibited without the express
1717 * written permission of Cypress.
2525 * not authorize its products for use in any products where a malfunction or
2626 * failure of the Cypress product may reasonably be expected to result in
2727 * significant property damage, injury or death ("High Risk Product"). By
28- * including Cypress's product in a High Risk Product, the manufacturer of such
28+ * including Cypress' product in a High Risk Product, the manufacturer of such
2929 * system or application assumes all risk of such use and in doing so agrees to
3030 * indemnify Cypress against all liability.
3131 */
@@ -57,61 +57,61 @@ class SclSTAInterface : public WiFiInterface, public EMACInterface {
5757 SCL_EMAC &emac = SCL_EMAC::get_instance(),
5858 OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance());
5959
60- /* * Get current instance of the SclSTAInterface
60+ /* * Gets the current instance of the SclSTAInterface
6161 *
62- * @return pointer to the object of class SclSTAInterface
62+ * @return Pointer to the object of class SclSTAInterface.
6363 */
6464 static SclSTAInterface *get_default_instance ();
6565
66- /* * Turn on the WiFi device
66+ /* * Turn ON the WiFi device
6767 *
6868 * @return void
6969 */
70- /* Turn on the wifi device*/
70+ /* Turns ON the WiFi device*/
7171 void wifi_on ();
7272
73- /* * Start the interface
73+ /* * Starts the interface
7474 *
7575 * Attempts to connect to a WiFi network. Requires ssid and passphrase to be set.
7676 * If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.
7777 *
78- * @return 0 on success, negative error code on failure
78+ * @return 0 on success, negative error code on failure.
7979 */
8080 nsapi_error_t connect ();
8181
82- /* * Start the interface
82+ /* * Starts the interface
8383 *
8484 * Attempts to connect to a WiFi network.
8585 *
86- * @param ssid Name of the network to connect to
87- * @param pass Security passphrase to connect to the network
88- * @param security Type of encryption for connection (Default: NSAPI_SECURITY_NONE)
89- * @param channel This parameter is not supported, setting it to anything else than 0 will result in NSAPI_ERROR_UNSUPPORTED
90- * @return 0 on success, or error code on failure
86+ * @param ssid Name of the network to connect to.
87+ * @param pass Security passphrase to connect to the network.
88+ * @param security Type of encryption for connection (Default: NSAPI_SECURITY_NONE).
89+ * @param channel This parameter is not supported, setting it to a value other than 0 will result in NSAPI_ERROR_UNSUPPORTED.
90+ * @return 0 on success, or error code on failure.
9191 */
9292 nsapi_error_t connect (const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE, uint8_t channel = 0 );
9393
94- /* * Stop the interface
95- * @return 0 on success, negative on failure
94+ /* * Stops the interface
95+ * @return 0 on success, negative on failure.
9696 */
9797 nsapi_error_t disconnect ();
9898
9999 /* * Set the WiFi network credentials
100100 *
101- * @param ssid Name of the network to connect to
102- * @param pass Security passphrase to connect to the network
103- * @param security Type of encryption for connection
101+ * @param ssid Name of the network to connect to.
102+ * @param pass Security passphrase to connect to the network.
103+ * @param security Type of encryption for connection.
104104 * (defaults to NSAPI_SECURITY_NONE)
105- * @return 0 on success, or error code on failure
105+ * @return 0 on success, or error code on failure.
106106 */
107107 nsapi_error_t set_credentials (const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE);
108108
109- /* * Set the WiFi network channel - NOT SUPPORTED
109+ /* * Sets the WiFi network channel - NOT SUPPORTED
110110 *
111- * This function is not supported and will return NSAPI_ERROR_UNSUPPORTED
111+ * This function is not supported and will return NSAPI_ERROR_UNSUPPORTED.
112112 *
113- * @param channel Channel on which the connection is to be made, or 0 for any (Default: 0)
114- * @return Not supported, returns NSAPI_ERROR_UNSUPPORTED
113+ * @param channel Channel on which the connection is to be made (Default: 0).
114+ * @return Not supported, returns NSAPI_ERROR_UNSUPPORTED.
115115 */
116116 nsapi_error_t set_channel (uint8_t channel)
117117 {
@@ -122,10 +122,10 @@ class SclSTAInterface : public WiFiInterface, public EMACInterface {
122122 }
123123
124124 /* * Set blocking status of interface.
125- * Nonblocking mode unsupported .
125+ * Nonblocking mode is not supported .
126126 *
127- * @param blocking true if connect is blocking
128- * @return 0 on success, negative error code on failure
127+ * @param blocking True if connect is blocking
128+ * @return 0 on success, negative error code on failure
129129 */
130130 nsapi_error_t set_blocking (bool blocking)
131131 {
@@ -138,38 +138,32 @@ class SclSTAInterface : public WiFiInterface, public EMACInterface {
138138 }
139139 /* * Gets the current radio signal strength for active connection
140140 *
141- * @return Connection strength in dBm (negative value)
141+ * @return Connection strength in dBm (negative value).
142142 */
143143 int8_t get_rssi ();
144144
145- /* * Scan for available networks
145+ /* * Scans for available networks - NOT SUPPORTED
146146 *
147- * This function will block.
148- *
149- * @param ap Pointer to allocated array to store discovered AP
150- * @param count Size of allocated @a res array, or 0 to only count available AP
151- * @param timeout Timeout in milliseconds; 0 for no timeout (Default: 0)
152- * @return Number of entries in @a, or if @a count was 0 number of available networks, negative on error
153- * see @a nsapi_error
147+ * @return NSAPI_ERROR_UNSUPPORTED
154148 */
155149 int scan (WiFiAccessPoint *res, unsigned count);
156150
157- /* * This function is used to know if the device is connected to the network
158- * @return SCL_SUCCESS if device is connected
151+ /* * This function is used to indicate if the device is connected to the network.
152+ * @return SCL_SUCCESS if device is connected.
159153 */
160154 int is_interface_connected ();
161155
162- /* * Get the BSSID (MAC address of device connected to)
156+ /* * Gets the BSSID (MAC address of device connected to)
163157 *
164- * @param bssid pointer to the BSSID value
165- * @return SCL_SUCCESS if BSSID is obtained successfully
166- * @return SCL_BADARG if input parameter is NULL
167- * @return SCL_ERROR if unable to fetch BSSID
158+ * @param bssid Pointer to the BSSID value.
159+ * @return SCL_SUCCESS if BSSID is obtained successfully.
160+ * @return SCL_BADARG if input parameter is NULL.
161+ * @return SCL_ERROR if unable to fetch BSSID.
168162 */
169163 int get_bssid (uint8_t *bssid);
170164
171- /* * This function is used to set up the wifi interface after wifi on
172- * @return SCL_SUCCESS if wifi interface is up successfully
165+ /* * This function is used to set up the WiFi interface after the WiFi on
166+ * @return SCL_SUCCESS if the WiFi interface is up successfully.
173167 */
174168 int wifi_set_up (void );
175169
0 commit comments