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

Update documentation of ipv6.h

Browse Source
This commit is contained in:
authmillenon 2013-08-08 14:45:03 +02:00 committed by authmillenon
parent 89a673d029
commit 5b54ef66e2
2 changed files with 85 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sys/net/sixlowpan/include/ipv6.h
View File

@ -1,5 +1,6 @@
/*
* 6LoWPAN - Wraps all API types, constants and functions of 6LoWPAN in Layer 3.
/**
* ipv6.h - Wraps all API types, constants and functions of
* 6LoWPAN in layer 3.
*
* Copyright (C) 2013 INRIA.
*
@ -9,10 +10,9 @@
*
* @ingroup sixlowpan
* @{
* @file ipv6.h
* @file
* @brief IPv6 and ICMP functions
* @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @}
*/
#ifndef IPV6_H
#define IPV6_H
@ -26,4 +26,7 @@
#include "../ip.h" /* TODO: remove if not needed anymore */
#include "../icmp.h" /* TODO: remove if not needed anymore */
/**
* @}
*/
#endif /* IPV6_H */

90
sys/net/sixlowpan/include/sixlowpan/error.h
View File

@ -1,5 +1,5 @@
/**
* 6LoWPAN error codes
* sixlowpan/error.h - 6LoWPAN error codes
*
* Copyright (C) 2013 INRIA.
*
@ -9,7 +9,7 @@
*
* @ingroup sixlowpan
* @{
* @file sixlowpan/error.h
* @file
* @brief 6LoWPAN error codes
* @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @}
@ -19,18 +19,84 @@
#define SIXLOWPAN_ERROR_H
#ifndef SUCCESS
/**
* Functions return this if call was success. Only defined if not
* already defined by other header.
*/
#define SUCCESS (0)
#endif
#define SIXLOWERROR_ARRAYFULL (132) // array is full
#define SIXLOWERROR_NULLPTR (133) // null pointer error
#define SIXLOWERROR_VALUE (134) // illegal value
#define SIXLOWERROR_ADDRESS (135) // illegal address
#define SIXLOWERROR_DISPATCH (136) // lowpan dispatch unknown
#define SIXLOWERROR_FSTFRAG (137) // first lowpan fragment not received
#define SIXLOWERROR_INVFRAG (138) // invalid fragment received
#define SIXLOWERROR_SCI (139) // source context not found
#define SIXLOWERROR_DCI (140) // destination context not found
#define SIXLOWERROR_CSUM (141) // wrong checksum
/**
* Error code that signals that array is full.
*/
#define SIXLOWERROR_ARRAYFULL (132)
/**
* Error code that signals a NULL pointer error.
*/
#define SIXLOWERROR_NULLPTR (133)
/**
* Error code that signals an illegal value.
*/
#define SIXLOWERROR_VALUE (134)
/**
* Error code that signals an illegal address.
*/
#define SIXLOWERROR_ADDRESS (135)
/**
* Error code that signals an unknown 6LoWPAN dispatch
* @see <a href="http://tools.ietf.org/html/rfc4944#section-5">
* RFC 4944, Section 5: LoWPAN Adaptation Layer and Frame Format
* </a>
*/
#define SIXLOWERROR_DISPATCH (136)
/**
* Error code that signals that the first 6LoWPAN fragment was
* not received
* @see <a href="http://tools.ietf.org/html/rfc4944#section-5.3">
* RFC 4944, Section 5.3: Fragmentation Type and Header
* </a>
*/
#define SIXLOWERROR_FSTFRAG (137)
/**
* Error code that signals that an invalid 6LoWPAN fragment was
* received.
* @see <a href="http://tools.ietf.org/html/rfc4944#section-5.3">
* RFC 4944, Section 5.3: Fragmentation Type and Header
* </a>
*/
#define SIXLOWERROR_INVFRAG (138)
/**
* Error code that signals that the source context identifier was not
* found.
* @see <a href="http://tools.ietf.org/html/rfc6282#section-3.1">
* RFC 6282, Section 3.1: LOWPAN_IPHC Encoding format
* </a>
*/
#define SIXLOWERROR_SCI (139)
/**
* Error code that signals that the destination context identifier was
* not found.
* @see <a href="http://tools.ietf.org/html/rfc6282#section-3.1">
* RFC 6282, Section 3.1: LOWPAN_IPHC Encoding format
* </a>
*/
#define SIXLOWERROR_DCI (140)
/**
* Error code that signals that the destination context identifier was
* not found.
*/
#define SIXLOWERROR_CSUM (141)
/**
* @}
*/
#endif /* SIXLOWPAN_ERROR_H */