Wiki

Below is the source of this page. To edit this source as well as other pages on the wiki, you must login.
====== ADF7242 Network MAC802154 Linux Driver ======

===== Supported Devices =====

  * [[adi>ADF7242]]

===== Evaluation Boards =====

  * [[adi>EVAL-ADF7242-PMDZ]]
  * [[adi>EVAL-ADF7242DB1Z]]  
===== Description =====

{{page>resources:eval:user-guides:circuits-from-the-lab:adf7242-pmod#product_details&firstseconly}}
====== Source Code ======

===== Status =====

^ Source ^ Mainlined? ^
| [[https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/drivers/net/ieee802154/adf7242.c|git]] | Yes |

===== Files =====

^ Function ^ File ^
| driver  | [[linux.github>xcomm_zynq?drivers/net/ieee802154/adf7242.c | adf7242.c]] |
| include | [[linux.github>xcomm_zynq?include/linux/spi/adf7242.h | adf7242.h]] |

===== Firmware for Automatic IEEE 802.15.4 Operating Modes (AN-1082) =====

  * {{:resources:tools-software:linux-drivers:networking-mac802154:ram_lab_7242_2_0_ieee15dot4_full_r5.zip|}}\\
  * {{:resources:tools-software:linux-drivers:networking-mac802154:ram_lab_7242_2_0_ieee15dot4_full_r6.zip|}}\\



Below you can find a simple command line tool that was used to convert the original firmware HEX file into binary format consumed by the ADF7242 Linux device driver.

  * {{:resources:tools-software:linux-drivers:networking-mac802154:adf7242_do_firmware.zip| Hex2Bin Firmware Tool}}



====== Example platform device initialization ======

{{page>software/linux/docs/platform_and_bus_model#Platform Data&noheader&firstseconly&noeditbtn}}

===== Example Platform / Board file =====

{{page>software/linux/docs/platform_and_bus_model#Declaring SPI slave devices&firstseconly}}

<code C>
#include <linux/spi/adf7242.h>

static const struct adf7242_platform_data adf7242_pdata = {

	.mode = ADF_IEEE802154_AUTO_CSMA_CA | ADF_IEEE802154_HW_AACK,
/*
 * Specifies number of attempts to
 * retransmit unacknowledged
 * frames while in automatic CSMA-CA 
 * Tx mode.
 */
	.max_frame_retries = 4,
/*
 * Specifies number of attempts to
 * repeat CSMA-CA algorithm prior to
 * cancellation of RC_TX command.
 * Valid range is 0 to 5; 
 * 7: CSMA-CA algorithm is off
 */
	.max_cca_retries = 4,
/* 
 * Specifies the maximum back-off
 * exponent used in the CSMA-CA
 * algorithm; valid range is 4 to 8
 * 
 */
	.max_csma_be = 6,
/*
 * Specifies the minimum back-off
 * exponent used in the CSMA-CA
 * algorithm; valid range is 0 to
 * csma_max_be
 */
	.min_csma_be = 1,
};
</code>

<code C>
static struct spi_board_info bfin_spi_board_info[] __initdata = {
#if defined(CONFIG_IEEE802154_ADF7242) || defined(CONFIG_IEEE802154_ADF7242_MODULE)
	{
		.modalias = "adf7242",
		.max_speed_hz = 10000000,     /* max spi clock (SCK) speed in HZ */
		.irq = IRQ_PF6,
		.bus_num = 0,
		.chip_select = 0,	/* GPIO controlled SSEL */
		.controller_data = &adf7242_spi_chip_info, /* Blackfin only */
		.platform_data = &adf7242_pdata,
		.mode = SPI_MODE_0,
	},
#endif
};
</code>

Alternatively, it is possible to declare the SPI devices from a DeviceTree file.
\\ Read the [[linux.github>xcomm_zynq?Documentation/devicetree/bindings/net/ieee802154/adf7242.txt|documentation]] for more details.

Example:
<code>
adf7242@0 {
	compatible = "adi,adf7242";
	reg = <0>;
	spi-max-frequency = <10000000>;
	interrupts = <0x62 IRQ_TYPE_LEVEL_HIGH>;

	adi,hw-aack-mode-enable;
	adi,auto-csma-ca-mode-enable;
};
</code>
====== Adding Linux driver support ======

Configure kernel with "make menuconfig" (alternatively use "make xconfig" or
"make qconfig")

<WRAP round help>
The ADF7242 Driver depends on **CONFIG_SPI** and **CONFIG_IEEE802154**
</WRAP>

<code>
------------------- Linux Kernel Configuration ----------------------

  [*] Networking support  --->
       Networking options  --->
         <*> IEEE Std 802.15.4 Low-Rate Wireless Personal Area Networks support
            <*>   Generic IEEE 802.15.4 Soft Networking Stack (mac802154)

  [*] Device drivers  --->
       [*] Network device support  --->
          --- Network device support
          [*]   Ethernet (10 or 100Mbit)  --->
          <*>   IEEE 802.15.4 drivers  --->
     	      --- IEEE 802.15.4 drivers
               <M>   ADF7242 transceiver driver
</code>

====== Hardware configuration ======

{{page>resources/eval/user-guides/circuits-from-the-lab/adf7242-pmod#interface_connector_signal_description&firstseconly}}
====== Driver testing ======

On this demo network, we will have two different boards communicating with each other using ADF7242 modules: a Raspberry Pi and a ZedBoard.

| {{:resources:tools-software:linux-drivers:networking-mac802154:raspi_adf7242.jpg?400|}} | {{ :resources:tools-software:linux-drivers:networking-mac802154:zedboard_adf7242.jpg?400|}} |
===== Userspace tools for Linux IEEE 802.15.4 stack =====
<WRAP round important>
lowpan-tools are deprecated please use linux-wpan tools available here:
[[http://wpan.cakelab.org|linux-wpan]]
</WRAP>

Example using lowpan-tools\\
<xterm>
iwpan dev wpan0 set pan_id 0x777
iwpan phy phy0 set channel 0 11
iwpan dev wpan0 set ackreq_default 1
ifconfig wpan0 up 
ip link add link wpan0 name lowpan0 type lowpan
ip route add 2001::/64 dev lowpan0
ip addr add  2001::4/128 dev lowpan0
ifconfig lowpan0 up
</xterm> 

===== Configuration of the IEEE 802.15.4 layer =====

We will configure the two devices to use the PAN ID 0x0777, the hardware addresses a0::1 and a0::2, and the short addresses 0x8001 and 0x8002.

Then, we will give them IPv6 addresses and test 6loWPAN communication with standard GNU tools.

==== Configuration for the first node (ZedBoard) ====
 
<xterm>
root:/> HW_ADDR="a0:0:0:0:0:0:0:1"
root:/> DEVICE_ADDR=8001 # hexadecimal
root:/> PAN_ID=777 # hexadecimal
root:/> CHANNEL=11
root:/>
root:/> iz add wpan-phy0
Registered new device ('wpan0') on phy wpan-phy0

root:/> ip link set wpan0 address ${HW_ADDR}
root:/> ifconfig wpan0 up

root:/> iz set wpan0 ${PAN_ID} ${DEVICE_ADDR} ${CHANNEL}
</xterm>

==== Configuration for the second node (Raspberry Pi) ====

We only need to change the first two lines:
<xterm>
root:/> HW_ADDR="a0:0:0:0:0:0:0:2"
root:/> DEVICE_ADDR=8002 # hexadecimal
root:/> PAN_ID=777 # hexadecimal
root:/> CHANNEL=11
root:/>
root:/> iz add wpan-phy0
Registered new device ('wpan0') on phy wpan-phy0

root:/> ip link set wpan0 address ${HW_ADDR}
root:/> ifconfig wpan0 up

root:/> iz set wpan0 ${PAN_ID} ${DEVICE_ADDR} ${CHANNEL}
</xterm>

<WRAP round important>
Some GNU/Linux distributions offered on the Raspberry Pi, like Raspbian, will auto-enable the wpan0 interface as soon as it is created. We can disable this behaviour with the following command:
<xterm>
root:/> ifplugd -S -i wpan0 && ifconfig wpan0 down
</xterm>
</WRAP>

==== Chat application ====

Now that our two devices are correctly configured, we can verify that the two devices can communicate using the "izchat" application:

**ZedBoard:**

<xterm>
root:/> izchat 0x0777 0x8001 0x8002
Hello World!
>Thanks 
</xterm>

**Raspberry Pi:**

<xterm>
root:/> izchat 0x0777 0x8002 0x8001
>Hello World!
Thanks
</xterm>

This is a pretty simple two way communication.
The ASCII strings are encapsulated in IEEE802.15.4 DATA frames.

===== Configuration of the 6loWPAN layer =====

The previous example shows that communication is working, but it is not very useful. By using the 6loWPAN protocol on top (the low-power equivalent of the IPv6 protocol), we can allow standard Linux network applications to communicate over the IEEE 802.15.4 link with standard sockets.

==== Configuration for the first node (ZedBoard) ====

<xterm>
root:/> HW_ADDR="a0:0:0:0:0:0:0:1" # Same as before
root:/> IPV6_ADDR="2001::1/128"
root:/>
root:/> ip link add link wpan0 name lowpan0 type lowpan
root:/> ip link set lowpan0 address ${HW_ADDR}
root:/>
root:/> ip addr add ${IPV6_ADDR} dev lowpan0
root:/> ip route add 2001::/64 dev lowpan0
</xterm>

==== Configuration for the second node (Raspberry Pi) ====

<xterm>
root:/> HW_ADDR="a0:0:0:0:0:0:0:2" # Same as before
root:/> IPV6_ADDR="2001::2/128"
root:/>
root:/> ip link add link wpan0 name lowpan0 type lowpan
root:/> ip link set lowpan0 address ${HW_ADDR}
root:/>
root:/> ip addr add ${IPV6_ADDR} dev lowpan0
root:/> ip route add 2001::/64 dev lowpan0
</xterm>

<WRAP round important>
Some GNU/Linux distributions offered on the Raspberry Pi, like Raspbian, will auto-enable the lowpan0 interface as soon as it is created. We can disable this behaviour with the following command:
<xterm>
root:/> ifplugd -S -i lowpan0 && ifconfig lowpan0 down
</xterm>
</WRAP>

===== Testing the communication =====

==== Ping! ====

From the Raspberry Pi, we can now ping the ZedBoard at the address **fe80::a200:0:0:1%lowpan0**:
<xterm>
root@analog:~# ping6 -i0.1 2001::3
PING 2001::3(2001::3) 56 data bytes
64 bytes from 2001::3: icmp_seq=1 ttl=64 time=44.8 ms
64 bytes from 2001::3: icmp_seq=2 ttl=64 time=39.9 ms
64 bytes from 2001::3: icmp_seq=3 ttl=64 time=44.0 ms
64 bytes from 2001::3: icmp_seq=4 ttl=64 time=36.5 ms
64 bytes from 2001::3: icmp_seq=5 ttl=64 time=45.6 ms
64 bytes from 2001::3: icmp_seq=6 ttl=64 time=49.1 ms
64 bytes from 2001::3: icmp_seq=7 ttl=64 time=42.1 ms
64 bytes from 2001::3: icmp_seq=8 ttl=64 time=34.2 ms
64 bytes from 2001::3: icmp_seq=9 ttl=64 time=35.0 ms
64 bytes from 2001::3: icmp_seq=10 ttl=64 time=33.1 ms
64 bytes from 2001::3: icmp_seq=11 ttl=64 time=46.6 ms
64 bytes from 2001::3: icmp_seq=12 ttl=64 time=28.8 ms
64 bytes from 2001::3: icmp_seq=13 ttl=64 time=43.0 ms
64 bytes from 2001::3: icmp_seq=14 ttl=64 time=38.6 ms
64 bytes from 2001::3: icmp_seq=15 ttl=64 time=41.1 ms
64 bytes from 2001::3: icmp_seq=16 ttl=64 time=40.3 ms
64 bytes from 2001::3: icmp_seq=17 ttl=64 time=45.6 ms
64 bytes from 2001::3: icmp_seq=18 ttl=64 time=53.3 ms
64 bytes from 2001::3: icmp_seq=19 ttl=64 time=51.6 ms
64 bytes from 2001::3: icmp_seq=20 ttl=64 time=26.6 ms
64 bytes from 2001::3: icmp_seq=21 ttl=64 time=42.3 ms
64 bytes from 2001::3: icmp_seq=22 ttl=64 time=32.7 ms
64 bytes from 2001::3: icmp_seq=23 ttl=64 time=50.0 ms
^C
--- 2001::3 ping statistics ---
23 packets transmitted, 23 received, 0% packet loss, time 2210ms
rtt min/avg/max/mdev = 26.622/41.122/53.348/6.945 ms
root@analog:~# 
</xterm>

We can as well ping the Raspberry Pi from the Zedboard using the address **fe80::a200:0:0:2%lowpan0**.

==== Standard tools ====

The following is just to demonstrate that any Linux program can, using standard sockets, communicate over the IEEE 802.15.4 link with 6loWPAN:

<xterm>
root@raspberrypi:/> ssh -6 analog@fe80::a200:0:0:1%lowpan0
analog@fe80::a200:0:0:1%lowpan0's password: 
Welcome to Linaro 14.04 (GNU/Linux 3.18.0-33199-g62cfd65-dirty armv7l)

Last login: Thu Jan  1 00:02:21 1970 from fe80::a200:0:0:2%lowpan0

root@analog:/>
</xterm>
Analog Devices Wiki

Page Tools
