NRC7292 Software Package v1.3.0 release

Author: newracom

README.md

@@ -0,0 +1,117 @@
+# NRC7292 Software Package
+
+## Notice
+### Release roadmap
+- v1.3.0 (2020.05.30)
+
+### Latest release
+- [NRC7292_SW_PKG_v1.3.0](https://github.com/newracom/nrc7292_sw_pkg_draft/releases/tag/v1.3.0)
+
+### Release package contents
+- host
+  - cli_app
+  - evk
+  - nrc_driver
+
+## NRC7292 Software Package User Guide
+### (Optional) Install toolchain
+To build host driver, GNU ARM embedded toolchain is needed.
+Please follow commands to install toolchain by using toolchain in this repository.
+```
+tar -xf gcc-arm-none-eabi-7-2018-q2-update-linux.tar.bz2
+vi ~/.bashrc
+  export PATH="~/gcc-arm-none-eabi-7-2018-q2-update/bin:$PATH"
+```
+### Get NRC7292 Software Package
+NRC7292 Software package is provided in this repository. Please refer to the following git command to get it.
+```
+cd ~/
+git clone https://github.com/newracom/nrc7292_sw_pkg_draft.git
+```
+### Prepare host platform (Raspberry Pi 3 Model B+)
+#### Install Newracom Device Tree (DT) overlay
+You can get Device Tree Source (DTS) for NRC7292 in dts directory. Please install DT overlay by following commands below.
+```
+cd /boot/overlays
+sudo dtc -I dts -O dtb -o newracom.dtbo newracom-overlay.dts
+sudo vi /boot/config.txt
+  dtoverlay=newracom
+```
+### Install release package 
+Please upload the contents in host/evk/sw_pkg to sw_pkg directory on host platform, and follow below commands to install release package.
+```
+cd sw_pkg
+chmod +x ./update.sh
+./update.sh
+```
+And you can also install key binaries or build host driver as below.
+#### (Optional) Install firmware/driver/cli_app binaries
+Please follow below commands to install firmware, driver and cli_app.
+```
+cd host/evk/binary
+cp ./cli_app ~/nrc_pkg/script
+cp ./nrc.ko ~/nrc_pkg/sw/driver
+cp ./nrc7292_cspi.bin ~/nrc_pkg/sw/firmware
+```
+#### (Optional) Build host driver
+You can get the pre-built host driver in nrc_pkg/sw/driver, but you can build it by youself by following below commands.
+```
+cd host/nrc_driver/source/nrc_driver/nrc
+make clean
+make
+cp nrc.ko ~/nrc_pkg/sw/driver
+```
+### Run NRC7292 Software Package
+#### Configure start script
+There are a couple of configurable parameters as below.
+```
+# Default Configuration (you can change value you want here)
+txpwr_val   = 17       # TX Power
+maxagg_num  = 8        # 0(AMPDU off) or  >2(AMPDU on)
+cqm_off     = 0        # 0(CQM on) or 1(CQM off)
+fw_name     = 'uni_s1g.bin'
+guard_int   = 'long'   # 'long'(LGI) or 'short'(SGI)
+supplicant_debug = 0   # WPA Supplicant debug option : 0(off) or 1(on)
+hostapd_debug    = 0   # Hostapd debug option    : 0(off) or 1(on)
+power_save       = 0   # power save : 0(off) or 1(on)
+```
+You can apply your parameters by updating start.py script file.
+```
+vi nrc_pkg/script/start.py
+```
+#### Access Point (AP) running procedure
+The following is the parameters for start.py script file.
+```
+Usage:
+        start.py [sta_type] [security_mode] [country] [channel] [sniffer_mode]
+Argument:
+        sta_type      [0:STA   |  1:AP  |  2:SNIFFER  | 3:RELAY]
+        security_mode [0:Open  |  1:WPA2-PSK  |  2:WPA3-OWE  |  3:WPA3-SAE]
+        country       [US:USA  |  JP:Japan  |  TW:Taiwan  | KR:Korea | EU:EURO | CN:China]
+        -----------------------------------------------------------
+        channel       [S1G Channel Number]   * Only for Sniffer
+        sniffer_mode  [0:Local | 1:Remote]   * Only for Sniffer
+Example:
+        OPEN mode STA for Korea                : ./start.py 0 0 KR
+        Security mode AP for US                : ./start.py 1 1 US
+        Local Sniffer mode on CH 40 for Japan  : ./start.py 2 0 JP 40 0
+Note:
+        sniffer_mode should be set as '1' when running sniffer on remote terminal
+```
+The following shows an example of AP running for US channel, and its channel can be configured in nrc_pkg/script/conf/US/ap_halow_open.conf. For WPA2/WPA3 modes, please refer to nrc_pkg/script/conf/US/ap_halow_[sae|owe|wpa2].conf files.
+```
+cd nrc_pkg/script
+./start.py 1 0 US
+```
+#### Station (STA) running procedure
+The following shows an example of STA running for US channel, and its channel can be configured in nrc_pkg/script/conf/US/sta_halow_open.conf. For WPA2/WPA3 modes, please refer to nrc_pkg/script/conf/US/sta_halow_[sae|owe|wpa2].conf files.
+```
+cd nrc_pkg/script
+./start.py 0 0 US
+```
+#### Sniffer running procedure
+The following shows an example of local mode sniffer running for US channel 159.
+```
+cd nrc_pkg/script
+./start.py 2 0 US 159 0
+```

dts/newracom-overlay.dts

@@ -0,0 +1,61 @@
+/*
+ * Device Tree overlay for Newracom
+ */
+
+/dts-v1/;
+/plugin/;
+
+/* this includes disabling SPI and pi3-disable-bt overlay
+*/
+
+/{
+        compatible = "brcm,bcm2835", "brcm,bcm2708", "brcm,bcm2709";
+
+        fragment@0 {
+                target = <&spi0>;
+                __overlay__ {
+                        status = "okay";
+
+                        spidev@0{
+                                status = "disabled";
+                        };
+
+                        spidev@1{
+                                status = "disabled";
+                        };
+                };
+        };
+
+        fragment@1 {
+                target = <&uart1>;
+                __overlay__ {
+                        status = "disabled";
+                };
+        };
+
+        fragment@2 {
+                target = <&uart0>;
+                __overlay__ {
+                        pinctrl-names = "default";
+                        pinctrl-0 = <&uart0_pins>;
+                        status = "okay";
+                };
+        };
+
+        fragment@3 {
+                target = <&uart0_pins>;
+                __overlay__ {
+                        brcm,pins;
+                        brcm,function;
+                        brcm,pull;
+                };
+        };
+
+        fragment@4 {
+                target-path = "/aliases";
+                __overlay__ {
+                        serial0 = "/soc/uart@7e201000";
+                        serial1 = "/soc/uart@7e215040";
+                };
+        };
+};

package/host/NRC7292_SW_PKG_release_note (v1.3.0).pdf

@@ -0,0 +1,13 @@
+CC=gcc
+RM = rm -f
+LDFLAGS=-pthread -lm
+OBJS = cli_cmd.o cli_netlink.o cli_util.o main.o
+TARGET = cli_app
+
+all: $(TARGET)
+
+$(TARGET): $(OBJS)
+	$(CC) $(OBJS) -o $@ $(LDFLAGS)
+
+clean:
+	$(RM) $(OBJS) $(TARGET)