1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
#!/bin/sh
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 2 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright (C) 2013-2016 Aleksander Morgado <aleksander@aleksander.es>
#
# Based on libqmi's qmi-network script
#
print_usage ()
{
echo "usage: $0 [OPTIONS] [DEVICE] [COMMAND]"
}
help ()
{
echo "Usage: mbim-network [OPTIONS] [DEVICE] [COMMAND]"
echo
echo "Simple network management of MBIM devices"
echo
echo "Commands:"
echo " start Start network connection"
echo " stop Stop network connection"
echo " status Query network connection status"
echo
echo "Options:"
echo " --profile=[PATH] Use the profile in the specified path"
echo " --help Show help options"
echo " --version Show version"
echo
echo "Notes:"
echo
echo " 1) [DEVICE] is given as the full path to the cdc-wdm character"
echo " device, e.g.:"
echo " /dev/cdc-wdm0"
echo
echo " 2) The mbim-network script requires a profile to work. Unless"
echo " explicitly specified with \`--profile', the file is assumed to"
echo " be available in the following path:"
echo " /etc/mbim-network.conf"
echo
echo " 3) The APN to use should be configured in the profile, in the"
echo " following way (e.g. assuming APN is called 'internet'):"
echo " APN=internet"
echo
echo " 4) Once the mbim-network script reports a successful connection"
echo " you still need to run a DHCP client on the associated WWAN network"
echo " interface."
echo
}
version ()
{
echo "mbim-network @VERSION@"
echo "Copyright (2013-2015) Aleksander Morgado"
echo "License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl-2.0.html>"
echo "This is free software: you are free to change and redistribute it."
echo "There is NO WARRANTY, to the extent permitted by law."
echo
}
# Basic options
if [ $# -lt 2 ]; then
if [ "$1" = "--help" ]; then
help
exit 0
elif [ "$1" = "--version" ]; then
version
exit 0
fi
echo "error: missing arguments" 1>&2
print_usage
exit 255
fi
# Defaults
PROFILE_FILE=/etc/mbim-network.conf
# Device + Command with options; options given first
while [ $# -gt 2 ]; do
OPT="$1"
shift
case "$OPT" in
"--")
break 2;;
"--profile")
if [ $# -gt 2 ]; then
PROFILE_FILE="$1"
shift
else
PROFILE_FILE=""
fi
;;
"--profile="*)
PROFILE_FILE="${OPT#*=}";;
*)
echo >&2 "Invalid option: $OPT"
print_usage
exit 255;;
esac
done
if [ -z "$PROFILE_FILE" ]; then
echo "error: empty profile path given" 1>&2
print_usage
exit 255
fi
if [ $# -ne 2 ] || [[ $1 == --* ]] || [[ $2 == --* ]]; then
echo "error: missing arguments" 1>&2
print_usage
exit 255
fi
DEVICE=$1
COMMAND=$2
STATE_FILE=/tmp/mbim-network-state-`basename $DEVICE`
load_profile ()
{
if [ -f "$PROFILE_FILE" ]; then
echo "Loading profile at ${PROFILE_FILE}..."
. $PROFILE_FILE
if [ "x$APN" != "x" ]; then
echo " APN: $APN"
fi
else
echo "Profile at '$PROFILE_FILE' not found..."
fi
}
save_state ()
{
KEY=$1
VAL=$2
echo "Saving state at ${STATE_FILE}... ($KEY: $VAL)"
if [ -f "$STATE_FILE" ]; then
PREVIOUS=`cat $STATE_FILE`
PREVIOUS=`echo "$PREVIOUS" | grep -v $KEY`
if [ "x$PREVIOUS" != "x" ]; then
echo $PREVIOUS > $STATE_FILE
else
rm $STATE_FILE
fi
fi
if [ "x$VAL" != "x" ]; then
echo "$KEY=\"$VAL\"" >> $STATE_FILE
fi
}
load_state ()
{
if [ -f "$STATE_FILE" ]; then
echo "Loading previous state from ${STATE_FILE}..."
. $STATE_FILE
if [ "x$TRID" != "x" ]; then
echo " Previous Transaction ID: $TRID"
fi
fi
}
clear_state ()
{
echo "Clearing state at ${STATE_FILE}..."
rm -f $STATE_FILE
}
#
# $ sudo mbimcli -d /dev/cdc-wdm0 --connect="Internet" --no-close
# [/dev/cdc-wdm0] Successfully connected
# [/dev/cdc-wdm0] Connection status:
# Session ID: '0'
# Activation state: 'activated'
# Voice call state: 'none'
# IP type: 'ipv4'
# Context type: 'internet'
# Network error: 'unknown'
#
connect ()
{
# Always try to connect using a fresh session
if [ "x$TRID" != "x" ]; then
mbimcli -d $DEVICE --no-open=$TRID
clear_state
fi
SUBSCRIBER_READY_CMD="mbimcli -d $DEVICE --query-subscriber-ready-status --no-close"
echo "Querying subscriber ready status '$SUBSCRIBER_READY_CMD'..."
SUBSCRIBER_READY_OUT=`$SUBSCRIBER_READY_CMD`
echo $SUBSCRIBER_READY_OUT
# Save the new TRID
TRID=`echo "$SUBSCRIBER_READY_OUT" | sed -n "s/.*TRID.*'\(.*\)'.*/\1/p"`
if [ "x$TRID" != "x" ]; then
save_state "TRID" $TRID
fi
REGISTRATION_STATE_CMD="mbimcli -d $DEVICE --query-registration-state --no-open=$TRID --no-close"
echo "Querying registration state '$REGISTRATION_STATE_CMD'..."
REGISTRATION_STATE_OUT=`$REGISTRATION_STATE_CMD`
echo $REGISTRATION_STATE_OUT
# Save the new TRID
TRID=`echo "$REGISTRATION_STATE_OUT" | sed -n "s/.*TRID.*'\(.*\)'.*/\1/p"`
if [ "x$TRID" != "x" ]; then
save_state "TRID" $TRID
fi
ATTACH_CMD="mbimcli -d $DEVICE --attach-packet-service --no-open=$TRID --no-close"
echo "Attaching to packet service with '$ATTACH_CMD'..."
ATTACH_OUT=`$ATTACH_CMD`
# Save the new TRID
TRID=`echo "$ATTACH_OUT" | sed -n "s/.*TRID.*'\(.*\)'.*/\1/p"`
if [ "x$TRID" != "x" ]; then
save_state "TRID" $TRID
fi
CONNECT_CMD="mbimcli -d $DEVICE --connect=$APN --no-open=$TRID --no-close"
echo "Starting network with '$CONNECT_CMD'..."
CONNECT_OUT=`$CONNECT_CMD`
if [ $? -eq 0 ]; then
echo "Network started successfully"
else
echo "Network start failed"
echo $CONNECT_OUT
fi
# Save the new TRID
TRID=`echo "$CONNECT_OUT" | sed -n "s/.*TRID.*'\(.*\)'.*/\1/p"`
if [ "x$TRID" != "x" ]; then
save_state "TRID" $TRID
fi
}
#
# $ sudo mbimcli -d /dev/cdc-wdm0 --disconnect="0"
# [/dev/cdc-wdm0] Successfully disconnected
# [/dev/cdc-wdm0] Connection status:
# Session ID: '0'
# Activation state: 'deactivated'
# Voice call state: 'none'
# IP type: 'default'
# Context type: 'internet'
# Network error: 'unknown'
#
disconnect ()
{
# Always close the session when disconnecting
if [ "x$TRID" != "x" ]; then
DISCONNECT_CMD="mbimcli -d $DEVICE --disconnect --no-open=$TRID"
else
DISCONNECT_CMD="mbimcli -d $DEVICE --disconnect"
fi
echo "Stopping network with '$DISCONNECT_CMD'..."
DISCONNECT_OUT=`$DISCONNECT_CMD`
if [ $? -eq 0 ]; then
echo "Network stopped successfully"
else
echo "Network stop failed"
echo $DISCONNECT_OUT
fi
clear_state
}
#
# $ sudo mbimcli -d /dev/cdc-wdm0 --query-connection-state --no-close
# [/dev/cdc-wdm0] Connection status:
# Session ID: '0'
# Activation state: 'deactivated'
# Voice call state: 'none'
# IP type: 'default'
# Context type: 'none'
# Network error: 'unknown'
#
status ()
{
if [ "x$TRID" != "x" ]; then
STATUS_CMD="mbimcli -d $DEVICE --query-connection-state --no-close --no-open=$TRID"
else
STATUS_CMD="mbimcli -d $DEVICE --query-connection-state"
fi
echo "Getting status with '$STATUS_CMD'..."
STATUS_OUT=`$STATUS_CMD`
# Save the new TRID
TRID=`echo "$STATUS_OUT" | sed -n "s/.*TRID.*'\(.*\)'.*/\1/p"`
if [ "x$TRID" != "x" ]; then
save_state "TRID" $TRID
fi
CONN=`echo "$STATUS_OUT" | sed -n "s/.*Activation state:.*'\(.*\)'.*/\1/p"`
if [ "x$CONN" = "x" ]; then
echo "error: couldn't get connection status" 1>&2
exit 2
else
echo "Status: $CONN"
if [ "x$CONN" != "xconnected" ]; then
exit 64
fi
fi
}
# Main
# Load profile, if any
load_profile
# Load previous state, if any
load_state
# Process commands
case $COMMAND in
"start")
connect
;;
"stop")
disconnect
;;
"status")
status
;;
*)
echo "error: unexpected command '$COMMAND'" 1>&2
print_usage
exit 255
;;
esac
exit 0
|