RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

lwip: improve and fix documentation

Browse Source
This commit is contained in:
Martine S. Lenders 2019-10-09 12:45:32 +02:00
parent cb18f8c99b
commit 0a2945164c
7 changed files with 100 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/doxygen/riot.doxyfile
View File

@ -828,7 +828,6 @@ EXCLUDE_PATTERNS = */board/*/tools/* \
*/cpu/native/osx-libc-extra \ */cpu/native/osx-libc-extra \
*/cpu/x86/include/* \ */cpu/x86/include/* \
*/drivers/kw2xrf/include/overwrites.h \ */drivers/kw2xrf/include/overwrites.h \
*/pkg/lwip/* \
*/pkg/tlsf/patch.txt \ */pkg/tlsf/patch.txt \
*/sys/include/embUnit/* \ */sys/include/embUnit/* \
*/sys/random/fortuna/* \ */sys/random/fortuna/* \

3
pkg/lwip/contrib/doc.txt
View File

@ -1,3 +0,0 @@
/**
* @defgroup pkg_lwip_contrib RIOT lwIP port
*/

5
pkg/lwip/doc.txt
View File

@ -3,8 +3,9 @@
* @ingroup pkg * @ingroup pkg
* @ingroup net * @ingroup net
* @brief Provides the lwIP network stack * @brief Provides the lwIP network stack
* @see http://savannah.nongnu.org/projects/lwip/ * @see https://savannah.nongnu.org/projects/lwip/
* @see https://www.nongnu.org/lwip/2_1_x/
* *
* lwIP is a lightweight TCP/IP stack primarily for usage with Ethernet. * lwIP is a lightweight TCP/IP stack primarily for usage with Ethernet.
* It can be used with the @ref sock API. * It can be used with the @ref net_sock API.
*/ */

26
pkg/lwip/include/arch/cc.h
View File

@ -7,13 +7,13 @@
*/ */
/** /**
* @defgroup pkg_lwip_arch_cc Compiler and processor description * @addtogroup pkg_lwip_sys
* @ingroup pkg_lwip
* @brief Describes compiler and processor to lwIP * @brief Describes compiler and processor to lwIP
* @{ * @{
* *
* @file * @file
* @brief Compiler and processor definitions * @brief Compiler/platform abstraction
* @see http://www.nongnu.org/lwip/2_1_x/group__compiler__abstraction.html
* *
* @author Martine Lenders <mlenders@inf.fu-berlin.de> * @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/ */
@ -48,7 +48,7 @@ extern "C" {
#endif #endif
/** /**
* @brief (sn)printf formatters for the generic lwIP types * @name (sn)printf formatters for the generic lwIP types
* @{ * @{
*/ */
#define X8_F "02" PRIx8 #define X8_F "02" PRIx8
@ -60,23 +60,22 @@ extern "C" {
#define X32_F PRIx32 #define X32_F PRIx32
#define SZT_F "lu" #define SZT_F "lu"
/** /** @} */
* @}
*/
/** /**
* @brief Compiler hints for packing structures * @name Compiler hints for packing structures
* @{ * @{
*/ */
#define PACK_STRUCT_FIELD(x) x #define PACK_STRUCT_FIELD(x) x
#define PACK_STRUCT_STRUCT __attribute__((packed)) #define PACK_STRUCT_STRUCT __attribute__((packed))
#define PACK_STRUCT_BEGIN #define PACK_STRUCT_BEGIN
#define PACK_STRUCT_END #define PACK_STRUCT_END
/** @} */
/** /**
* @} * @name Platform specific diagnostic output
* @{
*/ */
#ifdef MODULE_LOG #ifdef MODULE_LOG
# define LWIP_PLATFORM_DIAG(x) LOG_INFO x # define LWIP_PLATFORM_DIAG(x) LOG_INFO x
# ifdef NDEBUG # ifdef NDEBUG
@ -102,10 +101,7 @@ extern "C" {
} while (0) } while (0)
# endif # endif
#endif #endif
/** @} */
#define SYS_ARCH_PROTECT(x) mutex_lock(&x)
#define SYS_ARCH_UNPROTECT(x) mutex_unlock(&x)
#define SYS_ARCH_DECL_PROTECT(x) mutex_t x = MUTEX_INIT
#ifdef __cplusplus #ifdef __cplusplus
} }

