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
  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         [ -n "$plmn" ] && {
 156                 local mcc mnc
 157                 if [ "$plmn" = 0 ]; then
 158                         mcc=0
 159                         mnc=0
 160                         echo "Setting PLMN to auto"
 161                 else
 162                         mcc=${plmn:0:3}
 163                         mnc=${plmn:3}
 164                         echo "Setting PLMN to $plmn"
 165                 fi
 166                 uqmi -s -d "$device" --set-plmn --mcc "$mcc" --mnc "$mnc" > /dev/null 2>&1 || {
 167                         echo "Unable to set PLMN"
 168                         proto_notify_error "$interface" PLMN_FAILED
 169                         proto_block_restart "$interface"
 170                         return 1
 171                 }
 172         }
 173
 174         # Cleanup current state if any
 175         uqmi -s -d "$device" --stop-network 0xffffffff --autoconnect > /dev/null 2>&1
 176
 177         # Go online
 178         uqmi -s -d "$device" --set-device-operating-mode online > /dev/null 2>&1
 179
 180         # Set IP format
 181         uqmi -s -d "$device" --set-data-format 802.3 > /dev/null 2>&1
 182         uqmi -s -d "$device" --wda-set-data-format 802.3 > /dev/null 2>&1
 183         dataformat="$(uqmi -s -d "$device" --wda-get-data-format)"
 184
 185         if [ "$dataformat" = '"raw-ip"' ]; then
 186
 187                 [ -f /sys/class/net/$ifname/qmi/raw_ip ] || {
 188                         echo "Device only supports raw-ip mode but is missing this required driver attribute: /sys/class/net/$ifname/qmi/raw_ip"
 189                         return 1
 190                 }
 191
 192                 echo "Device does not support 802.3 mode. Informing driver of raw-ip only for $ifname .."
 193                 echo "Y" > /sys/class/net/$ifname/qmi/raw_ip
 194         fi
 195
 196         uqmi -s -d "$device" --sync > /dev/null 2>&1
 197
 198         echo "Waiting for network registration"
 199         local registration_timeout=0
 200         while uqmi -s -d "$device" --get-serving-system | grep '"searching"' > /dev/null; do
 201                 [ -e "$device" ] || return 1
 202                 if [ "$registration_timeout" -lt "$timeout" -o "$timeout" = "0" ]; then
 203                         let registration_timeout++
 204                         sleep 1;
 205                 else
 206                         echo "Network registration failed"
 207                         proto_notify_error "$interface" NETWORK_REGISTRATION_FAILED
 208                         proto_block_restart "$interface"
 209                         return 1
 210                 fi
 211         done
 212
 213         [ -n "$modes" ] && uqmi -s -d "$device" --set-network-modes "$modes" > /dev/null 2>&1
 214
 215         echo "Starting network $interface"
 216
 217         pdptype=$(echo "$pdptype" | awk '{print tolower($0)}')
 218         [ "$pdptype" = "ip" -o "$pdptype" = "ipv6" -o "$pdptype" = "ipv4v6" ] || pdptype="ip"
 219
 220         if [ "$pdptype" = "ip" ]; then
 221                 [ -z "$autoconnect" ] && autoconnect=1
 222                 [ "$autoconnect" = 0 ] && autoconnect=""
 223         else
 224                 [ "$autoconnect" = 1 ] || autoconnect=""
 225         fi
 226
 227         [ "$pdptype" = "ip" -o "$pdptype" = "ipv4v6" ] && {
 228                 cid_4=$(uqmi -s -d "$device" --get-client-id wds)
 229                 if ! [ "$cid_4" -eq "$cid_4" ] 2> /dev/null; then
 230                         echo "Unable to obtain client ID"
 231                         proto_notify_error "$interface" NO_CID
 232                         return 1
 233                 fi
 234
 235                 uqmi -s -d "$device" --set-client-id wds,"$cid_4" --set-ip-family ipv4 > /dev/null 2>&1
 236
 237                 pdh_4=$(uqmi -s -d "$device" --set-client-id wds,"$cid_4" \
 238                         --start-network \
 239                         ${apn:+--apn $apn} \
 240                         ${profile:+--profile $profile} \
 241                         ${auth:+--auth-type $auth} \
 242                         ${username:+--username $username} \
 243                         ${password:+--password $password} \
 244                         ${autoconnect:+--autoconnect})
 245
 246                 # pdh_4 is a numeric value on success
 247                 if ! [ "$pdh_4" -eq "$pdh_4" ] 2> /dev/null; then
 248                         echo "Unable to connect IPv4"
 249                         uqmi -s -d "$device" --set-client-id wds,"$cid_4" --release-client-id wds > /dev/null 2>&1
 250                         proto_notify_error "$interface" CALL_FAILED
 251                         return 1
 252                 fi
 253
 254                 # Check data connection state
 255                 connstat=$(uqmi -s -d "$device" --get-data-status)
 256                 [ "$connstat" == '"connected"' ] || {
 257                         echo "No data link!"
 258                         uqmi -s -d "$device" --set-client-id wds,"$cid_4" --release-client-id wds > /dev/null 2>&1
 259                         proto_notify_error "$interface" CALL_FAILED
 260                         return 1
 261                 }
 262         }
 263
 264         [ "$pdptype" = "ipv6" -o "$pdptype" = "ipv4v6" ] && {
 265                 cid_6=$(uqmi -s -d "$device" --get-client-id wds)
 266                 if ! [ "$cid_6" -eq "$cid_6" ] 2> /dev/null; then
 267                         echo "Unable to obtain client ID"
 268                         proto_notify_error "$interface" NO_CID
 269                         return 1
 270                 fi
 271
 272                 uqmi -s -d "$device" --set-client-id wds,"$cid_6" --set-ip-family ipv6 > /dev/null 2>&1
 273
 274                 pdh_6=$(uqmi -s -d "$device" --set-client-id wds,"$cid_6" \
 275                         --start-network \
 276                         ${apn:+--apn $apn} \
 277                         ${profile:+--profile $profile} \
 278                         ${auth:+--auth-type $auth} \
 279                         ${username:+--username $username} \
 280                         ${password:+--password $password} \
 281                         ${autoconnect:+--autoconnect})
 282
 283                 # pdh_6 is a numeric value on success
 284                 if ! [ "$pdh_6" -eq "$pdh_6" ] 2> /dev/null; then
 285                         echo "Unable to connect IPv6"
 286                         uqmi -s -d "$device" --set-client-id wds,"$cid_6" --release-client-id wds > /dev/null 2>&1
 287                         proto_notify_error "$interface" CALL_FAILED
 288                         return 1
 289                 fi
 290
 291                 # Check data connection state
 292                 connstat=$(uqmi -s -d "$device" --get-data-status)
 293                 [ "$connstat" == '"connected"' ] || {
 294                         echo "No data link!"
 295                         uqmi -s -d "$device" --set-client-id wds,"$cid_6" --release-client-id wds > /dev/null 2>&1
 296                         proto_notify_error "$interface" CALL_FAILED
 297                         return 1
 298                 }
 299         }
 300
 301         echo "Setting up $ifname"
 302         proto_init_update "$ifname" 1
 303         proto_set_keep 1
 304         proto_add_data
 305         [ -n "$pdh_4" ] && {
 306                 json_add_string "cid_4" "$cid_4"
 307                 json_add_string "pdh_4" "$pdh_4"
 308         }
 309         [ -n "$pdh_6" ] && {
 310                 json_add_string "cid_6" "$cid_6"
 311                 json_add_string "pdh_6" "$pdh_6"
 312         }
 313         proto_close_data
 314         proto_send_update "$interface"
 315
 316         local zone="$(fw3 -q network "$interface" 2>/dev/null)"
 317
 318         [ -n "$pdh_6" ] && {
 319                 if [ -z "$dhcpv6" -o "$dhcpv6" = 0 ]; then
 320                         json_load "$(uqmi -s -d $device --set-client-id wds,$cid_6 --get-current-settings)"
 321                         json_select ipv6
 322                         json_get_var ip_6 ip
 323                         json_get_var gateway_6 gateway
 324                         json_get_var dns1_6 dns1
 325                         json_get_var dns2_6 dns2
 326                         json_get_var ip_prefix_length ip-prefix-length
 327
 328                         proto_init_update "$ifname" 1
 329                         proto_set_keep 1
 330                         proto_add_ipv6_address "$ip_6" "128"
 331                         proto_add_ipv6_prefix "${ip_6}/${ip_prefix_length}"
 332                         proto_add_ipv6_route "$gateway_6" "128"
 333                         [ "$defaultroute" = 0 ] || proto_add_ipv6_route "::0" 0 "$gateway_6" "" "" "${ip_6}/${ip_prefix_length}"
 334                         [ "$peerdns" = 0 ] || {
 335                                 proto_add_dns_server "$dns1_6"
 336                                 proto_add_dns_server "$dns2_6"
 337                         }
 338                         [ -n "$zone" ] && {
 339                                 proto_add_data
 340                                 json_add_string zone "$zone"
 341                                 proto_close_data
 342                         }
 343                         proto_send_update "$interface"
 344                 else
 345                         json_init
 346                         json_add_string name "${interface}_6"
 347                         json_add_string ifname "@$interface"
 348                         json_add_string proto "dhcpv6"
 349                         [ -n "$ip6table" ] && json_add_string ip6table "$ip6table"
 350                         proto_add_dynamic_defaults
 351                         # RFC 7278: Extend an IPv6 /64 Prefix to LAN
 352                         json_add_string extendprefix 1
 353                         [ -n "$zone" ] && json_add_string zone "$zone"
 354                         json_close_object
 355                         ubus call network add_dynamic "$(json_dump)"
 356                 fi
 357         }
 358
 359         [ -n "$pdh_4" ] && {
 360                 if [ "$dhcp" = 0 ]; then
 361                         json_load "$(uqmi -s -d $device --set-client-id wds,$cid_4 --get-current-settings)"
 362                         json_select ipv4
 363                         json_get_var ip_4 ip
 364                         json_get_var gateway_4 gateway
 365                         json_get_var dns1_4 dns1
 366                         json_get_var dns2_4 dns2
 367                         json_get_var subnet_4 subnet
 368
 369                         proto_init_update "$ifname" 1
 370                         proto_set_keep 1
 371                         proto_add_ipv4_address "$ip_4" "$subnet_4"
 372                         proto_add_ipv4_route "$gateway_4" "128"
 373                         [ "$defaultroute" = 0 ] || proto_add_ipv4_route "0.0.0.0" 0 "$gateway_4"
 374                         [ "$peerdns" = 0 ] || {
 375                                 proto_add_dns_server "$dns1_4"
 376                                 proto_add_dns_server "$dns2_4"
 377                         }
 378                         [ -n "$zone" ] && {
 379                                 proto_add_data
 380                                 json_add_string zone "$zone"
 381                                 proto_close_data
 382                         }
 383                         proto_send_update "$interface"
 384                 else
 385                         json_init
 386                         json_add_string name "${interface}_4"
 387                         json_add_string ifname "@$interface"
 388                         json_add_string proto "dhcp"
 389                         [ -n "$ip4table" ] && json_add_string ip4table "$ip4table"
 390                         proto_add_dynamic_defaults
 391                         [ -n "$zone" ] && json_add_string zone "$zone"
 392                         json_close_object
 393                         ubus call network add_dynamic "$(json_dump)"
 394                 fi
 395         }
 396 }
 397
 398 qmi_wds_stop() {
 399         local cid="$1"
 400         local pdh="$2"
 401
 402         [ -n "$cid" ] || return
 403
 404         uqmi -s -d "$device" --set-client-id wds,"$cid" \
 405                 --stop-network 0xffffffff \
 406                 --autoconnect > /dev/null 2>&1
 407
 408         [ -n "$pdh" ] && {
 409                 uqmi -s -d "$device" --set-client-id wds,"$cid" \
 410                         --stop-network "$pdh" > /dev/null 2>&1
 411         }
 412
 413         uqmi -s -d "$device" --set-client-id wds,"$cid" \
 414                 --release-client-id wds > /dev/null 2>&1
 415 }
 416
 417 proto_qmi_teardown() {
 418         local interface="$1"
 419
 420         local device cid_4 pdh_4 cid_6 pdh_6
 421         json_get_vars device
 422
 423         [ -n "$ctl_device" ] && device=$ctl_device
 424
 425         echo "Stopping network $interface"
 426
 427         json_load "$(ubus call network.interface.$interface status)"
 428         json_select data
 429         json_get_vars cid_4 pdh_4 cid_6 pdh_6
 430
 431         qmi_wds_stop "$cid_4" "$pdh_4"
 432         qmi_wds_stop "$cid_6" "$pdh_6"
 433
 434         proto_init_update "*" 0
 435         proto_send_update "$interface"
 436 }
 437
 438 [ -n "$INCLUDE_ONLY" ] || {
 439         add_protocol qmi
 440 }