Skip to content

Improve error code description for some cyw43 connection methods #2586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2025
Merged

Improve error code description for some cyw43 connection methods #2586

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27a8c73
Improve error code description for some cyw43 connection methods
peterharperuk Jul 23, 2025
f648350
Apply suggestions from code review
peterharperuk Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
* \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);

Expand All @@ -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,
* \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);

Expand All @@ -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_)
* \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);

Expand All @@ -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_)
* \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);

Expand Down
Loading