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