Browse Source

net: intial import of the ZEP protocol

dev/timer
Martine Lenders 8 years ago
parent
commit
c5318336ae
  1. 8
      Makefile.dep
  2. 3
      sys/Makefile
  3. 241
      sys/include/net/ng_zep.h
  4. 1
      sys/net/application_layer/ng_zep/Makefile
  5. 1081
      sys/net/application_layer/ng_zep/ng_zep.c
  6. 3
      sys/shell/commands/Makefile
  7. 98
      sys/shell/commands/sc_zep.c
  8. 11
      sys/shell/commands/shell_commands.c

8
Makefile.dep

@ -73,6 +73,14 @@ ifneq (,$(filter xbee,$(USEMODULE)))
USEMODULE += ng_ieee802154
endif
ifneq (,$(filter ng_zep,$(USEMODULE)))
USEMODULE += hashes
USEMODULE += ng_ieee802154
USEMODULE += ng_udp
USEMODULE += random
USEMODULE += vtimer
endif
ifneq (,$(filter ng_ieee802154,$(USEMODULE)))
ifneq (,$(filter ng_ipv6, $(USEMODULE)))
USEMODULE += ng_sixlowpan

3
sys/Makefile

@ -113,6 +113,9 @@ endif
ifneq (,$(filter ng_pktbuf,$(USEMODULE)))
DIRS += net/crosslayer/ng_pktbuf
endif
ifneq (,$(filter ng_zep,$(USEMODULE)))
DIRS += net/application_layer/ng_zep
endif
ifneq (,$(filter ng_rpl_srh,$(USEMODULE)))
DIRS += net/routing/ng_rpl/srh
endif

241
sys/include/net/ng_zep.h