82
pkg/lwip/include/arch/sys_arch.h
View File

@ -7,13 +7,14 @@
*/ */
/** /**
* @defgroup pkg_lwip_arch_sys_arch Architecture depentent definitions * @defgroup pkg_lwip_sys Porting layer
* @ingroup pkg_lwip * @ingroup pkg_lwip
* @brief Semaphores and mailboxes. * @brief System abstraction layer
* @{ * @{
* *
* @file * @file
* @brief Semaphore and mailboxes definitions. * @brief OS abstraction layer
* @see https://www.nongnu.org/lwip/2_1_x/group__sys__os.html
* *
* @author Martine Lenders <mlenders@inf.fu-berlin.de> * @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/ */
@ -34,27 +35,68 @@
extern "C" { extern "C" {
#endif #endif
/**
* @brief System configuration
*/
/* prefer mutexes rather than binary semaphores */
#define LWIP_COMPAT_MUTEX (0) #define LWIP_COMPAT_MUTEX (0)
#define SYS_MBOX_SIZE (8) /** @} */
typedef struct { /**
mbox_t mbox; * @name Critical sections protection definitions
msg_t msgs[SYS_MBOX_SIZE]; * @see https://www.nongnu.org/lwip/2_1_x/group__sys__prot.html
} sys_mbox_t; * @{
*/
#define SYS_ARCH_PROTECT(x) mutex_lock(&x)
#define SYS_ARCH_UNPROTECT(x) mutex_unlock(&x)
#define SYS_ARCH_DECL_PROTECT(x) mutex_t x = MUTEX_INIT
/** @} */
typedef mutex_t sys_mutex_t; /**
typedef sema_t sys_sem_t; * @name Semaphores definitions
typedef kernel_pid_t sys_thread_t; * @see https://www.nongnu.org/lwip/2_1_x/group__sys__sem.html
*/
typedef sema_t sys_sem_t; /**< Platform specific semaphore type */
static inline bool sys_sem_valid(sys_sem_t *sem)
{
return sem != NULL;
}
#define sys_sem_valid(sem) (sys_sem_valid(sem))
#define sys_sem_set_invalid(sem)
/** @} */
/**
* @name Mutexes definitions
* @see https://www.nongnu.org/lwip/2_1_x/group__sys__mutex.html
*/
typedef mutex_t sys_mutex_t; /**< Platform specific mutex type */
static inline bool sys_mutex_valid(sys_mutex_t *mutex) static inline bool sys_mutex_valid(sys_mutex_t *mutex)
{ {
return mutex != NULL; return mutex != NULL;
} }
static inline bool sys_sem_valid(sys_sem_t *sem) #define sys_mutex_valid(mutex) (sys_mutex_valid(mutex))
{ #define sys_mutex_set_invalid(mutex)
return sem != NULL; /** @} */
}
/**
* @name Mailboxes OS abstraction layer definitions
* @see https://www.nongnu.org/lwip/2_1_x/group__sys__mbox.html
* @{
*/
#define SYS_MBOX_SIZE (8)
/**
* @brief Platform specific mailbox type
*/
typedef struct {
mbox_t mbox; /**< RIOT mbox */
msg_t msgs[SYS_MBOX_SIZE]; /**< queue for the mbox */
} sys_mbox_t;
static inline bool sys_mbox_valid(sys_mbox_t *mbox) static inline bool sys_mbox_valid(sys_mbox_t *mbox)
{ {
@ -68,14 +110,16 @@ static inline void sys_mbox_set_invalid(sys_mbox_t *mbox)
} }
} }
#define sys_mutex_valid(mutex) (sys_mutex_valid(mutex))
#define sys_mutex_set_invalid(mutex)
#define sys_sem_valid(sem) (sys_sem_valid(sem))
#define sys_sem_set_invalid(sem)
#define sys_mbox_valid(mbox) (sys_mbox_valid(mbox)) #define sys_mbox_valid(mbox) (sys_mbox_valid(mbox))
#define sys_mbox_set_invalid(mbox) (sys_mbox_set_invalid(mbox)) #define sys_mbox_set_invalid(mbox) (sys_mbox_set_invalid(mbox))
/** @} */
typedef kernel_pid_t sys_thread_t; /**< Platform specific thread type */
#ifdef MODULE_RANDOM #ifdef MODULE_RANDOM
/**
* @brief Use `random_uint32()` to generate random numbers, if available
*/
#define LWIP_RAND() (random_uint32()) #define LWIP_RAND() (random_uint32())
#endif #endif

3
pkg/lwip/include/lwip/sock_internal.h
View File

@ -11,10 +11,11 @@
* @ingroup pkg_lwip * @ingroup pkg_lwip
* @brief Provides an implementation of the @ref net_sock for the * @brief Provides an implementation of the @ref net_sock for the
* @ref pkg_lwip * @ref pkg_lwip
* @internal
* @{ * @{
* *
* @file * @file
* @brief lwIP-specific function @ref definitions * @brief lwIP-specific function @ref net_sock definitions
* *
* @author Martine Lenders <mlenders@inf.fu-berlin.de> * @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/ */

34
pkg/lwip/include/sock_types.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup pkg_lwip_sock * @addtogroup pkg_lwip_sock
* @{ * @{
* *
* @file * @file
@ -27,41 +27,49 @@ extern "C" {
/** /**
* @brief Raw IP sock type * @brief Raw IP sock type
* @warning For network stack internal purposes only. Do not access members
* externally.
* @internal * @internal
*/ */
struct sock_ip { struct sock_ip {
struct netconn *conn; struct netconn *conn; /**< lwIP network connection object */
}; };
/** /**
* @brief TCP sock type * @brief TCP sock type
* @warning For network stack internal purposes only. Do not access members
* externally.
* @internal * @internal
*/ */
struct sock_tcp { struct sock_tcp {
struct netconn *conn; struct netconn *conn; /**< lwIP network connection object */
struct sock_tcp_queue *queue; struct sock_tcp_queue *queue; /**< Queue the sock might have been generated from */
mutex_t mutex; mutex_t mutex; /**< Mutex to protect the sock */
struct pbuf *last_buf; struct pbuf *last_buf; /**< Last received data */
ssize_t last_offset; ssize_t last_offset; /**< Offset in struct sock_tcp::last_buf since last read */
}; };
/** /**
* @brief TCP queue type * @brief TCP queue type
* @warning For network stack internal purposes only. Do not access members
* externally.
*/ */
struct sock_tcp_queue { struct sock_tcp_queue {
struct netconn *conn; struct netconn *conn; /**< lwIP network connection object */
struct sock_tcp *array; struct sock_tcp *array; /**< Allocation array for sock objects to generate */
mutex_t mutex; mutex_t mutex; /**< Mutex to protect the queue */
unsigned short len; unsigned short len; /**< Length of the struct sock_tcp_queue::array */
unsigned short used; unsigned short used; /**< Used entries in struct sock_tcp_queue::array */
}; };
/** /**
* @brief UDP sock type * @brief UDP sock type
* @warning For network stack internal purposes only. Do not access members
* externally.
* @internal * @internal
*/ */
struct sock_udp { struct sock_udp {
struct netconn *conn; struct netconn *conn; /**< lwIP network connection object */
}; };
#ifdef __cplusplus #ifdef __cplusplus