IEEE 802.15.4 Developer's Guide

소개와 스택 구성

IEEE 802.15.4 작업 그룹은 하위 두 계층인 MAC과 PHY 표준화에 집중합니다. 상위 계층의 대표 선택지는 ZigBee Alliance의 독점 프로토콜 ZigBee와 저속 개인 영역망에서 IPv6를 제공하는 6LoWPAN입니다.

Linux-wpan의 목표는 저속 무선 개인 영역망을 구성하는 IEEE 802.15.4와 6LoWPAN 프로토콜을 완전히 구현하는 것입니다. 스택은 Berkeley socket API와 일반 Linux 네트워킹 스택으로 데이터를 전달하고 전용 netlink 프로토콜로 설정을 관리하는 IEEE 802.15.4 계층, 공유 채널 접근과 신뢰성 있는 전달을 맡는 MAC, 장치 드라이버를 나타내는 PHY로 구성됩니다.

===============================
IEEE 802.15.4 Developer's Guide
===============================

Introduction
============
The IEEE 802.15.4 working group focuses on standardization of the bottom
two layers: Medium Access Control (MAC) and Physical access (PHY). And there
are mainly two options available for upper layers:

- ZigBee - proprietary protocol from the ZigBee Alliance
- 6LoWPAN - IPv6 networking over low rate personal area networks

The goal of the Linux-wpan is to provide a complete implementation
of the IEEE 802.15.4 and 6LoWPAN protocols. IEEE 802.15.4 is a stack
of protocols for organizing Low-Rate Wireless Personal Area Networks.

The stack is composed of three main parts:

- IEEE 802.15.4 layer;  We have chosen to use plain Berkeley socket API,
  the generic Linux networking stack to transfer IEEE 802.15.4 data
  messages and a special protocol over netlink for configuration/management
- MAC - provides access to shared channel and reliable data delivery
- PHY - represents device drivers

소켓 API

데이터그램 소켓은 `socket(PF_IEEE802154, SOCK_DGRAM, 0)`으로 만듭니다. 주소군과 소켓 주소 정의는 `include/net/af_ieee802154.h` 또는 wpan-tools 사용자 공간 패키지의 전용 헤더에서 찾을 수 있습니다.

Socket API
==========

::

    int sd = socket(PF_IEEE802154, SOCK_DGRAM, 0);