@ -0,0 +1,241 @@
/*
* Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
*
* This file is subject to the terms and conditions of the GNU Lesser General
* Public License v2.1. See the file LICENSE in the top level directory for
* more details.
*/
/**
* @defgroup net_ng_zep Zigbee Encapsulation Protocol
* @ingroup net
* @brief Transports IEEE 802.15.4 frames over UDP (can be parsed by
* Wireshark)
* @see <a href="https://www.wireshark.org/docs/dfref/z/zep.html">
* ZigBee Encapsulation Protocol in the Wireshark docs
* </a>
* @see <a href="https://code.wireshark.org/review/gitweb?p=wireshark.git;a=blob;f=epan/dissectors/packet-zep.c;h=3422eb7876f973f191da98cc4c02aecbd0dbaaeb;hb=HEAD">
* ZEP packet definition in the Wireshark code base.
* </a>
* @{
*
* @file
* @brief ZEP definitions
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/
#ifndef NG_ZEP_H_
#define NG_ZEP_H_
#include <inttypes.h>
#include "byteorder.h"
#include "kernel_types.h"
#include "net/ng_ipv6/addr.h"
#include "net/ng_nettype.h"
#include "thread.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Maximum possible packet size in byte
*/
#define NG_ZEP_MAX_PKT_LENGTH (116)
/**
* @brief Default stack size to use for the ZEP thread
*/
#ifndef NG_ZEP_STACK_SIZE
#define NG_ZEP_STACK_SIZE (THREAD_STACKSIZE_DEFAULT)
#endif
/**
* @brief Default priority for the ZEP thread
*/
#ifndef NG_ZEP_PRIO
#define NG_ZEP_PRIO (THREAD_PRIORITY_MAIN - 5)
#endif
/**
* @brief Default message queue size to use for the ZEP thread.
*/
#ifndef NG_ZEP_MSG_QUEUE_SIZE
#define NG_ZEP_MSG_QUEUE_SIZE (8U)
#endif
/**
* @brief Default addresses if the CPUID module is not present
* @{
*/
#define NG_ZEP_DEFAULT_ADDR_SHORT (0x98b0)
#define NG_ZEP_DEFAULT_ADDR_LONG (0x4a8a6377552b4249)
/**
* @}
*/
/**
* @brief Channel configuration
* @{
*/
#define NG_ZEP_MIN_CHANNEL (11U)
#define NG_ZEP_MAX_CHANNEL (26U)
#define NG_ZEP_DEFAULT_CHANNEL (17U)
/**
* @}
*/
/**
* @brief Default PAN ID
*
* TODO: Read some global network stack specific configuration value
*/
#define NG_ZEP_DEFAULT_PANID (0x0023)
/**
* @brief Option flags for the ZEP device
* @{
*/
#define NG_ZEP_FLAGS_AUTOACK (0x0001) /**< auto ACKS active */
#define NG_ZEP_FLAGS_SRC_ADDR_LONG (0x0002) /**< send data using long source address */
#define NG_ZEP_FLAGS_DST_ADDR_LONG (0x0004) /**< send data using long destination address */
#define NG_ZEP_FLAGS_USE_SRC_PAN (0x0008) /**< do not compress source PAN ID */
/**
* @}
*/
/**
* @brief Default UDP port for ZEP
*/
#define NG_ZEP_DEFAULT_PORT (17754)
/**
* @brief Type == Data for ZEPv2 header
*/
#define NG_ZEP_V2_TYPE_DATA (1)
/**
* @brief Type == Ack for ZEPv2 header
*/
#define NG_ZEP_V2_TYPE_ACK (2)
/**
* @brief Mask for length field
*/
#define ZEP_LENGTH_MASK (0x7f)
/**
* @brief ZEP header definition
*/
typedef struct __attribute__((packed)) {
char preamble[2]; /**< Preamble code (must be "EX") */
uint8_t version; /**< Protocol Version (must be 1 or 2) */
} ng_zep_hdr_t;
/**
* @brief ZEPv1 header definition
* @extends ng_zep_hdr_t
*/
typedef struct __attribute__((packed)) {
char preamble[2]; /**< preamble code (must be "EX") */
uint8_t version; /**< protocol Version (must be 1) */
uint8_t chan; /**< channel ID */
network_uint16_t dev; /**< device ID */
uint8_t lqi_mode; /**< CRC/LQI Mode */
uint8_t lqi_val; /**< LQI value */
uint8_t resv[7]; /**< reserved field, must always be 0 */
uint8_t length; /**< length of the frame */
} ng_zep_v1_hdr_t;
/**
* @brief ZEPv2 header definition (type == Data)
* @extends ng_zep_hdr_t
*/
typedef struct __attribute__((packed)) {
char preamble[2]; /**< preamble code (must be "EX") */
uint8_t version; /**< protocol Version (must be 2) */
uint8_t type; /**< type (must be 1/Data) */
uint8_t chan; /**< channel ID */
network_uint16_t dev; /**< device ID */
uint8_t lqi_mode; /**< CRC/LQI Mode */
uint8_t lqi_val; /**< LQI value */
network_uint64_t time; /**< NTP timestamp */
network_uint32_t seq; /**< Sequence number */
uint8_t resv[10]; /**< reserved field, must always be 0 */
uint8_t length; /**< length of the frame */
} ng_zep_v2_data_hdr_t;
/**
* @brief ZEPv2 header definition (type == Ack)
* @extends ng_zep_hdr_t
*/
typedef struct __attribute__((packed)) {
char preamble[2]; /**< preamble code (must be "EX") */
uint8_t version; /**< protocol Version (must be 2) */
uint8_t type; /**< type (must be 2/Ack) */
network_uint32_t seq; /**< Sequence number */
} ng_zep_v2_ack_hdr_t;
/**
* @brief ZEP device descriptor.
*
* @extends ng_netdev_t
*/
typedef struct {
ng_netdev_driver_t *driver; /**< pointer to the device's interface */
ng_netdev_event_cb_t event_cb; /**< netdev event callback */
kernel_pid_t mac_pid; /**< the driver's thread's PID */
/**
* @brief @ref ng_zep_t specific members
* @{
*/
le_uint16_t addr; /**< the device's short address */
le_uint64_t eui64; /**< the device's EUI-64 */
le_uint16_t pan; /**< the device's PAN ID */
uint16_t flags; /**< the device's option flags */
uint32_t seq; /**< the current sequence number for frames */
ng_ipv6_addr_t dst; /**< destination IPv6 address */
uint16_t src_port; /**< source UDP port */
uint16_t dst_port; /**< destination UDP port */
ng_nettype_t proto; /**< the target protocol for received packets */
uint8_t chan; /**< the device's channel */
uint8_t version; /**< ZEP version to use (default 2) */
uint8_t lqi_mode; /**< LQI mode for send packets (default 1) */
/**
* @}
*/
} ng_zep_t;
/**
* @brief Initializion of the ZEP thread and device.
*
* @param[in] dev Network device, will be initialized.
* @param[in] src_port Source port to use in UDP datagrams. Also the port
* @ref net_ng_zep registers to in @ref net_ng_netreg.
* @param[in] dst Destination address to use in IPv6 packets.
* @param[in] dst_port Destination port to use in UDP datagrams.
*
* @return PID of the ZEP thread on success.
* @return -EADDRINUSE, if @p src_port is already ready registered to
* @ref net_ng_netreg.
* @return -EEXIST, if ZEP thread was already created.
* @return -EINVAL, if @ref NG_ZEP_PRIO is greater than or equal to
* @ref SCHED_PRIO_LEVELS
* @return -ENODEV, if @p dev is NULL.
* @return -ENOTSUP, if @p dst is NULL or unspecified address (::).
* @return -EOVERFLOW, if there are too many threads running already
*/
kernel_pid_t ng_zep_init(ng_zep_t *dev, uint16_t src_port, ng_ipv6_addr_t *dst,
uint16_t dst_port);
#ifdef __cplusplus
}
#endif
#endif /* NG_ZEP_H_ */
/**
* @}
*/

