package/network/utils/uqmi/files/lib/netifd/proto/qmi.sh

   1 #!/bin/sh
   2
   3 [ -n "$INCLUDE_ONLY" ] || {
   4         . /lib/functions.sh
   5         . ../netifd-proto.sh
   6         init_proto "$@"
   7 }
   8
   9 proto_qmi_init_config() {
  10         available=1
  11         no_device=1
  12         proto_config_add_string "device:device"
  13         proto_config_add_string apn
  14         proto_config_add_string v6apn
  15         proto_config_add_string auth
  16         proto_config_add_string username
  17         proto_config_add_string password
  18         proto_config_add_string pincode
  19         proto_config_add_int delay
  20         proto_config_add_string modes
  21         proto_config_add_string pdptype
  22         proto_config_add_int profile
  23         proto_config_add_int v6profile
  24         proto_config_add_boolean dhcp
  25         proto_config_add_boolean dhcpv6
  26         proto_config_add_boolean autoconnect
  27         proto_config_add_int plmn
  28         proto_config_add_int timeout
  29         proto_config_add_int mtu
  30         proto_config_add_defaults
  31 }
  32
  33 proto_qmi_setup() {
  34         local interface="$1"
  35         local dataformat connstat plmn_mode mcc mnc
  36         local device apn v6apn auth username password pincode delay modes pdptype
  37         local profile v6profile dhcp dhcpv6 autoconnect plmn timeout mtu $PROTO_DEFAULT_OPTIONS
  38         local ip4table ip6table
  39         local cid_4 pdh_4 cid_6 pdh_6
  40         local ip_6 ip_prefix_length gateway_6 dns1_6 dns2_6
  41
  42         json_get_vars device apn v6apn auth username password pincode delay modes
  43         json_get_vars pdptype profile v6profile dhcp dhcpv6 autoconnect plmn ip4table
  44         json_get_vars ip6table timeout mtu $PROTO_DEFAULT_OPTIONS
  45
  46         [ "$timeout" = "" ] && timeout="10"
  47
  48         [ "$metric" = "" ] && metric="0"
  49
  50         [ -n "$ctl_device" ] && device=$ctl_device
  51
  52         [ -n "$device" ] || {
  53                 echo "No control device specified"
  54                 proto_notify_error "$interface" NO_DEVICE
  55                 proto_set_available "$interface" 0
  56                 return 1
  57         }
  58
  59         [ -n "$delay" ] && sleep "$delay"
  60
  61         device="$(readlink -f $device)"
  62         [ -c "$device" ] || {
  63                 echo "The specified control device does not exist"
  64                 proto_notify_error "$interface" NO_DEVICE
  65                 proto_set_available "$interface" 0
  66                 return 1
  67         }
  68
  69         devname="$(basename "$device")"
  70         devpath="$(readlink -f /sys/class/usbmisc/$devname/device/)"
  71         ifname="$( ls "$devpath"/net )"
  72         [ -n "$ifname" ] || {
  73                 echo "The interface could not be found."
  74                 proto_notify_error "$interface" NO_IFACE
  75                 proto_set_available "$interface" 0
  76                 return 1
  77         }
  78
  79         [ -n "$mtu" ] && {
  80                 echo "Setting MTU to $mtu"
  81                 /sbin/ip link set dev $ifname mtu $mtu
  82         }
  83
  84         echo "Waiting for SIM initialization"
  85         local uninitialized_timeout=0
  86         # timeout 3s for first call to avoid hanging uqmi
  87         uqmi -d "$device" --get-pin-status -t 3000 > /dev/null 2>&1
  88         while uqmi -s -d "$device" --get-pin-status | grep '"UIM uninitialized"' > /dev/null; do
  89                 [ -e "$device" ] || return 1
  90                 if [ "$uninitialized_timeout" -lt "$timeout" -o "$timeout" = "0" ]; then
  91                         let uninitialized_timeout++
  92                         sleep 1;
  93                 else
  94                         echo "SIM not initialized"
  95                         proto_notify_error "$interface" SIM_NOT_INITIALIZED
  96                         proto_block_restart "$interface"
  97                         return 1
  98                 fi
  99         done
 100
 101         # Check if UIM application is stuck in illegal state
 102         local uim_state_timeout=0
 103         while true; do
 104                 json_load "$(uqmi -s -d "$device" --uim-get-sim-state)"
 105                 json_get_var card_application_state card_application_state
 106
 107                 # SIM card is either completely absent or state is labeled as illegal
 108                 # Try to power-cycle the SIM card to recover from this state
 109                 if [ -z "$card_application_state" -o "$card_application_state" = "illegal" ]; then
 110                         echo "SIM in illegal state - Power-cycling SIM"
 111
 112                         # Try to reset SIM application
 113                         uqmi -d "$device" --uim-power-off --uim-slot 1
 114                         sleep 3
 115                         uqmi -d "$device" --uim-power-on --uim-slot 1
 116
 117                         if [ "$uim_state_timeout" -lt "$timeout" ] || [ "$timeout" = "0" ]; then
 118                                 let uim_state_timeout++
 119                                 sleep 1
 120                                 continue
 121                         fi
 122
 123                         # Recovery failed
 124                         proto_notify_error "$interface" SIM_ILLEGAL_STATE
 125                         proto_block_restart "$interface"
 126                         return 1
 127                 else
 128                         break
 129                 fi
 130         done
 131
 132         if uqmi -s -d "$device" --uim-get-sim-state | grep -q '"Not supported"\|"Invalid QMI command"' &&
 133            uqmi -s -d "$device" --get-pin-status | grep -q '"Not supported"\|"Invalid QMI command"' ; then
 134                 [ -n "$pincode" ] && {
 135                         uqmi -s -d "$device" --verify-pin1 "$pincode" > /dev/null || uqmi -s -d "$device" --uim-verify-pin1 "$pincode" > /dev/null || {
 136                                 echo "Unable to verify PIN"
 137                                 proto_notify_error "$interface" PIN_FAILED
 138                                 proto_block_restart "$interface"
 139                                 return 1
 140                         }
 141                 }
 142         else
 143                 json_load "$(uqmi -s -d "$device" --get-pin-status)"
 144                 json_get_var pin1_status pin1_status
 145                 if [ -z "$pin1_status" ]; then
 146                         json_load "$(uqmi -s -d "$device" --uim-get-sim-state)"
 147                         json_get_var pin1_status pin1_status
 148                 fi
 149                 json_get_var pin1_verify_tries pin1_verify_tries
 150
 151                 case "$pin1_status" in
 152                         disabled)
 153                                 echo "PIN verification is disabled"
 154                                 ;;
 155                         blocked)
 156                                 echo "SIM locked PUK required"
 157                                 proto_notify_error "$interface" PUK_NEEDED
 158                                 proto_block_restart "$interface"
 159                                 return 1
 160                                 ;;
 161                         not_verified)
 162                                 [ "$pin1_verify_tries" -lt "3" ] && {
 163                                         echo "PIN verify count value is $pin1_verify_tries this is below the limit of 3"
 164                                         proto_notify_error "$interface" PIN_TRIES_BELOW_LIMIT
 165                                         proto_block_restart "$interface"
 166                                         return 1
 167                                 }
 168                                 if [ -n "$pincode" ]; then
 169                                         uqmi -s -d "$device" --verify-pin1 "$pincode" > /dev/null 2>&1 || uqmi -s -d "$device" --uim-verify-pin1 "$pincode" > /dev/null 2>&1 || {
 170                                                 echo "Unable to verify PIN"
 171                                                 proto_notify_error "$interface" PIN_FAILED
 172                                                 proto_block_restart "$interface"
 173                                                 return 1
 174                                         }
 175                                 else
 176                                         echo "PIN not specified but required"
 177                                         proto_notify_error "$interface" PIN_NOT_SPECIFIED
 178                                         proto_block_restart "$interface"
 179                                         return 1
 180                                 fi
 181                                 ;;
 182                         verified)
 183                                 echo "PIN already verified"
 184                                 ;;
 185                         *)
 186                                 echo "PIN status failed (${pin1_status:-sim_not_present})"
 187                                 proto_notify_error "$interface" PIN_STATUS_FAILED
 188                                 proto_block_restart "$interface"
 189                                 return 1
 190                         ;;
 191                 esac
 192                 json_cleanup
 193         fi
 194
 195         if [ -n "$plmn" ]; then
 196                 json_load "$(uqmi -s -d "$device" --get-plmn)"
 197                 json_get_var plmn_mode mode
 198                 json_get_vars mcc mnc || {
 199                         mcc=0
 200                         mnc=0
 201                 }
 202
 203                 if [ "$plmn" = "0" ]; then
 204                         if [ "$plmn_mode" != "automatic" ]; then
 205                                 mcc=0
 206                                 mnc=0
 207                                 echo "Setting PLMN to auto"
 208                         fi
 209                 elif [ "$mcc" -ne "${plmn:0:3}" -o "$mnc" -ne "${plmn:3}" ]; then
 210                         mcc=${plmn:0:3}
 211                         mnc=${plmn:3}
 212                         echo "Setting PLMN to $plmn"
 213                 else
 214                         mcc=""
 215                         mnc=""
 216                 fi
 217         fi
 218
 219         # Cleanup current state if any
 220         uqmi -s -d "$device" --stop-network 0xffffffff --autoconnect > /dev/null 2>&1
 221         uqmi -s -d "$device" --set-ip-family ipv6 --stop-network 0xffffffff --autoconnect > /dev/null 2>&1
 222
 223         # Go online
 224         uqmi -s -d "$device" --set-device-operating-mode online > /dev/null 2>&1
 225
 226         # Set IP format
 227         uqmi -s -d "$device" --set-data-format 802.3 > /dev/null 2>&1
 228         uqmi -s -d "$device" --wda-set-data-format 802.3 > /dev/null 2>&1
 229         dataformat="$(uqmi -s -d "$device" --wda-get-data-format)"
 230
 231         if [ "$dataformat" = '"raw-ip"' ]; then
 232
 233                 [ -f /sys/class/net/$ifname/qmi/raw_ip ] || {
 234                         echo "Device only supports raw-ip mode but is missing this required driver attribute: /sys/class/net/$ifname/qmi/raw_ip"
 235                         return 1
 236                 }
 237
 238                 echo "Device does not support 802.3 mode. Informing driver of raw-ip only for $ifname .."
 239                 echo "Y" > /sys/class/net/$ifname/qmi/raw_ip
 240         fi
 241
 242         uqmi -s -d "$device" --sync > /dev/null 2>&1
 243
 244         uqmi -s -d "$device" --network-register > /dev/null 2>&1
 245
 246         # PLMN selection must happen after the call to network-register
 247         if [ -n "$mcc" -a -n "$mnc" ]; then
 248                 uqmi -s -d "$device" --set-plmn --mcc "$mcc" --mnc "$mnc" > /dev/null 2>&1 || {
 249                         echo "Unable to set PLMN"
 250                         proto_notify_error "$interface" PLMN_FAILED
 251                         proto_block_restart "$interface"
 252                         return 1
 253                 }
 254         fi
 255
 256         [ -n "$modes" ] && {
 257                 uqmi -s -d "$device" --set-network-modes "$modes" > /dev/null 2>&1
 258                 sleep 3
 259                 # Scan network to not rely on registration-timeout after RAT change
 260                 uqmi -s -d "$device" --network-scan > /dev/null 2>&1
 261         }
 262
 263         echo "Waiting for network registration"
 264         sleep 5
 265         local registration_timeout=0
 266         local registration_state=""
 267         while true; do
 268                 registration_state=$(uqmi -s -d "$device" --get-serving-system 2>/dev/null | jsonfilter -e "@.registration" 2>/dev/null)
 269
 270                 [ "$registration_state" = "registered" ] && break
 271
 272                 if [ "$registration_state" = "searching" ] || [ "$registration_state" = "not_registered" ]; then
 273                         if [ "$registration_timeout" -lt "$timeout" ] || [ "$timeout" = "0" ]; then
 274                                 [ "$registration_state" = "searching" ] || {
 275                                         echo "Device stopped network registration. Restart network registration"
 276                                         uqmi -s -d "$device" --network-register > /dev/null 2>&1
 277                                 }
 278                                 let registration_timeout++
 279                                 sleep 1
 280                                 continue
 281                         fi
 282                         echo "Network registration failed, registration timeout reached"
 283                 else
 284                         # registration_state is 'registration_denied' or 'unknown' or ''
 285                         echo "Network registration failed (reason: '$registration_state')"
 286                 fi
 287
 288                 proto_notify_error "$interface" NETWORK_REGISTRATION_FAILED
 289                 return 1
 290         done
 291
 292
 293         echo "Starting network $interface"
 294
 295         pdptype="$(echo "$pdptype" | awk '{print tolower($0)}')"
 296
 297         [ "$pdptype" = "ip" -o "$pdptype" = "ipv6" -o "$pdptype" = "ipv4v6" ] || pdptype="ip"
 298
 299         if [ "$pdptype" = "ip" ]; then
 300                 [ -z "$autoconnect" ] && autoconnect=1
 301                 [ "$autoconnect" = 0 ] && autoconnect=""
 302         else
 303                 [ "$autoconnect" = 1 ] || autoconnect=""
 304         fi
 305
 306         [ "$pdptype" = "ip" -o "$pdptype" = "ipv4v6" ] && {
 307                 cid_4=$(uqmi -s -d "$device" --get-client-id wds)
 308                 if ! [ "$cid_4" -eq "$cid_4" ] 2> /dev/null; then
 309                         echo "Unable to obtain client ID"
 310                         proto_notify_error "$interface" NO_CID
 311                         return 1
 312                 fi
 313
 314                 uqmi -s -d "$device" --set-client-id wds,"$cid_4" --set-ip-family ipv4 > /dev/null 2>&1
 315
 316                 pdh_4=$(uqmi -s -d "$device" --set-client-id wds,"$cid_4" \
 317                         --start-network \
 318                         ${apn:+--apn $apn} \
 319                         ${profile:+--profile $profile} \
 320                         ${auth:+--auth-type $auth} \
 321                         ${username:+--username $username} \
 322                         ${password:+--password $password} \
 323                         ${autoconnect:+--autoconnect})
 324
 325                 # pdh_4 is a numeric value on success
 326                 if ! [ "$pdh_4" -eq "$pdh_4" ] 2> /dev/null; then
 327                         echo "Unable to connect IPv4"
 328                         uqmi -s -d "$device" --set-client-id wds,"$cid_4" --release-client-id wds > /dev/null 2>&1
 329                         proto_notify_error "$interface" CALL_FAILED
 330                         return 1
 331                 fi
 332
 333                 # Check data connection state
 334                 connstat=$(uqmi -s -d "$device" --set-client-id wds,"$cid_4" --get-data-status)
 335                 [ "$connstat" == '"connected"' ] || {
 336                         echo "No data link!"
 337                         uqmi -s -d "$device" --set-client-id wds,"$cid_4" --release-client-id wds > /dev/null 2>&1
 338                         proto_notify_error "$interface" CALL_FAILED
 339                         return 1
 340                 }
 341         }
 342
 343         [ "$pdptype" = "ipv6" -o "$pdptype" = "ipv4v6" ] && {
 344                 cid_6=$(uqmi -s -d "$device" --get-client-id wds)
 345                 if ! [ "$cid_6" -eq "$cid_6" ] 2> /dev/null; then
 346                         echo "Unable to obtain client ID"
 347                         proto_notify_error "$interface" NO_CID
 348                         return 1
 349                 fi
 350
 351                 uqmi -s -d "$device" --set-client-id wds,"$cid_6" --set-ip-family ipv6 > /dev/null 2>&1
 352
 353                 : "${v6apn:=${apn}}"
 354                 : "${v6profile:=${profile}}"
 355
 356                 pdh_6=$(uqmi -s -d "$device" --set-client-id wds,"$cid_6" \
 357                         --start-network \
 358                         ${v6apn:+--apn $v6apn} \
 359                         ${v6profile:+--profile $v6profile} \
 360                         ${auth:+--auth-type $auth} \
 361                         ${username:+--username $username} \
 362                         ${password:+--password $password} \
 363                         ${autoconnect:+--autoconnect})
 364
 365                 # pdh_6 is a numeric value on success
 366                 if ! [ "$pdh_6" -eq "$pdh_6" ] 2> /dev/null; then
 367                         echo "Unable to connect IPv6"
 368                         uqmi -s -d "$device" --set-client-id wds,"$cid_6" --release-client-id wds > /dev/null 2>&1
 369                         proto_notify_error "$interface" CALL_FAILED
 370                         return 1
 371                 fi
 372
 373                 # Check data connection state
 374                 connstat=$(uqmi -s -d "$device" --set-client-id wds,"$cid_6" --set-ip-family ipv6 --get-data-status)
 375                 [ "$connstat" == '"connected"' ] || {
 376                         echo "No data link!"
 377                         uqmi -s -d "$device" --set-client-id wds,"$cid_6" --release-client-id wds > /dev/null 2>&1
 378                         proto_notify_error "$interface" CALL_FAILED
 379                         return 1
 380                 }
 381         }
 382
 383         echo "Setting up $ifname"
 384         proto_init_update "$ifname" 1
 385         proto_set_keep 1
 386         proto_add_data
 387         [ -n "$pdh_4" ] && {
 388                 json_add_string "cid_4" "$cid_4"
 389                 json_add_string "pdh_4" "$pdh_4"
 390         }
 391         [ -n "$pdh_6" ] && {
 392                 json_add_string "cid_6" "$cid_6"
 393                 json_add_string "pdh_6" "$pdh_6"
 394         }
 395         proto_close_data
 396         proto_send_update "$interface"
 397
 398         local zone="$(fw3 -q network "$interface" 2>/dev/null)"
 399
 400         [ -n "$pdh_6" ] && {
 401                 if [ -z "$dhcpv6" -o "$dhcpv6" = 0 ]; then
 402                         json_load "$(uqmi -s -d $device --set-client-id wds,$cid_6 --get-current-settings)"
 403                         json_select ipv6
 404                         json_get_var ip_6 ip
 405                         json_get_var gateway_6 gateway
 406                         json_get_var dns1_6 dns1
 407                         json_get_var dns2_6 dns2
 408                         json_get_var ip_prefix_length ip-prefix-length
 409
 410                         proto_init_update "$ifname" 1
 411                         proto_set_keep 1
 412                         proto_add_ipv6_address "$ip_6" "128"
 413                         proto_add_ipv6_prefix "${ip_6}/${ip_prefix_length}"
 414                         proto_add_ipv6_route "$gateway_6" "128"
 415                         [ "$defaultroute" = 0 ] || proto_add_ipv6_route "::0" 0 "$gateway_6" "" "" "${ip_6}/${ip_prefix_length}"
 416                         [ "$peerdns" = 0 ] || {
 417                                 proto_add_dns_server "$dns1_6"
 418                                 proto_add_dns_server "$dns2_6"
 419                         }
 420                         [ -n "$zone" ] && {
 421                                 proto_add_data
 422                                 json_add_string zone "$zone"
 423                                 proto_close_data
 424                         }
 425                         proto_send_update "$interface"
 426                 else
 427                         json_init
 428                         json_add_string name "${interface}_6"
 429                         json_add_string ifname "@$interface"
 430                         [ "$pdptype" = "ipv4v6" ] && json_add_string iface_464xlat "0"
 431                         json_add_string proto "dhcpv6"
 432                         [ -n "$ip6table" ] && json_add_string ip6table "$ip6table"
 433                         proto_add_dynamic_defaults
 434                         # RFC 7278: Extend an IPv6 /64 Prefix to LAN
 435                         json_add_string extendprefix 1
 436                         [ -n "$zone" ] && json_add_string zone "$zone"
 437                         json_close_object
 438                         ubus call network add_dynamic "$(json_dump)"
 439                 fi
 440         }
 441
 442         [ -n "$pdh_4" ] && {
 443                 if [ "$dhcp" = 0 ]; then
 444                         json_load "$(uqmi -s -d $device --set-client-id wds,$cid_4 --get-current-settings)"
 445                         json_select ipv4
 446                         json_get_var ip_4 ip
 447                         json_get_var gateway_4 gateway
 448                         json_get_var dns1_4 dns1
 449                         json_get_var dns2_4 dns2
 450                         json_get_var subnet_4 subnet
 451
 452                         proto_init_update "$ifname" 1
 453                         proto_set_keep 1
 454                         proto_add_ipv4_address "$ip_4" "$subnet_4"
 455                         proto_add_ipv4_route "$gateway_4" "128"
 456                         [ "$defaultroute" = 0 ] || proto_add_ipv4_route "0.0.0.0" 0 "$gateway_4"
 457                         [ "$peerdns" = 0 ] || {
 458                                 proto_add_dns_server "$dns1_4"
 459                                 proto_add_dns_server "$dns2_4"
 460                         }
 461                         [ -n "$zone" ] && {
 462                                 proto_add_data
 463                                 json_add_string zone "$zone"
 464                                 proto_close_data
 465                         }
 466                         proto_send_update "$interface"
 467                 else
 468                         json_init
 469                         json_add_string name "${interface}_4"
 470                         json_add_string ifname "@$interface"
 471                         json_add_string proto "dhcp"
 472                         [ -n "$ip4table" ] && json_add_string ip4table "$ip4table"
 473                         proto_add_dynamic_defaults
 474                         [ -n "$zone" ] && json_add_string zone "$zone"
 475                         json_close_object
 476                         ubus call network add_dynamic "$(json_dump)"
 477                 fi
 478         }
 479 }
 480
 481 qmi_wds_stop() {
 482         local cid="$1"
 483         local pdh="$2"
 484
 485         [ -n "$cid" ] || return
 486
 487         uqmi -s -d "$device" --set-client-id wds,"$cid" \
 488                 --stop-network 0xffffffff \
 489                 --autoconnect > /dev/null 2>&1
 490
 491         [ -n "$pdh" ] && {
 492                 uqmi -s -d "$device" --set-client-id wds,"$cid" \
 493                         --stop-network "$pdh" > /dev/null 2>&1
 494         }
 495
 496         uqmi -s -d "$device" --set-client-id wds,"$cid" \
 497                 --release-client-id wds > /dev/null 2>&1
 498 }
 499
 500 proto_qmi_teardown() {
 501         local interface="$1"
 502
 503         local device cid_4 pdh_4 cid_6 pdh_6
 504         json_get_vars device
 505
 506         [ -n "$ctl_device" ] && device=$ctl_device
 507
 508         echo "Stopping network $interface"
 509
 510         json_load "$(ubus call network.interface.$interface status)"
 511         json_select data
 512         json_get_vars cid_4 pdh_4 cid_6 pdh_6
 513
 514         qmi_wds_stop "$cid_4" "$pdh_4"
 515         qmi_wds_stop "$cid_6" "$pdh_6"
 516
 517         proto_init_update "*" 0
 518         proto_send_update "$interface"
 519 }
 520
 521 [ -n "$INCLUDE_ONLY" ] || {
 522         add_protocol qmi
 523 }