1<!-- 2Author: Xianjun jiao, Michael Mehari, Wei Liu 3SPDX-FileCopyrightText: 2019 UGent 4SPDX-License-Identifier: AGPL-3.0-or-later 5--> 6 7# openwifi 8<img src="./openwifi-arch.jpg" width="900"> 9 10**openwifi:** Linux mac80211 compatible full-stack IEEE802.11/Wi-Fi design based on SDR (Software Defined Radio). 11 12This repository includes Linux driver and software. [openwifi-hw](https://github.com/open-sdr/openwifi-hw) repository has the FPGA design. 13 14[[Project document](doc)], [[Quick start](#Quick-start)], [[Application notes](doc/app_notes)] 15 16[[Videos](#Videos)] [[Papers](#Papers)] [openwifi [maillist](https://lists.ugent.be/wws/subscribe/openwifi)] [[Cite openwifi project](#Cite-openwifi-project)] 17 18Openwifi code has dual licenses. AGPLv3 is the opensource license. For non-opensource license, please contact [email protected]. Openwifi project also leverages some 3rd party modules. It is user's duty to check and follow licenses of those modules according to the purpose/usage. You can find [an example explanation from Analog Devices](https://github.com/analogdevicesinc/hdl/blob/master/LICENSE) for this compound license conditions. [[How to contribute]](https://github.com/open-sdr/openwifi/blob/master/CONTRIBUTING.md). 19 20**Features:** 21 22- 802.11a/g/n [[IEEE 802.11n (Wi-Fi 4)](doc/app_notes/ieee80211n.md)] 23- 20MHz bandwidth; 70 MHz to 6 GHz frequency range 24- Mode tested: Ad-hoc; Station; AP, Monitor 25- DCF (CSMA/CA) low MAC layer in FPGA (10us SIFS is achieved) 26- [802.11 packet injection](doc/app_notes/inject_80211.md) 27- CSI (Channel State Information, freq offset, equalizer to computer) [[CSI notes](doc/app_notes/csi.md)] 28- IQ capture (real-time AGC, RSSI, IQ sample to computer) [[IQ notes](doc/app_notes/iq.md)][[IQ notes for dual antenna](doc/app_notes/iq_2ant.md)] 29- Configurable channel access priority parameters: 30 - duration of RTS/CTS, CTS-to-self 31 - SIFS/DIFS/xIFS/slot-time/CW/etc 32- Time slicing based on MAC address (time gated/scheduled FPGA queues) 33- Easy to change bandwidth and frequency: 34 - 2MHz for 802.11ah in sub-GHz 35 - 10MHz for 802.11p/vehicle in 5.9GHz 36- On roadmap: **802.11ax** 37 38**Performance (AP: openwifi at channel 44, client: TL-WDN4200 N900 USB Dongle):** 39- AP --> client: 30.6Mbps(TCP), 38.8Mbps(UDP) 40- client --> AP: 17.0Mbps(TCP), 21.5Mbps(UDP) 41 42**Supported SDR platforms:** (Check [Porting guide](#Porting-guide) for your new board if it isn't in the list) 43 44board_name|board combination|status|SD card img 45-------|-------|----|---- 46zc706_fmcs2|Xilinx ZC706 dev board + FMCOMMS2/3/4|Done|[32bit img](https://users.ugent.be/~xjiao/openwifi-1.2.0-leuven-32bit.img.xz) 47zed_fmcs2|Xilinx zed board + FMCOMMS2/3/4|Done|[32bit img](https://users.ugent.be/~xjiao/openwifi-1.2.0-leuven-32bit.img.xz) 48adrv9364z7020|ADRV9364-Z7020 + ADRV1CRR-BOB|Done|[32bit img](https://users.ugent.be/~xjiao/openwifi-1.2.0-leuven-32bit.img.xz) 49adrv9361z7035|ADRV9361-Z7035 + ADRV1CRR-BOB/FMC|Done|[32bit img](https://users.ugent.be/~xjiao/openwifi-1.2.0-leuven-32bit.img.xz) 50zc702_fmcs2|Xilinx ZC702 dev board + FMCOMMS2/3/4|Done|[32bit img](https://users.ugent.be/~xjiao/openwifi-1.2.0-leuven-32bit.img.xz) 51zcu102_fmcs2|Xilinx ZCU102 dev board + FMCOMMS2/3/4|Done|[64bit img](https://users.ugent.be/~xjiao/openwifi-1.2.0-leuven-64bit.img.xz) 52zcu102_9371|Xilinx ZCU102 dev board + ADRV9371|Future|Future 53 54- board_name is used to identify FPGA design in openwifi-hw/boards/ 55- Don't have any boards? Or you like JTAG boot instead of SD card? Check our test bed [w-iLab.t](https://doc.ilabt.imec.be/ilabt/wilab/tutorials/openwifi.html) tutorial. 56 57[[Quick start](#Quick-start)] 58[[Basic operations](#Basic-operations)] 59[[Update FPGA](#Update-FPGA)] 60[[Update Driver](#Update-Driver)] 61[[Update sdrctl](#Update-sdrctl)] 62[[Easy Access and etc](#Easy-Access-and-etc)] 63 64[[Build openwifi Linux img from scratch](#Build-openwifi-Linux-img-from-scratch)] 65[[Special note for 11b](#Special-note-for-11b)] 66[[Porting guide](#Porting-guide)] 67 68[[Project document](doc)] 69[[Application notes](doc/app_notes)] 70 71## Quick start 72- Burn openwifi board specific img file (from the table) into a SD card ("Open With Disk Image Writer". Or "dd" command after unzip). The SD card has two partitions: BOOT and rootfs. You need to config the **correct files in the BOOT partition** according to the **board you have** by operation on your computer: 73 - Copy files in **openwifi/board_name** to the base directory of BOOT partiton. 74 - Copy **openwifi/zynqmp-common/Image** (zcu102 board) or **openwifi/zynq-common/uImage** (other boards) to the base directory of BOOT partiton 75- Connect two antennas to RXA/TXA ports. Config the board to SD card boot mode (check the board manual). Insert the SD card to the board. Power on. 76- Login to the board from your PC (PC Ethernet should have IP 192.168.10.1) with password **openwifi**. 77 ``` 78 ssh [email protected] 79 ``` 80- On board, run openwifi AP and the on board webserver 81 ``` 82 ~/openwifi/fosdem.sh 83 ``` 84- After you see the "openwifi" SSID on your device (Phone/Laptop/etc), connect it. Browser to 192.168.13.1 on your deivce, you should see the webpage hosted by the webserver on board. 85 - Note 1: If your device doesn't support 5GHz (ch44), please change the **hostapd-openwifi.conf** on board and re-run fosdem.sh. 86 - Note 2: After ~2 hours, the Viterbi decoder will halt (Xilinx Evaluation License). Just power cycle the board if it happens. (If output of "./sdrctl dev sdr0 get reg rx 20" is always the same, it means the decoder halts) 87- To give the Wi-Fii client internet access, configure routing/NAT **on the PC**: 88 ``` 89 sudo sysctl -w net.ipv4.ip_forward=1 90 sudo iptables -t nat -A POSTROUTING -o ethY -j MASQUERADE 91 sudo ip route add 192.168.13.0/24 via 192.168.10.122 dev ethX 92 ``` 93 **ethX** is the PC NIC name connecting the board. **ethY** is the PC NIC name connecting internet. 94 95 If you want, uncommenting "net.ipv4.ip_forward=1" in /etc/sysctl.conf to make IP forwarding persistent on PC. 96- To monitor **real-time CSI (Chip State Information)**, such as timestamp, frequency offset, channel state, equalizer, please refer to [[CSI notes](doc/app_notes/csi.md)]. 97 98## Basic operations 99The board actually is an Linux/Ubuntu computer which is running **hostapd** to offer Wi-Fi AP functionality over the Wi-Fi Network Interface (NIC). The NIC is implemented by openwifi-hw FPGA design. We use the term **"On board"** to indicate that the commands should be executed after ssh login to the board. **"On PC"** means the commands should run on PC. 100- Bring up the openwifi NIC sdr0: 101 ``` 102 service network-manager stop 103 cd ~/openwifi && ./wgd.sh 104 ``` 105- Use openwifi as client to connect other AP (Change wpa-connect.conf on board firstly): 106 ``` 107 route del default gw 192.168.10.1 108 wpa_supplicant -i sdr0 -c wpa-connect.conf & 109 dhclient sdr0 110 ``` 111- Use openwifi in ad-hoc mode: Please check **sdr-ad-hoc-up.sh** and **sdr-ad-hoc-join.sh**. 112- Use openwifi in monitor mode: Please check **monitor_ch.sh**. 113- The Linux native Wi-Fi tools/Apps (iwconfig/ifconfig/iwlist/iw/hostapd/wpa_supplicant/etc) can run over openwifi NIC in the same way as commercial Wi-Fi chip. 114- **sdrctl** is a dedicated tool to access openwifi driver/FPGA, please check doc directory for more information. 115 116## Update FPGA 117 118Since the pre-built SD card image might not have the latest bug-fixes/updates, it is recommended to udpate the fpga bitstream on board. 119 120- Install Vivado/SDK 2018.3 (If you don't need to generate new FPGA bitstream, WebPack version without license is enough) 121- Setup environment variables (use absolute path): 122 ``` 123 export XILINX_DIR=your_Xilinx_directory 124 export OPENWIFI_DIR=your_openwifi_directory 125 export BOARD_NAME=your_board_name 126 ``` 127- Get the latest FPGA bitstream from openwifi-hw, generate BOOT.BIN and transfer it on board via ssh channel: 128 ``` 129 $OPENWIFI_DIR/user_space/get_fpga.sh $OPENWIFI_DIR 130 131 For Zynq 7000: 132 $OPENWIFI_DIR/user_space/boot_bin_gen.sh $OPENWIFI_DIR $XILINX_DIR $BOARD_NAME 133 134 For Zynq MPSoC (like zcu102 board): 135 $OPENWIFI_DIR/user_space/boot_bin_gen_zynqmp.sh $OPENWIFI_DIR $XILINX_DIR $BOARD_NAME 136 137 scp $OPENWIFI_DIR/kernel_boot/boards/$BOARD_NAME/output_boot_bin/BOOT.BIN [email protected]: 138 ``` 139- On board: Put the BOOT.BIN into the BOOT partition. 140 ``` 141 mount /dev/mmcblk0p1 /mnt 142 cp ~/BOOT.BIN /mnt 143 umount /mnt 144 ``` 145 **Power cycle** the board to load new FPGA bitstream. 146 147## Update Driver 148 149Since the pre-built SD card image might not have the latest bug-fixes/updates, it is recommended to udpate the driver on board. 150- Prepare Analog Devices Linux kernel source code (only need to run once): 151 ``` 152 $OPENWIFI_DIR/user_space/prepare_kernel.sh $OPENWIFI_DIR $XILINX_DIR ARCH_BIT 153 (For Zynq 7000, ARCH_BIT should be 32, for Zynq MPSoC, ARCH_BIT should be 64) 154 ``` 155- Compile the latest openwifi driver 156 ``` 157 $OPENWIFI_DIR/driver/make_all.sh $OPENWIFI_DIR $XILINX_DIR ARCH_BIT 158 (For Zynq 7000, ARCH_BIT should be 32, for Zynq MPSoC, ARCH_BIT should be 64) 159 ``` 160- Copy the driver files to the board via ssh channel 161 ``` 162 scp `find $OPENWIFI_DIR/driver/ -name \*.ko` [email protected]:openwifi/ 163 ``` 164 Now you can use **wgd.sh** on board to load the new openwifi driver. 165 166## Update sdrctl 167- Copy the sdrctl source files to the board via ssh channel 168 ``` 169 scp `find $OPENWIFI_DIR/user_space/sdrctl_src/ -name \*` [email protected]:openwifi/sdrctl_src/ 170 ``` 171- Compile the sdrctl **on board**: 172 ``` 173 cd ~/openwifi/sdrctl_src/ && make && cp sdrctl ../ && cd .. 174 ``` 175## Easy Access and etc 176 177- FPGA and driver on board update scripts 178 - Setup [ftp server](https://help.ubuntu.com/lts/serverguide/ftp-server.html) on PC, allow anonymous and change ftp root directory to $OPENWIFI_DIR. 179 - On board: 180 ``` 181 ./sdcard_boot_update.sh $BOARD_NAME 182 (Above command downloads uImage, BOOT.BIN and devicetree.dtb, then copy them into boot partition. Remember to power cycle) 183 ./wgd.sh remote 184 (Above command downloads driver files, and brings up sdr0) 185 ``` 186- Access the board disk/rootfs like a disk: 187 - On PC: "File manager --> Connect to Server...", input: sftp://[email protected]/root 188 - Input password "openwifi" 189 190## Build openwifi Linux img from scratch 191- Download [2019_R1-2020_02_04.img.xz](https://swdownloads.analog.com/cse/2019_R1-2020_02_04.img.xz) from [Analog Devices Wiki](https://wiki.analog.com/resources/tools-software/linux-software/zynq_images). Burn it to a SD card. 192- Insert the SD card to your Linux PC. Find out the mount point (that has two sub directories BOOT and rootfs), and setup environment variables (use absolute path): 193 ``` 194 export SDCARD_DIR=sdcard_mount_point 195 export XILINX_DIR=your_Xilinx_directory 196 export OPENWIFI_DIR=your_openwifi_directory 197 export BOARD_NAME=your_board_name 198 ``` 199- Run script to update SD card: 200 ``` 201 $OPENWIFI_DIR/user_space/update_sdcard.sh $OPENWIFI_DIR $XILINX_DIR $BOARD_NAME $SDCARD_DIR 202 ``` 203- Config your board to SD card boot mode (check the board manual). Insert the SD card to the board. Power on. 204- Login to the board from your PC (PC Ethernet should have IP 192.168.10.1) with one time password **analog**. 205 ``` 206 ssh [email protected] 207 ``` 208- Setup routing/NAT **on the PC** for your board -- this internet connection is **important** for post installation/config. 209 ``` 210 sudo sysctl -w net.ipv4.ip_forward=1 211 sudo iptables -t nat -A POSTROUTING -o ethY -j MASQUERADE 212 sudo ip route add 192.168.13.0/24 via 192.168.10.122 dev ethX 213 ``` 214 **ethX** is the PC NIC name connecting the board. **ethY** is the PC NIC name connecting internet. 215 216 If you want, uncommenting "net.ipv4.ip_forward=1" in /etc/sysctl.conf to make IP forwarding persistent on PC. 217- Run **one time** script on board to complete post installation/config (After this, password becomes **openwifi**) 218 ``` 219 cd ~/openwifi && ./post_config.sh 220 ``` 221- Now you can start from [Quick start](#Quick-start) (Skip the image download and burn step) 222 223## Special note for 11b 224 225Openwifi only applies OFDM as its modulation scheme and as a result, it is not backward compatible with 802.11b clients or modes of operation. This is usually the case during beacon transmission, connection establishment, and robust communication. 226 227As a solution to this problem, openwifi can be fully controlled only if communicating with APs/clients instantiated using hostapd/wpa_supplicant userspace programs respectively. 228 229For hostapd program, 802.11b rates can be suppressed using configuration commands (i.e. supported_rates, basic_rates) and an example configuration file is provided (i.e. hostapd-openwifi.conf). One small caveat to this one comes from fullMAC Wi-Fi cards as they must implement the *NL80211_TXRATE_LEGACY* NetLink handler at the device driver level. 230 231On the other hand, the wpa_supplicant program on the client side (commercial Wi-Fi dongle/board) cannot suppress 802.11b rates out of the box in 2.4GHz band, so there will be an issue when connecting openwifi (OFDM only). A patched wpa_supplicant should be used at the client side. 232``` 233sudo apt-get install libssl1.0-dev 234$OPENWIFI_DIR/user_space/build_wpa_supplicant_wo11b.sh $OPENWIFI_DIR 235``` 236## Porting guide 237 238This section explains the porting work by showing the differences between openwifi and Analog Devices reference design. openwifi is based on 2019_R1 of [HDL Reference Designs](https://github.com/analogdevicesinc/hdl). 239- Open the fmcomms2 + zc706 reference design at hdl/projects/fmcomms2/zc706 (Please read Analog Devices help) 240- Open the openwifi design zc706_fmcs2 at openwifi-hw/boards/zc706_fmcs2 (Please read openwifi-hw repository) 241- "Open Block Design", you will see the differences between openwifi and the reference design. Both in "diagram" and in "Address Editor". 242- The address/interrupts of FPGA blocks hooked to the ARM bus should be put/aligned to the devicetree file openwifi/kernel_boot/boards/zc706_fmcs2/devicetree.dts. Linux will parse the devicetree.dtb when booting to know information of attached deivce (FPGA blocks in our case). 243- We use dtc command to get devicetree.dts converted from devicetree.dtb in [Analog Devices Linux image](https://wiki.analog.com/resources/tools-software/linux-software/zynq_images), then do modification according to what we have added/modified to the reference design. 244- Please learn the script in [[Build openwifi Linux img from scratch](#Build-openwifi-Linux-img-from-scratch)] to understand how we generate devicetree.dtb, BOOT.BIN and Linux kernel uImage and put them together to build the full SD card image. 245 246## Videos 247 248Demo [[youtube](https://youtu.be/NpjEaszd5u4)], [[link for CHN user](https://www.zhihu.com/zvideo/1280659393378041856)] 249 250FOSDEM2020 [[youtube](https://youtu.be/Mq48cGthk7M)], [[link for CHN user](https://www.zhihu.com/zvideo/1280673506397425664)] 251 252Low latency for gaming and introduction [[youtube](https://youtu.be/Notn9X482LI)], [[link for CHN user](https://www.zhihu.com/zvideo/1273823153371385856)] 253 254CSI (Channel State Information) [[twitter](https://twitter.com/i/status/1314207380561780738)], [[link for CHN user](https://www.zhihu.com/zvideo/1297662571618148352)] 255 256## Papers 257 258- [openwifi: a free and open-source IEEE802.11 SDR implementation on SoC](https://www.orca-project.eu/wp-content/uploads/sites/4/2020/03/openwifi-vtc-antwerp-PID1249076.pdf) 259- [csi murder](https://ans.unibs.it/projects/csi-murder/) 260 261Openwifi was born in [ORCA project](https://www.orca-project.eu/) (EU's Horizon2020 programme under agreement number 732174). 262 263## Cite openwifi project 264 265Any use of openwifi project which results in a publication should include a citation via (bibtex example): 266``` 267@electronic{openwifigithub, 268 author = {Xianjun, Jiao and Wei, Liu and Michael, Mehari}, 269 title = {open-source IEEE802.11/Wi-Fi baseband chip/FPGA design}, 270 url = {https://github.com/open-sdr/openwifi}, 271 year = {2019}, 272} 273``` 274 275## License 276 277This project is available as open source under the terms of the AGPL 3.0 Or later. However, some elements are being licensed under GPL 2-0 or later and BSD 3 license . For accurate information, please check individual files. 278
