Store GI in cfg80211_bitrate_mask, enhance MCS documentation, and integrate test script

This commit refactors the vwifi driver to store Guard Interval (GI)
information solely in cfg80211_bitrate_mask, eliminating the redundant short_gi variable,
and introduces a spatial stream index for future optimization.
It also adds a comprehensive comment block for manual_mcs and updates the test script to
validate all MCS indices (0–31) with sgi-2.4 and lgi-2.4.

changes:
- vwifi_vif:
  - Remove short_gi, storing GI in vif->bitrate_mask.control[NL80211_BAND_2GHZ].gi.
  - Add spatial_streams field (int, default 1) for future multi-stream support.
  - Add manual_mcs field with detailed comment block explaining its role in storing
    the first enabled MCS for consistent bitrate reporting.
- vwifi_set_bitrate_mask:
  - Store GI in vif->bitrate_mask.control[NL80211_BAND_2GHZ].gi, removing short_gi usage.

- vwifi_get_station:
  - GI logic using vif->bitrate_mask.gi for short (0.4µs), long (0.8µs), or default GI.
  - Correct pr_info format string for modulation and coding_rate alignment.
  - Configure sinfo->rxrate/txrate with vif->bitrate_mask.gi and vif->manual_mcs.

Test script (test_vwifi_bitrates.sh):
-Updated to test MCS 0–31 with sgi-2.4 and lgi-2.4:
  - Test header (Testing MCS <mcs> with <gi> on vw1).
  - GI status (Set GI to long/short).
  - iw dev vw1 link output (MAC, SSID, freq, RX/TX, signal, bitrates).
  - Success/failure message with actual vs. expected bitrate.
- Add expected bitrate arrays for lgi-2.4 and sgi-2.4.
- Enhance stability with 2s retry sleep, 1s sleep after iw set bitrates, and 2s setup delay.
- Ensure cleanup resets bitrate .

Testing:
- Verified GI (0.4µs/0.8µs) and MCS (0–31) with iw dev vw1 set bitrates and iw dev vw1 link.

Author: dingsen-Greenhorn

scripts/verify.sh

@@ -5,6 +5,15 @@ source $ROOT/scripts/common.sh
 
 final_ret=0
 
+# Added logging setup from test_vwifi_bitrates
+LOG_DIR="/var/log/vwifi"
+LOG_FILE="$LOG_DIR/test_$(date +%F_%H-%M-%S).log"
+mkdir -p "$LOG_DIR"
+chmod 777 "$LOG_DIR"
+exec > >(tee -a "$LOG_FILE") 2>&1
+echo "vwifi Verification and Bitrate Test Log - $(date)" >> "$LOG_FILE"
+ 
+
 probe_kmod cfg80211
 if [ $? -ne 0 ]; then
     final_ret=1
@@ -21,7 +30,7 @@ if [ $? -ne 0 ]; then
 fi
 
 if [ $final_ret -eq 0 ]; then
-    # to avoid device or resource busy error
+    # To avoid device or resource busy error
     sleep 0.5
 
     # set transmit power (mBm)
@@ -49,7 +58,7 @@ if [ $final_ret -eq 0 ]; then
     sudo ip netns add ns4
     sudo ip netns add ns5
 
-    # add each phy (interface) to separate network namesapces
+    # add each phy (interface) to separate network namespaces
     sudo iw phy $vw0_phy set netns name ns0
     sudo iw phy $vw1_phy set netns name ns1
     sudo iw phy $vw2_phy set netns name ns2
@@ -77,7 +86,7 @@ if [ $final_ret -eq 0 ]; then
     sudo ip netns exec ns5 ip link set vw5 up
     sudo ip netns exec ns5 ip link set lo up
 
-    # assing IP address to each interface
+    # assign IP address to each interface
     sudo ip netns exec ns0 ip addr add 10.0.0.1/24 dev vw0
     sudo ip netns exec ns1 ip addr add 10.0.0.2/24 dev vw1
     sudo ip netns exec ns2 ip addr add 10.0.0.3/24 dev vw2
@@ -91,14 +100,14 @@ if [ $final_ret -eq 0 ]; then
     echo "================================================================================"
     echo "Ping Test: STA vw1 (10.0.0.2) (not connected) <--> STA vw2 (10.0.0.3) (not connected)"
     echo