1
sys/net/application_layer/ng_zep/Makefile

@ -0,0 +1 @@
include $(RIOTBASE)/Makefile.base

1081
sys/net/application_layer/ng_zep/ng_zep.c

File diff suppressed because it is too large Load Diff

3
sys/shell/commands/Makefile

@ -67,6 +67,9 @@ endif
ifneq (,$(filter ng_icmpv6_echo vtimer,$(USEMODULE)))
SRC += sc_icmpv6_echo.c
endif
ifneq (,$(filter ng_zep ng_ipv6_addr,$(USEMODULE)))
SRC += sc_zep.c
endif
# TODO
# Conditional building not possible at the moment due to

98
sys/shell/commands/sc_zep.c

@ -0,0 +1,98 @@
/*
* Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @{
*
* @file
*/
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include "net/ng_ipv6/addr.h"
#include "net/ng_ipv6/netif.h"
#include "net/ng_nomac.h"
#include "net/ng_zep.h"
#include "thread.h"
static ng_zep_t zep;
static char zep_stack[THREAD_STACKSIZE_DEFAULT];
int _zep_init(int argc, char **argv)
{
uint16_t src_port = NG_ZEP_DEFAULT_PORT;
uint16_t dst_port = NG_ZEP_DEFAULT_PORT;
ng_ipv6_addr_t dst_addr;
int res;
if (argc < 2) {
printf("usage: %s dst_addr [src_port [dst_port]]\n", argv[0]);
return 1;
}
if (argc > 2) {
src_port = (uint16_t)atoi(argv[2]);
}
if (argc > 3) {
dst_port = (uint16_t)atoi(argv[3]);
}
ng_ipv6_addr_from_str(&dst_addr, argv[1]);
if ((res = ng_zep_init(&zep, src_port, &dst_addr, dst_port)) < 0) {
switch (res) {
case -EADDRINUSE:
printf("error: Source port %" PRIu16 " already in use\n", src_port);
break;
case -EEXIST:
puts("error: ZEP already intialized");
break;
case -ENOTSUP:
printf("error: dst_addr (%s) invalid\n", argv[1]);
break;
case -EOVERFLOW:
puts("error: too many threads running");
break;
default:
puts("unexpected error");
break;
}
return 1;
}
if ((res = ng_nomac_init(zep_stack, sizeof(zep_stack), THREAD_PRIORITY_MAIN - 3,
"zep_l2", (ng_netdev_t *)&zep)) < 0) {
switch (res) {
case -EOVERFLOW:
puts("error: too many threads running");
break;
default:
puts("unexpected error");
break;
}
return 1;
}
#ifdef MODULE_NG_IPV6_NETIF
ng_ipv6_netif_init_by_dev();
#endif
return 0;
}
/** @} */

11
sys/shell/commands/shell_commands.c

@ -174,6 +174,12 @@ extern int _ipv6_nc_manage(int argc, char **argv);
extern int _ipv6_nc_routers(int argc, char **argv);
#endif
#ifdef MODULE_NG_ZEP
#ifdef MODULE_NG_IPV6_ADDR
extern int _zep_init(int argc, char **argv);
#endif
#endif
const shell_command_t _shell_command_list[] = {
{"reboot", "Reboot the node", _reboot_handler},
#ifdef MODULE_CONFIG
@ -286,6 +292,11 @@ const shell_command_t _shell_command_list[] = {
#ifdef MODULE_NG_IPV6_NC
{"ncache", "manage neighbor cache by hand", _ipv6_nc_manage },
{"routers", "IPv6 default router list", _ipv6_nc_routers },
#endif
#ifdef MODULE_NG_ZEP
#ifdef MODULE_NG_IPV6_ADDR
{"zep_init", "initializes ZEP (Zigbee Encapsulation Protocol)", _zep_init },
#endif
#endif
{NULL, NULL, NULL}
};

Loading…
Cancel
Save