mirror/pico-sdk
1
0
Fork 0
mirror of https://github.com/raspberrypi/pico-sdk.git synced 2025-12-10 07:14:36 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve error code description for some cyw43 connection methods (#2586)

Browse source 
* Improve error code description for some cyw43 connection methods

Fixes #2564

* Apply suggestions from code review

Put error description on separate lines for clarity.

Co-authored-by: Andrew Scheller <lurch@durge.org>

---------

Co-authored-by: Andrew Scheller <lurch@durge.org>
This commit is contained in:
Peter Harper 2025-07-23 15:11:18 +01:00 • committed by GitHub
parent f194749d47
commit bf4906b1b5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h
View file

@ -399,7 +399,9 @@ void cyw43_arch_disable_ap_mode(void);
* \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK,
* \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_)
* *
* \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes * \return 0 if the connection is successful.
* PICO_ERROR_BADAUTH is returned if the WiFi password is wrong.
* PICO_ERROR_CONNECT_FAILED is returned if the connection failed for some other reason.
*/ */
int cyw43_arch_wifi_connect_blocking(const char *ssid, const char *pw, uint32_t auth); int cyw43_arch_wifi_connect_blocking(const char *ssid, const char *pw, uint32_t auth);
@ -413,7 +415,9 @@ int cyw43_arch_wifi_connect_blocking(const char *ssid, const char *pw, uint32_t
* \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK,
* \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_)
* *
* \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes * \return 0 if the connection is successful.
* PICO_ERROR_BADAUTH is returned if the WiFi password is wrong.
* PICO_ERROR_CONNECT_FAILED is returned if the connection failed for some other reason.
*/ */
int cyw43_arch_wifi_connect_bssid_blocking(const char *ssid, const uint8_t *bssid, const char *pw, uint32_t auth); int cyw43_arch_wifi_connect_bssid_blocking(const char *ssid, const uint8_t *bssid, const char *pw, uint32_t auth);
@ -427,7 +431,10 @@ int cyw43_arch_wifi_connect_bssid_blocking(const char *ssid, const uint8_t *bssi
* \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_)
* \param timeout how long to wait in milliseconds for a connection to succeed before giving up * \param timeout how long to wait in milliseconds for a connection to succeed before giving up
* *
* \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes * \return 0 if the connection is successful.
* PICO_ERROR_TIMEOUT is returned if the timeout is reached before a successful connection.
* PICO_ERROR_BADAUTH is returned if the WiFi password is wrong.
* PICO_ERROR_CONNECT_FAILED is returned if the connection failed for some other reason.
*/ */
int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_t auth, uint32_t timeout); int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_t auth, uint32_t timeout);
@ -442,7 +449,10 @@ int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_
* \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_)
* \param timeout how long to wait in milliseconds for a connection to succeed before giving up * \param timeout how long to wait in milliseconds for a connection to succeed before giving up
* *
* \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes * \return 0 if the connection is successful.
* PICO_ERROR_TIMEOUT is returned if the timeout is reached before a successful connection.
* PICO_ERROR_BADAUTH is returned if the WiFi password is wrong.
* PICO_ERROR_CONNECT_FAILED is returned if the connection failed for some other reason.
*/ */
int cyw43_arch_wifi_connect_bssid_timeout_ms(const char *ssid, const uint8_t *bssid, const char *pw, uint32_t auth, uint32_t timeout); int cyw43_arch_wifi_connect_bssid_timeout_ms(const char *ssid, const uint8_t *bssid, const char *pw, uint32_t auth, uint32_t timeout);