doc: add or move module description where missing
This commit is contained in:
parent
73248cc05e
commit
d4166faccc
@ -7,7 +7,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @ingroupgroup netdev
|
* @addtogroup netdev
|
||||||
*
|
*
|
||||||
* @{
|
* @{
|
||||||
* @file
|
* @file
|
||||||
|
|||||||
@ -9,6 +9,9 @@
|
|||||||
/**
|
/**
|
||||||
* @defgroup drivers_nrf24l01p NRF24L01+ Driver Interface
|
* @defgroup drivers_nrf24l01p NRF24L01+ Driver Interface
|
||||||
* @ingroup drivers
|
* @ingroup drivers
|
||||||
|
*
|
||||||
|
* @brief Low-level driver for nrf24l01+ transceiver
|
||||||
|
*
|
||||||
* @{
|
* @{
|
||||||
* @file
|
* @file
|
||||||
*
|
*
|
||||||
|
|||||||
@ -8,9 +8,10 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup radio_driver IEEE 802.15.4 radio driver interface
|
* @defgroup radio_driver IEEE 802.15.4 radio driver interface
|
||||||
* @brief API definitions for 802.15.4 radio transceivers' drivers
|
|
||||||
* @ingroup drivers
|
* @ingroup drivers
|
||||||
*
|
*
|
||||||
|
* @brief API definitions for 802.15.4 radio transceivers' drivers
|
||||||
|
*
|
||||||
* @{
|
* @{
|
||||||
* @file
|
* @file
|
||||||
* @author Kévin Roussel <Kevin.Roussel@inria.fr>
|
* @author Kévin Roussel <Kevin.Roussel@inria.fr>
|
||||||
|
|||||||
@ -19,14 +19,16 @@
|
|||||||
/**
|
/**
|
||||||
* @defgroup sys_pipe Pipe IPC
|
* @defgroup sys_pipe Pipe IPC
|
||||||
* @ingroup sys
|
* @ingroup sys
|
||||||
* @{
|
|
||||||
* @file
|
|
||||||
*
|
*
|
||||||
* @brief Generic pipe implementation.
|
* @brief Generic pipe implementation.
|
||||||
* @details This pipe implementation is a tight wrapper around a ringbuffer.
|
* @details This pipe implementation is a tight wrapper around a ringbuffer.
|
||||||
* It sends the calling thread to sleep if the ringbuffer is full
|
* It sends the calling thread to sleep if the ringbuffer is full
|
||||||
* or empty, respectively. It can be used in ISRs, too.
|
* or empty, respectively. It can be used in ISRs, too.
|
||||||
*
|
*
|
||||||
|
*
|
||||||
|
* @{
|
||||||
|
* @file
|
||||||
|
*
|
||||||
* @author René Kijewski <rene.kijewski@fu-berlin.de>
|
* @author René Kijewski <rene.kijewski@fu-berlin.de>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|||||||
@ -9,10 +9,13 @@
|
|||||||
/**
|
/**
|
||||||
* @defgroup sys_transceiver Transceiver
|
* @defgroup sys_transceiver Transceiver
|
||||||
* @ingroup sys
|
* @ingroup sys
|
||||||
|
*
|
||||||
|
* @brief The transceiver module implements a generic link abstraction to
|
||||||
|
* any radio interface.
|
||||||
|
*
|
||||||
* @{
|
* @{
|
||||||
*
|
*
|
||||||
* @file
|
* @file
|
||||||
* @brief Transceiver library
|
|
||||||
* @author Oliver Hahm <oliver.hahm@inria.fr>
|
* @author Oliver Hahm <oliver.hahm@inria.fr>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@ -143,7 +146,7 @@ extern "C" {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief The maximum of threads to register
|
* @brief The maximum of threads to register
|
||||||
*/
|
*/
|
||||||
#define TRANSCEIVER_MAX_REGISTERED (4)
|
#define TRANSCEIVER_MAX_REGISTERED (4)
|
||||||
|
|
||||||
@ -207,7 +210,7 @@ enum transceiver_msg_type_t {
|
|||||||
SET_ADDRESS, /**< Set the radio address */
|
SET_ADDRESS, /**< Set the radio address */
|
||||||
GET_LONG_ADDR, /**< Get the long radio address, if existing */
|
GET_LONG_ADDR, /**< Get the long radio address, if existing */
|
||||||
SET_LONG_ADDR, /**< Set the long radio address, if supported by hardware */
|
SET_LONG_ADDR, /**< Set the long radio address, if supported by hardware */
|
||||||
SET_MONITOR, /**< Set transceiver to monitor mode (disable address
|
SET_MONITOR, /**< Set transceiver to monitor mode (disable address
|
||||||
checking) */
|
checking) */
|
||||||
GET_PAN, /**< Get current pan */
|
GET_PAN, /**< Get current pan */
|
||||||
SET_PAN, /**< Set a new pan */
|
SET_PAN, /**< Set a new pan */
|
||||||
@ -230,7 +233,7 @@ enum transceiver_msg_type_t {
|
|||||||
* @brief Manage registered threads per transceiver
|
* @brief Manage registered threads per transceiver
|
||||||
*/
|
*/
|
||||||
typedef struct {
|
typedef struct {
|
||||||
transceiver_type_t transceivers; /**< the tranceivers the thread is
|
transceiver_type_t transceivers; /**< the tranceivers the thread is
|
||||||
registered for */
|
registered for */
|
||||||
kernel_pid_t pid; /**< the thread's pid */
|
kernel_pid_t pid; /**< the thread's pid */
|
||||||
} registered_t;
|
} registered_t;
|
||||||
@ -249,7 +252,7 @@ typedef struct {
|
|||||||
extern volatile kernel_pid_t transceiver_pid;
|
extern volatile kernel_pid_t transceiver_pid;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief An array of ignored link layer addresses
|
* @brief An array of ignored link layer addresses
|
||||||
*/
|
*/
|
||||||
extern radio_address_t transceiver_ignored_addr[TRANSCEIVER_MAX_IGNORED_ADDR];
|
extern radio_address_t transceiver_ignored_addr[TRANSCEIVER_MAX_IGNORED_ADDR];
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,4 @@
|
|||||||
/**
|
/*
|
||||||
* socket_base.h - Wraps all API types, constants and functions of the transport
|
|
||||||
* layer implementation.
|
|
||||||
*
|
|
||||||
* Copyright (C) 2013 INRIA.
|
* Copyright (C) 2013 INRIA.
|
||||||
*
|
*
|
||||||
* This file is subject to the terms and conditions of the GNU Lesser
|
* This file is subject to the terms and conditions of the GNU Lesser
|
||||||
@ -11,10 +8,15 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup socket_base Transport layer implementation
|
* @defgroup socket_base Transport layer implementation
|
||||||
|
*
|
||||||
* @ingroup net
|
* @ingroup net
|
||||||
* @brief This module implements the transport layer. This includes
|
* @brief This module implements basic transport layer socket functionality.
|
||||||
* 6LoWPAN UDP header compression and (experimental) 6LoWPAN TCP header
|
* This includes 6LoWPAN UDP header compression and (experimental)
|
||||||
* compression.
|
* 6LoWPAN TCP header compression.
|
||||||
|
*
|
||||||
|
* It wraps all API types, constants and functions of the transport layer
|
||||||
|
* implementation.
|
||||||
|
*
|
||||||
* @see <a href="http://tools.ietf.org/html/rfc6282#section-4.3">
|
* @see <a href="http://tools.ietf.org/html/rfc6282#section-4.3">
|
||||||
* RFC 6282 - Compression Format for IPv6 Datagrams over
|
* RFC 6282 - Compression Format for IPv6 Datagrams over
|
||||||
* IEEE 802.15.4-Based Networks - UDP Header Compression
|
* IEEE 802.15.4-Based Networks - UDP Header Compression
|
||||||
|
|||||||
@ -7,18 +7,22 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup oneway_malloc Oneway malloc implementation
|
* @defgroup oneway_malloc Oneway malloc
|
||||||
* @ingroup sys
|
* @ingroup sys
|
||||||
* @{
|
|
||||||
* @file malloc.h
|
|
||||||
* @brief A malloc implementation for MSP-430 boards without free.
|
|
||||||
*
|
*
|
||||||
* @details The toolchain of MSP-430 does not contain malloc() and friends.
|
* @brief A malloc implementation without free for boards where the
|
||||||
* These functions provide the same interface as the stdlib functions,
|
* toolchain does not implement dynamic memory allocation.
|
||||||
* but the option to free memory.
|
*
|
||||||
|
* The toolchain of MSP-430, for example, does not contain
|
||||||
|
* malloc() and friends. These functions provide the same
|
||||||
|
* interface as the stdlib functions, but the option to free
|
||||||
|
* memory.
|
||||||
*
|
*
|
||||||
* @note You should prefer statically allocated memory whenever possible.
|
* @note You should prefer statically allocated memory whenever possible.
|
||||||
*
|
*
|
||||||
|
* @{
|
||||||
|
* @file
|
||||||
|
*
|
||||||
* @author Kaspar Schleiser <kaspar@schleiser.de>
|
* @author Kaspar Schleiser <kaspar@schleiser.de>
|
||||||
* @author René Kijewski <rene.kijewski@fu-berlin.de>
|
* @author René Kijewski <rene.kijewski@fu-berlin.de>
|
||||||
*/
|
*/
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user