abawo/pico-sdk
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Various Documentation Updates + bump version to SDK1.5.0-develop (#1220)

Browse Source 
* minor cleanup of lwip+tinyusb docs, and bump sdk verison number to 1.5.0-develop
* Update cyw43_arch docs for async_context_use
* remove accidental copy of some comments
This commit is contained in:
Graham Sanderson
2023-02-06 15:07:37 -06:00
committed by GitHub
parent a916761e7d
commit ab18927533
7 changed files with 97 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
src/rp2_common/pico_lwip/doc.h
View File

@ -1,32 +1,20 @@
/**
* \defgroup pico_lwip pico_lwip
* \brief Wrapper libraries for <a href="https://savannah.nongnu.org/projects/lwip/lwIP">lwIP</a>
* \brief Integration/wrapper libraries for <a href="https://savannah.nongnu.org/projects/lwip/lwIP">lwIP</a>
* the documentation for which is <a href="https://www.nongnu.org/lwip/2_1_x/index.html">here</a>.
*
* The following libraries are provided that contain the equivalent lwIP functionality groups:
* The main \c \b pico_lwip library itself aggregates the lwIP RAW API: \c \b pico_lwip_core, \c \b pico_lwip_core4, \c \b pico_lwip_core6, \c \b pico_lwip_api, \c \b pico_lwip_netif, \c \b pico_lwip_sixlowpan and \c \b pico_lwip_ppp.
*
* * \c \b pico_lwip_core -
* * \c \b pico_lwip_core4 -
* * \c \b pico_lwip_core6 -
* * \c \b pico_lwip_netif -
* * \c \b pico_lwip_sixlowpan -
* * \c \b pico_lwip_ppp -
* * \c \b pico_lwip_api -
* If you wish to run in NO_SYS=1 mode, then you can link \c \b pico_lwip along with \ref pico_lwip_nosys.
*
* The following libraries are provided that contain the equivalent lwIP application support:
* If you wish to run in NO_SYS=0 mode, then you can link \c \b pico_lwip with (for instance) \ref pico_lwip_freertos,
* and also link in pico_lwip_api for the additional blocking/thread-safe APIs.
*
* * \c \b pico_lwip_snmp -
* * \c \b pico_lwip_http -
* * \c \b pico_lwip_makefsdata -
* * \c \b pico_lwip_iperf -
* * \c \b pico_lwip_smtp -
* * \c \b pico_lwip_sntp -
* * \c \b pico_lwip_mdns -
* * \c \b pico_lwip_netbios -
* * \c \b pico_lwip_tftp -
* * \c \b pico_lwip_mbedtls -
* * \c \b pico_lwip_mqtt -
* Additionally you must link in \ref pico_lwip_arch unless you provide your own compiler bindings for lwIP.
*
* The SDK Provides a common set of functionality in \c \p pico_lwip which aggregates:
* Additional individual pieces of lwIP functionality are available à la cart, by linking any of the libraries below.
*
* The following libraries are provided that contain exactly the equivalent lwIP functionality groups:
*
* * \c \b pico_lwip_core -
* * \c \b pico_lwip_core4 -
@ -34,12 +22,25 @@
* * \c \b pico_lwip_netif -
* * \c \b pico_lwip_sixlowpan -
* * \c \b pico_lwip_ppp -
* * \c \b pico_lwip_api -
*
* The following additional libraries are provided:
* The following libraries are provided that contain exactly the equivalent lwIP application support:
*
* * \c \b pico_lwip - Aggregates the lwIP RAW API: \c \b pico_lwip_core, \c \b pico_lwip_core4, \c \b pico_lwip_core6, \c \b pico_lwip_api, \c \b pico_lwip_netif, \c \b pico_lwip_sixlowpan and \c \b pico_lwip_ppp. It does
* not include \c \b pico_lwip_api, which requires NO_SYS=0. You should include the latter separately if you want it.
* * \c \b pico_lwip_snmp -
* * \c \b pico_lwip_http -
* * \c \b pico_lwip_makefsdata -
* * \c \b pico_lwip_iperf -
* * \c \b pico_lwip_smtp -
* * \c \b pico_lwip_sntp -
* * \c \b pico_lwip_mdns -
* * \c \b pico_lwip_netbios -
* * \c \b pico_lwip_tftp -
* * \c \b pico_lwip_mbedtls -
* * \c \b pico_lwip_mqtt -
*
* * \c \b pico_lwip_arch - lwIP required compiler adapters. This is not included in \c \b pico_lwip in case you wish to replace them.
* * \c \b pico_lwip_nosys - basic stub functions for NO_SYS mode.
*/
/** \defgroup pico_lwip_arch pico_lwip_arch
* \ingroup pico_lwip
* \brief lwIP compiler adapters. This is not included by default in \c \b pico_lwip in case you wish to implement your own.
*/

11
src/rp2_common/pico_lwip/include/pico/lwip_freertos.h
View File

@ -14,8 +14,15 @@
extern "C" {
#endif
/** \file pico/lwip_freertos.h
* \defgroup pico_lwip_freertos pico_lwip_freertos
* \ingroup pico_lwip
* \brief Glue library for integration lwIP in \c NO_SYS=0 mode with the SDK. Simple \c init and \c deinit
* are all that is required to hook up lwIP (with full blocking API support) via an \ref async_context instance.
*/
/*! \brief Initializes lwIP (NO_SYS=0 mode) support support for FreeRTOS using the provided async_context
* \ingroup pico_lwip
* \ingroup pico_lwip_freertos
*
* If the initialization succeeds, \ref lwip_freertos_deinit() can be called to shutdown lwIP support
*
@ -27,7 +34,7 @@ extern "C" {
bool lwip_freertos_init(async_context_t *context);
/*! \brief De-initialize lwIP (NO_SYS=0 mode) support for FreeRTOS
* \ingroup pico_lwip
* \ingroup pico_lwip_freertos
*
* Note that since lwIP may only be initialized once, and doesn't itself provide a shutdown mechanism, lwIP
* itself may still consume resources.

21
src/rp2_common/pico_lwip/include/pico/lwip_nosys.h
View File

@ -14,18 +14,25 @@
extern "C" {
#endif
/** \file pico/lwip_nosys.h
* \defgroup pico_lwip_nosys pico_lwip_nosys
* \ingroup pico_lwip
* \brief Glue library for integration lwIP in \c NO_SYS=1 mode with the SDK. Simple \c init and \c deinit
* are all that is required to hook up lwIP via an \ref async_context instance.
*/
/*! \brief Initializes lwIP (NO_SYS=1 mode) support support using the provided async_context
* \ingroup pico_lwip
*
* If the initialization succeeds, \ref lwip_nosys_deinit() can be called to shutdown lwIP support
*
* \param context the async_context instance that provides the abstraction for handling asynchronous work.
* \return true if the initialization succeeded
* \ingroup pico_lwip_nosys
*
* If the initialization succeeds, \ref lwip_nosys_deinit() can be called to shutdown lwIP support
*
* \param context the async_context instance that provides the abstraction for handling asynchronous work.
* \return true if the initialization succeeded
*/
bool lwip_nosys_init(async_context_t *context);
/*! \brief De-initialize lwIP (NO_SYS=1 mode) support
* \ingroup pico_lwip
* \ingroup pico_lwip_nosys
*
* Note that since lwIP may only be initialized once, and doesn't itself provide a shutdown mechanism, lwIP
* itself may still consume resources