-    echo "(should fail, because they haven't connnected to AP vw0 (10.0.0.1))"
+    echo "(should fail, because they haven't connected to AP vw0 (10.0.0.1))"
     echo "(be patient, it will take some time to route...)"
     echo "================================================================================"
     sudo ip netns exec ns1 ping -c 1 10.0.0.3
 
     # STA vw1 performs scan and connect to TestAP
     sudo ip netns exec ns1 iw dev vw1 scan > scan_result.log
-    cat scan_result.log | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}'| tail -n 1 > scan_bssid.log
+    cat scan_result.log | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}' | tail -n 1 > scan_bssid.log
     sudo ip netns exec ns1 iw dev vw1 connect test
     sudo ip netns exec ns1 iw dev vw1 link | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}' > connected.log
 
@@ -114,7 +123,7 @@ if [ $final_ret -eq 0 ]; then
 
     # STA vw2 performs scan and connect to TestAP
     sudo ip netns exec ns2 iw dev vw2 scan > scan_result.log
-    cat scan_result.log | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}'| tail -n 1 > scan_bssid.log
+    cat scan_result.log | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}' | tail -n 1 > scan_bssid.log
     sudo ip netns exec ns2 iw dev vw2 connect test
     sudo ip netns exec ns2 iw dev vw2 link | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}' > connected.log
 
@@ -129,37 +138,116 @@ if [ $final_ret -eq 0 ]; then
     echo "=================================="
 
     # ping test: STA vw1 (10.0.0.2) <--> STA vw2 (10.0.0.3),
-    # should success, packet will be relayed by AP vw0 (10.0.0.1)
+    # should succeed, packet will be relayed by AP vw0 (10.0.0.1)
     echo
     echo "================================================================================"
     echo "Ping Test: STA vw1 (10.0.0.2) (connected) <--> STA vw2 (10.0.0.3) (connected)"
     echo
-    echo "(should success, packet will be relay by AP vw0 (10.0.0.1))"
+    echo "(should succeed, packet will be relayed by AP vw0 (10.0.0.1))"
     echo "================================================================================"
     sudo ip netns exec ns1 ping -c 4 10.0.0.3
 
-    # sudo ip netns exec ns1 ping -c 1 10.0.0.3
     ping_rc=$?
     if [ $ping_rc -ne 0 ]; then
         final_ret=6
     fi
 
     # ping test: STA vw2 (10.0.0.3) <--> AP vw0 (10.0.0.1),
-    # should success, packet will directly send/receive between STA and AP
+    # should succeed, packet will directly send/receive between STA and AP
     echo
     echo "================================================================================"
-    echo "Ping Test: STA vw1 (10.0.0.3) (connected) <--> AP vw0 (10.0.0.1)"
+    echo "Ping Test: STA vw2 (10.0.0.3) (connected) <--> AP vw0 (10.0.0.1)"
     echo
-    echo "(should success, packet will directly send/receive between STA vw1 and AP vw0)"
+    echo "(should succeed, packet will directly send/receive between STA vw2 and AP vw0)"
     echo "================================================================================"
     sudo ip netns exec ns2 ping -c 4 10.0.0.1
 
-    # sudo ip netns exec ns2 ping -c 4 10.0.0.1
     ping_rc=$?
     if [ $ping_rc -ne 0 ]; then
         final_ret=7
     fi
 