The address family, socket addresses etc. are defined in the
include/net/af_ieee802154.h header or in the special header
in the userspace package (see either https://linux-wpan.org/wpan-tools.html
or the git tree at https://github.com/linux-wpan/wpan-tools).

Linux 6LoWPAN 구현

IEEE 802.15.4 MTU는 127바이트이며 보안을 켜면 실제 MAC payload는 약 80 octet, 링크 처리량은 250kbps 이하입니다. RFC 4944의 6LoWPAN 적응 형식은 이런 대역폭, 메모리, 에너지 제약을 고려해 IPv6 datagram을 전달합니다. Mesh Addressing header는 sub-IP forwarding, Fragmentation header는 IPv6 최소 MTU, LOWPAN_HC1/HC2는 큰 IPv6/UDP header를 최선의 경우 몇 바이트로 줄이는 stateless 압축을 제공합니다.

2011년 RFC 6282는 HC1과 HC2를 폐기하고 Linux 구현이 사용하는 IPHC 인코딩을 정의했습니다. 관련 코드는 `net/6lowpan/*`와 `net/ieee802154/6lowpan/*`에 있습니다.

6LoWPAN 인터페이스를 만들려면 IEEE 802.15.4 인터페이스를 추가하고 channel과 PAN ID를 설정한 뒤 `ip link add link wpan0 name lowpan0 type lowpan`으로 `lowpan0`를 만들고 인터페이스를 올립니다.

6LoWPAN Linux implementation
============================

The IEEE 802.15.4 standard specifies an MTU of 127 bytes, yielding about 80
octets of actual MAC payload once security is turned on, on a wireless link
with a link throughput of 250 kbps or less.  The 6LoWPAN adaptation format
[RFC4944] was specified to carry IPv6 datagrams over such constrained links,
taking into account limited bandwidth, memory, or energy resources that are
expected in applications such as wireless Sensor Networks.  [RFC4944] defines
a Mesh Addressing header to support sub-IP forwarding, a Fragmentation header
to support the IPv6 minimum MTU requirement [RFC2460], and stateless header
compression for IPv6 datagrams (LOWPAN_HC1 and LOWPAN_HC2) to reduce the
relatively large IPv6 and UDP headers down to (in the best case) several bytes.

In September 2011 the standard update was published - [RFC6282].
It deprecates HC1 and HC2 compression and defines IPHC encoding format which is
used in this Linux implementation.

All the code related to 6lowpan you may find in files: net/6lowpan/*
and net/ieee802154/6lowpan/*

To setup a 6LoWPAN interface you need:
1. Add IEEE802.15.4 interface and set channel and PAN ID;
2. Add 6lowpan interface by command like:
# ip link add link wpan0 name lowpan0 type lowpan
3. Bring up 'lowpan0' interface

드라이버 유형

Wi-Fi와 마찬가지로 IEEE 802.15.4 장치도 구현 위치에 따라 나뉩니다. HardMAC 장치는 MAC 계층을 장치 안에 구현하고 MLME 같은 관리 API와 데이터 API를 노출합니다. SoftMAC 또는 단순 radio 장치는 송수신기를 제공하며 자동 CRC 계산과 비교, ACK 처리, 주소 일치 같은 일부 가속만 포함할 수 있습니다. 두 유형은 Linux 커널에 연결하는 방식이 다릅니다.

Drivers
=======

Like with WiFi, there are several types of devices implementing IEEE 802.15.4.
1) 'HardMAC'. The MAC layer is implemented in the device itself, the device
exports a management (e.g. MLME) and data API.
2) 'SoftMAC' or just radio. These types of devices are just radio transceivers
possibly with some kinds of acceleration like automatic CRC computation and
comparison, automagic ACK handling, address matching, etc.

Each type of device requires a different approach to be hooked into the Linux
kernel.

HardMAC

HardMAC 드라이버는 `include/net/ieee802154_netdev.h`를 참고해 `.type = ARPHRD_IEEE802154`인 Linux `net_device`를 구현합니다. 소켓 주소군 코드와 데이터는 일반 `sk_buff`로 교환합니다. 수신 시 `skb->cb`에는 `struct ieee802154_mac_cb`의 부가 정보가 있어야 하고, 송신 시 이 영역은 `header_ops->create`에 부가 정보를 전달합니다.

소켓 코드가 `skb`를 qdisc에 넘길 때 `skb->cb`를 덮어쓸 수 있으므로 나중에도 필요한 값은 드라이버가 `skb->data`에 직접 저장해야 합니다. MLME를 연결하려면 `net_device.ml_priv`에 `struct ieee802154_mlme_ops` 포인터를 넣습니다. `assoc_req`, `assoc_resp`, `disassoc_req`, `start_req`, `scan_req`는 선택 사항이고 나머지 필드는 필수입니다.

HardMAC
-------

See the header include/net/ieee802154_netdev.h. You have to implement Linux
net_device, with .type = ARPHRD_IEEE802154. Data is exchanged with socket family
code via plain sk_buffs. On skb reception skb->cb must contain additional
info as described in the struct ieee802154_mac_cb. During packet transmission
the skb->cb is used to provide additional data to the device's
header_ops->create function. Be aware that this data can be overridden later
(when socket code submits skb to qdisc), so if you need something from that cb
later, you should store info in the skb->data on your own.

To hook the MLME interface you have to populate the ml_priv field of your
net_device with a pointer to struct ieee802154_mlme_ops instance. The fields
assoc_req, assoc_resp, disassoc_req, start_req, and scan_req are optional.
All other fields are required.

SoftMAC

MAC은 Linux IEEE 802.15.4 스택의 중간 계층으로 드라이버 등록과 slave 인터페이스 관리를 제공합니다. 이 문서 시점에는 Wireshark 같은 sniffer용 IEEE 802.15.4 monitor 장치 유형만 지원하며 계층은 확장 예정이라고 설명합니다. 인터페이스는 `include/net/mac802154.h`, 예제 드라이버는 `drivers/net/ieee802154/`에 있습니다.

SoftMAC
-------

The MAC is the middle layer in the IEEE 802.15.4 Linux stack. At the moment, it
provides an interface for driver registration and management of slave
interfaces.

NOTE: Currently the only monitor device type is supported - it's IEEE 802.15.4
stack interface for network sniffers (e.g. WireShark).

This layer is going to be extended soon.

See header include/net/mac802154.h and several drivers in
drivers/net/ieee802154/.

가상 드라이버

`fakelb`는 실제 SoftMAC 장치를 흉내 내는 IEEE 802.15.4 loopback 드라이버입니다. 실제 무선 하드웨어 없이 스택을 시험하고 디버깅할 수 있습니다.

Fake drivers
------------

In addition there is a driver available which simulates a real device with
SoftMAC (fakelb - IEEE 802.15.4 loopback driver) interface. This option
provides a possibility to test and debug the stack without usage of real hardware.

장치 할당과 등록 API

`ieee802154_alloc_device(priv_size, ops)`는 IEEE 802.15.4 호환 장치와 드라이버 전용 공간을 할당하고, `ieee802154_free_device(dev)`는 할당한 장치를 해제합니다. `ieee802154_register_device(dev)`는 PHY를 시스템에 등록하며 `ieee802154_unregister_device(dev)`는 등록된 PHY를 제거합니다.

`ieee802154_rx_irqsafe(hw, skb, lqi)`는 하드웨어의 RF Link Quality Indicator와 함께 새 수신 frame이 `skb`에 있음을 스택에 알립니다. `ieee802154_xmit_complete(hw, skb, ifs_handling)`는 해당 frame이 하드웨어를 통해 전송되었거나 곧 전송될 것임을 알립니다.

Device drivers API
==================

The include/net/mac802154.h defines following functions:

.. c:function:: struct ieee802154_dev *ieee802154_alloc_device (size_t priv_size, struct ieee802154_ops *ops)

Allocation of IEEE 802.15.4 compatible device.

.. c:function:: void ieee802154_free_device(struct ieee802154_dev *dev)

Freeing allocated device.

.. c:function:: int ieee802154_register_device(struct ieee802154_dev *dev)

Register PHY in the system.

.. c:function:: void ieee802154_unregister_device(struct ieee802154_dev *dev)

Freeing registered PHY.

.. c:function:: void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb, u8 lqi)

Telling 802.15.4 module there is a new received frame in the skb with
the RF Link Quality Indicator (LQI) from the hardware device.

.. c:function:: void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb, bool ifs_handling)

Telling 802.15.4 module the frame in the skb is or going to be
transmitted through the hardware device

필수 장치 연산

드라이버는 `struct ieee802154_ops`에서 최소한 `start`, `stop`, `xmit_async`, `ed`, `set_channel` callback을 구현해야 합니다. `start(hw)`는 하드웨어 초기화, `stop(hw)`은 정리를 위해 802.15.4 모듈이 호출합니다.

`xmit_async(hw, skb)`는 전송할 각 frame마다 호출되고, `ed(hw, level)`는 하드웨어 Energy Detection 값을 요청합니다. `set_channel(hw, page, channel)`은 radio가 지정한 channel을 수신하도록 설정합니다. 이 밖에도 장치가 지원하는 IEEE 802.15.4 연산 구조체 필드를 채워야 합니다.

The device driver must implement the following callbacks in the IEEE 802.15.4
operations structure at least::

   struct ieee802154_ops {
        ...
        int     (*start)(struct ieee802154_hw *hw);
        void    (*stop)(struct ieee802154_hw *hw);
        ...
        int     (*xmit_async)(struct ieee802154_hw *hw, struct sk_buff *skb);
        int     (*ed)(struct ieee802154_hw *hw, u8 *level);
        int     (*set_channel)(struct ieee802154_hw *hw, u8 page, u8 channel);
        ...
   };

.. c:function:: int start(struct ieee802154_hw *hw)

Handler that 802.15.4 module calls for the hardware device initialization.

.. c:function:: void stop(struct ieee802154_hw *hw)

Handler that 802.15.4 module calls for the hardware device cleanup.

.. c:function:: int xmit_async(struct ieee802154_hw *hw, struct sk_buff *skb)

Handler that 802.15.4 module calls for each frame in the skb going to be
transmitted through the hardware device.

.. c:function:: int ed(struct ieee802154_hw *hw, u8 *level)

Handler that 802.15.4 module calls for Energy Detection from the hardware
device.

.. c:function:: int set_channel(struct ieee802154_hw *hw, u8 page, u8 channel)

Set radio for listening on specific channel of the hardware device.

Moreover IEEE 802.15.4 device operations structure should be filled.