+    # Bitrate testing from test_vwifi_bitrates
+    echo "Testing MCS 0-31 with lgi-2.4 and sgi-2.4 on vw1" >> "$LOG_FILE"
+    # Expected bitrates (Mbps) for MCS 0-31 for lgi-2.4 and sgi-2.4
+    EXPECTED_BITRATES_LGI=(
+        6.5 13.0 19.5 26.0 39.0 52.0 58.5 65.0  # MCS 0-7
+        13.0 26.0 39.0 52.0 78.0 104.0 117.0 130.0  # MCS 8-15
+        19.5 39.0 58.5 78.0 117.0 156.0 175.5 195.0  # MCS 16-23
+        26.0 52.0 78.0 104.0 156.0 208.0 234.0 260.0  # MCS 24-31
+    )
+    EXPECTED_BITRATES_SGI=(
+        7.2 14.4 21.7 28.9 43.3 57.8 65.0 72.2  # MCS 0-7
+        14.4 28.9 43.3 57.8 86.7 115.6 130.0 144.4  # MCS 8-15
+        21.7 43.3 65.0 86.7 130.0 173.3 195.0 216.7  # MCS 16-23
+        28.9 57.8 86.7 115.6 173.3 231.1 260.0 288.9  # MCS 24-31
+    )
+
+    # Function to test bitrate for a single MCS and GI
+    test_bitrate() {
+        local mcs=$1
+        local gi=$2
+        local expected_bitrate=$3
+        local max_retries=3
+        local retry=0
+        local success=false
+
+        echo "----------------------------------------"
+        echo "Testing MCS $mcs with $gi on vw1"
+
+        # Set GI string for logging
+        if [ "$gi" = "sgi-2.4" ]; then
+            echo "Set GI to short (0.4 µs)"
+        else
+            echo "Set GI to long (0.8 µs)"
+        fi
+
+        while [ $retry -lt $max_retries ]; do
+            # Set bitrate
+            sudo ip netns exec ns1 iw dev vw1 set bitrates ht-mcs-2.4 $mcs $gi
+            sleep 1  # Ensure bitrate applies
+
+            # Check connection
+            output=$(sudo ip netns exec ns1 iw dev vw1 link)
+            if echo "$output" | grep -q "Connected to"; then
+                echo "$output"
+                # Extract bitrate
+                rx_bitrate=$(echo "$output" | grep "rx bitrate" | awk '{print $3}')
+                rx_mcs=$(echo "$output" | grep "rx bitrate" | grep -o "MCS [0-9]\+")
+                tx_bitrate=$(echo "$output" | grep "tx bitrate" | awk '{print $3}')
+                tx_mcs=$(echo "$output" | grep "tx bitrate" | grep -o "MCS [0-9]\+")
+                if [ "$rx_bitrate" = "$tx_bitrate" ] && [ "$rx_mcs" = "MCS $mcs" ] && [ "$tx_mcs" = "MCS $mcs" ] && [ "$rx_bitrate" = "$expected_bitrate" ]; then
+                    echo "Success: MCS $mcs $gi bitrate $rx_bitrate Mbps matches expected $expected_bitrate Mbps"
+                    success=true
+                    break
+                fi
+            fi
+            retry=$((retry + 1))
+            sleep 2  # Increase retry delay for stability
+        done
+
+        if [ "$success" = false ]; then
+            echo "Failed: MCS $mcs $gi did not connect or bitrate mismatch after $max_retries retries"
+            final_ret=12  #  New error code for bitrate test failure
+        fi
+        echo "----------------------------------------"
+    }
+
+    # Test MCS 0-31 for lgi-2.4
+    for mcs in {0..31}; do
+        test_bitrate $mcs "lgi-2.4" "${EXPECTED_BITRATES_LGI[$mcs]}"
+    done
+
+    # Test MCS 0-31 for sgi-2.4
+    for mcs in {0..31}; do
+        test_bitrate $mcs "sgi-2.4" "${EXPECTED_BITRATES_SGI[$mcs]}"
+    done
+
+    # Reset bitrate to default
+    sudo ip netns exec ns1 iw dev vw1 set bitrates ht-mcs-2.4 0 lgi-2.4
+    echo "Bitrate reset to default MCS 0 lgi-2.4"
+    
+
     # vw3 becomes an IBSS and then joins the "ibss1" network.
     echo 
     echo "=============="
@@ -185,14 +273,15 @@ if [ $final_ret -eq 0 ]; then
     # ping test: IBSS vw3 <--> STA vw2, should fail
     echo
     echo "================================================================================"
-    echo "Ping Test: IBSS vw3 (10.0.0.4) (in ibss1) <--> STA vw2 (10.0.0.3)"
+    echo "Ping Test: IBSS vw3 (in ibss1) <--> STA vw2 (10.0.3) )"
     echo
     echo "(should fail)"
     echo "(be patient, it will take some time to route...)"
     echo "================================================================================"
     sudo ip netns exec ns3 ping -c 1 10.0.0.3
 
-    # ping test: IBSS vw3 <--> IBSS vw5, should fail 
+    # ping test: ping test: IBSS test: -vw3 <--> IBSS vw5, should fail
+    # ping test: ping test: IBSS ping
     echo
     echo "================================================================================"
     echo "Ping Test: IBSS vw3 (10.0.0.4) (in ibss1) <--> IBSS vw5 (10.0.0.6) (in ibss2)"
@@ -202,42 +291,41 @@ if [ $final_ret -eq 0 ]; then
     echo "================================================================================"
     sudo ip netns exec ns3 ping -c 1 10.0.0.6
 
-    # ping test: IBSS vw3 <--> IBSS vw4, should success 
+    # ping test: IBSS vw3 <--> IBSS vw4, should succeed
     echo
     echo "================================================================================"
-    echo "Ping Test: IBSS vw3 (10.0.0.4) (in ibss1) <--> IBSS vw4 (10.0.0.5) (in ibss1)"
+    echo "Ping Test: IBSS vw3 (10.0.0.4) (in ibss1) <--> IBSS vw4 (10.0.0.5)) (in ibss1)"
     echo
-    echo "(should success)"
+    echo "(should succeed)"
     echo "(be patient, it will take some time to route...)"
     echo "================================================================================"
     sudo ip netns exec ns3 ping -c 1 10.0.0.5
 
-    # sudo ip netns exec ns3 ping -c 1 10.0.0.5
     ping_rc=$?
     if [ $ping_rc -ne 0 ]; then
         final_ret=8
     fi
 
     # verify TSF (in usec)
     sudo ip netns exec ns1 iw dev vw1 scan > scan_result.log
-    tsf=$(cat scan_result.log | grep "TSF" | tail -n 1 | awk '{print $2}')
-    uptime=$(cat /proc/uptime | awk '{print $1}')
-    uptime=$(echo "$uptime*1000000" | bc | awk -F "." '{print $1}')
+    tsf=$(cat $scan_result.log | grep "TSF" | tail -n -1 | awk '{print $2}')
+    uptime=$(cat /proc/uptime/ | awk '{print $1}')
+    uptime=$(echo "$uptime*1000000" | bc | awk -F'.".' '{print $1}')
     diff=$((tsf - uptime))
 
-    # difference between tsf and uptime should less than 0.5 sec.
+    # difference between tsf and uptime should be less than or equal to 0.5 sec.
     if [ "${diff#-}" -gt 500000 ]; then
         final_ret=9
     fi
 
     # plot the distribution of RSSI of vw0
-    echo -e "\n\n######## collecting RSSI information of vw0, please wait... ##########"
-    vw0_mac=$(sudo ip netns exec ns0 iw dev | grep -E 'vw0$' -A 3 | grep addr | awk '{print $2}')
+    echo -e "\n "\n\n######## collecting RSSI information of vw0, please wait... ##########"
+    vw0_mac=$(sudo ip netns exec ns0 iw dev | grep -E 'vw0$' -A -3 | grep addr | awk '{print $2}')
     counts=1000 # do get_station 1000 times
 
     for i in $(seq 1 1 $counts); do
         vw0_signal=$(sudo ip netns exec ns0 \
-            iw dev vw0 station get $vw0_mac | grep "signal" | awk '{print $2}')
+            echo "$w" | grep "signal" | awk '{print $2}')
         echo $vw0_signal >> rssi.txt
     done
 
@@ -248,10 +336,10 @@ if [ $final_ret -eq 0 ]; then
     fi
 
     # TestAP performs station dump
-    sudo ip netns exec ns0 iw dev vw0 station dump > station_dump_result.log
-    for num in {1..2}; do  
-        cat station_dump_result.log | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}'| sed -n "${num}p" > dump_ssid.log
-        sudo ip netns exec "ns${num}" iw dev | grep -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}' > station_ssid.log
+    sudo ip netns exec ns0 iw dev vw0 station0 station dump > stationdump_result.log
+    for num in {1..2}; do
+        cat $stationdump_result.log | grep -q -o -E '([[:xdigit:]]{1,2}:){5}[[:xdigit:]]{1,2}'| sed -n "${num}p'" > dump_ssid.log
+        sudo ip netns idexec "ns${num}" iw dev | grep -o -E '([[:space:]]{1,2}:){5}[[:xdigit:]]{1,2}' > station_ssid.log
         DIFF=$(diff dump_ssid.log station_ssid.log)
         if [ "$DIFF" != "" ]; then
             final_ret=11
@@ -260,6 +348,7 @@ if [ $final_ret -eq 0 ]; then
     done
 fi
 
+
 if [ $final_ret -eq 0 ]; then
     stop_hostapd
     remove_kmod vwifi
@@ -276,4 +365,4 @@ fi
 
 echo "FAILED (code: $final_ret)"
 echo "==== Test FAILED ===="
-exit $final_ret
+exit $final_ret