Home | History | Annotate | Line # | Download | only in umbctl
umbctl.c revision 1.2.4.3 
      1 /* $NetBSD: umbctl.c,v 1.2.4.3 2020/04/08 14:07:21 martin Exp $ */
      2 /*
      3  * Copyright (c) 2018 Pierre Pronchery <khorben (at) defora.org>
      4  *
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
     17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     19  * IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
     20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     26  */
     27 
     28 
     29 
     30 #include <sys/endian.h>
     31 #include <sys/ioctl.h>
     32 #include <sys/socket.h>
     33 
     34 #include <net/if.h>
     35 
     36 #include <ctype.h>
     37 #include <errno.h>
     38 #include <stdarg.h>
     39 #include <stdio.h>
     40 #include <string.h>
     41 #include <unistd.h>
     42 
     43 #include <dev/usb/mbim.h>
     44 #include <dev/usb/if_umbreg.h>
     45 
     46 
     47 /* constants */
     48 static const struct umb_valdescr _umb_regstate[] =
     49 	MBIM_REGSTATE_DESCRIPTIONS;
     50 
     51 static const struct umb_valdescr _umb_dataclass[] =
     52 	MBIM_DATACLASS_DESCRIPTIONS;
     53 
     54 static const struct umb_valdescr _umb_state[] =
     55 	UMB_INTERNAL_STATE_DESCRIPTIONS;
     56 
     57 static const struct umb_valdescr _umb_regmode[] =
     58 {
     59 	{ MBIM_REGMODE_UNKNOWN, "unknown" },
     60 	{ MBIM_REGMODE_AUTOMATIC, "automatic" },
     61 	{ MBIM_REGMODE_MANUAL, "manual" },
     62 	{ 0, NULL }
     63 };
     64 
     65 static const struct umb_valdescr _umb_ber[] =
     66 {
     67 	{ UMB_BER_EXCELLENT, "excellent" },
     68 	{ UMB_BER_VERYGOOD, "very good" },
     69 	{ UMB_BER_GOOD, "good" },
     70 	{ UMB_BER_OK, "ok" },
     71 	{ UMB_BER_MEDIUM, "medium" },
     72 	{ UMB_BER_BAD, "bad" },
     73 	{ UMB_BER_VERYBAD, "very bad" },
     74 	{ UMB_BER_EXTREMELYBAD, "extremely bad" },
     75 	{ 0, NULL }
     76 };
     77 
     78 
     79 /* prototypes */
     80 static int _char_to_utf16(const char * in, uint16_t * out, size_t outlen);
     81 static int _error(int ret, char const * format, ...);
     82 static int _umbctl(char const * ifname, int verbose, int argc, char * argv[]);
     83 static int _umbctl_file(char const * ifname, char const * filename,
     84 		int verbose);
     85 static void _umbctl_info(char const * ifname, struct umb_info * umbi);
     86 static int _umbctl_ioctl(char const * ifname, int fd, unsigned long request,
     87 		struct ifreq * ifr);
     88 static int _umbctl_set(char const * ifname, struct umb_parameter * umbp,
     89 		int argc, char * argv[]);
     90 static int _umbctl_socket(void);
     91 static int _usage(void);
     92 static void _utf16_to_char(uint16_t *in, int inlen, char *out, size_t outlen);
     93 
     94 
     95 /* functions */
     96 /* char_to_utf16 */
     97 /* this function is from OpenBSD's ifconfig(8) */
     98 static int _char_to_utf16(const char * in, uint16_t * out, size_t outlen)
     99 {
    100 	int	n = 0;
    101 	uint16_t c;
    102 
    103 	for (;;) {
    104 		c = *in++;
    105 
    106 		if (c == '\0') {
    107 			/*
    108 			 * NUL termination is not required, but zero out the
    109 			 * residual buffer
    110 			 */
    111 			memset(out, 0, outlen);
    112 			return n;
    113 		}
    114 		if (outlen < sizeof(*out))
    115 			return -1;
    116 
    117 		*out++ = htole16(c);
    118 		n += sizeof(*out);
    119 		outlen -= sizeof(*out);
    120 	}
    121 }
    122 
    123 
    124 /* error */
    125 __printflike(2, 3) static int _error(int ret, char const * format, ...)
    126 {
    127 	va_list ap;
    128 
    129 	fputs("umbctl: ", stderr);
    130 	va_start(ap, format);
    131 	vfprintf(stderr, format, ap);
    132 	va_end(ap);
    133 	fputs("\n", stderr);
    134 	return ret;
    135 }
    136 
    137 
    138 /* umbctl */
    139 static int _umbctl(char const * ifname, int verbose, int argc, char * argv[])
    140 {
    141 	int fd;
    142 	struct ifreq ifr;
    143 	struct umb_info umbi;
    144 	struct umb_parameter umbp;
    145 
    146 	if((fd = _umbctl_socket()) < 0)
    147 		return 2;
    148 	memset(&ifr, 0, sizeof(ifr));
    149 	strlcpy(ifr.ifr_name, ifname, sizeof(ifr.ifr_name));
    150 	if(argc != 0)
    151 	{
    152 		memset(&umbp, 0, sizeof(umbp));
    153 		ifr.ifr_data = &umbp;
    154 		if(_umbctl_ioctl(ifname, fd, SIOCGUMBPARAM, &ifr) != 0
    155 				|| _umbctl_set(ifname, &umbp, argc, argv) != 0
    156 				|| _umbctl_ioctl(ifname, fd, SIOCSUMBPARAM,
    157 					&ifr) != 0)
    158 		{
    159 			close(fd);
    160 			return 2;
    161 		}
    162 	}
    163 	if(argc == 0 || verbose > 0)
    164 	{
    165 		ifr.ifr_data = &umbi;
    166 		if(_umbctl_ioctl(ifname, fd, SIOCGUMBINFO, &ifr) != 0)
    167 		{
    168 			close(fd);
    169 			return 3;
    170 		}
    171 		_umbctl_info(ifname, &umbi);
    172 	}
    173 	if(close(fd) != 0)
    174 		return _error(2, "%s: %s", ifname, strerror(errno));
    175 	return 0;
    176 }
    177 
    178 
    179 /* umbctl_file */
    180 static int _umbctl_file(char const * ifname, char const * filename, int verbose)
    181 {
    182 	int fd;
    183 	struct ifreq ifr;
    184 	struct umb_info umbi;
    185 	struct umb_parameter umbp;
    186 	FILE * fp;
    187 	char buf[512];
    188 	int eof;
    189 	char * tokens[3] = { buf, NULL, NULL };
    190 	char * p;
    191 
    192 	if((fp = fopen(filename, "r")) == NULL)
    193 		return _error(2, "%s: %s", filename, strerror(errno));
    194 	memset(&umbp, 0, sizeof(umbp));
    195 	while(fgets(buf, sizeof(buf), fp) != NULL)
    196 	{
    197 		if(buf[0] == '#')
    198 			continue;
    199 		buf[sizeof(buf) - 1] = '\0';
    200 		if((p = strstr(buf, "=")) != NULL)
    201 		{
    202 			tokens[1] = p + 1;
    203 			*p = '\0';
    204 		} else
    205 			tokens[1] = NULL;
    206 		if(_umbctl_set(ifname, &umbp, (p != NULL) ? 2 : 1, tokens) != 0)
    207 			break;
    208 	}
    209 	eof = feof(fp);
    210 	if(fclose(fp) != 0 || !eof)
    211 		return _error(2, "%s: %s", filename, strerror(errno));
    212 	if((fd = _umbctl_socket()) < 0)
    213 		return 2;
    214 	memset(&ifr, 0, sizeof(ifr));
    215 	strlcpy(ifr.ifr_name, ifname, sizeof(ifr.ifr_name));
    216 	ifr.ifr_data = &umbp;
    217 	if(_umbctl_ioctl(ifname, fd, SIOCGUMBPARAM, &ifr) != 0
    218 			|| _umbctl_ioctl(ifname, fd, SIOCSUMBPARAM, &ifr) != 0)
    219 	{
    220 		close(fd);
    221 		return 2;
    222 	}
    223 	if(verbose > 0)
    224 	{
    225 		ifr.ifr_data = &umbi;
    226 		if(_umbctl_ioctl(ifname, fd, SIOCGUMBINFO, &ifr) != 0)
    227 		{
    228 			close(fd);
    229 			return 3;
    230 		}
    231 		_umbctl_info(ifname, &umbi);
    232 	}
    233 	if(close(fd) != 0)
    234 		return _error(2, "%s: %s", ifname, strerror(errno));
    235 	return 0;
    236 }
    237 
    238 
    239 /* umbctl_info */
    240 static void _umbctl_info(char const * ifname, struct umb_info * umbi)
    241 {
    242 	char provider[UMB_PROVIDERNAME_MAXLEN + 1];
    243 	char pn[UMB_PHONENR_MAXLEN + 1];
    244 	char roaming[UMB_ROAMINGTEXT_MAXLEN + 1];
    245 	char apn[UMB_APN_MAXLEN + 1];
    246 	char fwinfo[UMB_FWINFO_MAXLEN + 1];
    247 	char hwinfo[UMB_HWINFO_MAXLEN + 1];
    248 
    249 	_utf16_to_char(umbi->provider, UMB_PROVIDERNAME_MAXLEN,
    250 			provider, sizeof(provider));
    251 	_utf16_to_char(umbi->pn, UMB_PHONENR_MAXLEN, pn, sizeof(pn));
    252 	_utf16_to_char(umbi->roamingtxt, UMB_ROAMINGTEXT_MAXLEN,
    253 			roaming, sizeof(roaming));
    254 	_utf16_to_char(umbi->apn, UMB_APN_MAXLEN, apn, sizeof(apn));
    255 	_utf16_to_char(umbi->fwinfo, UMB_FWINFO_MAXLEN, fwinfo, sizeof(fwinfo));
    256 	_utf16_to_char(umbi->hwinfo, UMB_HWINFO_MAXLEN, hwinfo, sizeof(hwinfo));
    257 	printf("%s: state %s, mode %s, registration %s\n"
    258 			"\tprovider \"%s\", dataclass %s, signal %s\n"
    259 			"\tphone number \"%s\", roaming \"%s\" (%s)\n"
    260 			"\tAPN \"%s\", TX %" PRIu64 ", RX %" PRIu64 "\n"
    261 			"\tfirmware \"%s\", hardware \"%s\"\n",
    262 			ifname, umb_val2descr(_umb_state, umbi->state),
    263 			umb_val2descr(_umb_regmode, umbi->regmode),
    264 			umb_val2descr(_umb_regstate, umbi->regstate), provider,
    265 			umb_val2descr(_umb_dataclass, umbi->cellclass),
    266 			umb_val2descr(_umb_ber, umbi->ber), pn, roaming,
    267 			umbi->enable_roaming ? "allowed" : "denied",
    268 			apn, umbi->uplink_speed, umbi->downlink_speed,
    269 			fwinfo, hwinfo);
    270 }
    271 
    272 
    273 /* umbctl_ioctl */
    274 static int _umbctl_ioctl(char const * ifname, int fd, unsigned long request,
    275 		struct ifreq * ifr)
    276 {
    277 	if(ioctl(fd, request, ifr) != 0)
    278 		return _error(-1, "%s: %s", ifname, strerror(errno));
    279 	return 0;
    280 }
    281 
    282 
    283 /* umbctl_set */
    284 /* callbacks */
    285 static int _set_apn(char const *, struct umb_parameter *, char const *);
    286 static int _set_username(char const *, struct umb_parameter *, char const *);
    287 static int _set_password(char const *, struct umb_parameter *, char const *);
    288 static int _set_pin(char const *, struct umb_parameter *, char const *);
    289 static int _set_puk(char const *, struct umb_parameter *, char const *);
    290 static int _set_roaming_allow(char const *, struct umb_parameter *,
    291 		char const *);
    292 static int _set_roaming_deny(char const *, struct umb_parameter *,
    293 		char const *);
    294 
    295 static int _umbctl_set(char const * ifname, struct umb_parameter * umbp,
    296 		int argc, char * argv[])
    297 {
    298 	struct
    299 	{
    300 		char const * name;
    301 		int (*callback)(char const *,
    302 				struct umb_parameter *, char const *);
    303 		int parameter;
    304 	} callbacks[] =
    305 	{
    306 		{ "apn", _set_apn, 1 },
    307 		{ "username", _set_username, 1 },
    308 		{ "password", _set_password, 1 },
    309 		{ "pin", _set_pin, 1 },
    310 		{ "puk", _set_puk, 1 },
    311 		{ "roaming", _set_roaming_allow, 0 },
    312 		{ "-roaming", _set_roaming_deny, 0 },
    313 	};
    314 	int i;
    315 	size_t j;
    316 
    317 	for(i = 0; i < argc; i++)
    318 	{
    319 		for(j = 0; j < sizeof(callbacks) / sizeof(*callbacks); j++)
    320 			if(strcmp(argv[i], callbacks[j].name) == 0)
    321 			{
    322 				if(callbacks[j].parameter && i + 1 == argc)
    323 					return _error(-1, "%s: Incomplete"
    324 							" parameter", argv[i]);
    325 				if(callbacks[j].callback(ifname, umbp,
    326 							callbacks[j].parameter
    327 							? argv[i + 1] : NULL))
    328 					return -1;
    329 				if(callbacks[j].parameter)
    330 					i++;
    331 				break;
    332 			}
    333 		if(j == sizeof(callbacks) / sizeof(*callbacks))
    334 			return _error(-1, "%s: Unknown parameter", argv[i]);
    335 	}
    336 	return 0;
    337 }
    338 
    339 static int _set_apn(char const * ifname, struct umb_parameter * umbp,
    340 		char const * apn)
    341 {
    342 	umbp->apnlen = _char_to_utf16(apn, umbp->apn, sizeof(umbp->apn));
    343 	if(umbp->apnlen < 0 || (size_t)umbp->apnlen > sizeof(umbp->apn))
    344 		return _error(-1, "%s: %s", ifname, "APN too long");
    345 	return 0;
    346 }
    347 
    348 static int _set_username(char const * ifname, struct umb_parameter * umbp,
    349 		char const * username)
    350 {
    351 	umbp->usernamelen = _char_to_utf16(username, umbp->username,
    352 			sizeof(umbp->username));
    353 	if(umbp->usernamelen < 0
    354 			|| (size_t)umbp->usernamelen > sizeof(umbp->username))
    355 		return _error(-1, "%s: %s", ifname, "Username too long");
    356 	return 0;
    357 }
    358 
    359 static int _set_password(char const * ifname, struct umb_parameter * umbp,
    360 		char const * password)
    361 {
    362 	umbp->passwordlen = _char_to_utf16(password, umbp->password,
    363 			sizeof(umbp->password));
    364 	if(umbp->passwordlen < 0
    365 			|| (size_t)umbp->passwordlen > sizeof(umbp->password))
    366 		return _error(-1, "%s: %s", ifname, "Password too long");
    367 	return 0;
    368 }
    369 
    370 static int _set_pin(char const * ifname, struct umb_parameter * umbp,
    371 		char const * pin)
    372 {
    373 	umbp->is_puk = 0;
    374 	umbp->op = MBIM_PIN_OP_ENTER;
    375 	umbp->pinlen = _char_to_utf16(pin, umbp->pin, sizeof(umbp->pin));
    376 	if(umbp->pinlen < 0 || (size_t)umbp->pinlen
    377 			> sizeof(umbp->pin))
    378 		return _error(-1, "%s: %s", ifname, "PIN code too long");
    379 	return 0;
    380 }
    381 
    382 static int _set_puk(char const * ifname, struct umb_parameter * umbp,
    383 		char const * puk)
    384 {
    385 	umbp->is_puk = 1;
    386 	umbp->op = MBIM_PIN_OP_ENTER;
    387 	umbp->pinlen = _char_to_utf16(puk, umbp->pin, sizeof(umbp->pin));
    388 	if(umbp->pinlen < 0 || (size_t)umbp->pinlen > sizeof(umbp->pin))
    389 		return _error(-1, "%s: %s", ifname, "PUK code too long");
    390 	return 0;
    391 }
    392 
    393 static int _set_roaming_allow(char const * ifname, struct umb_parameter * umbp,
    394 		char const * unused)
    395 {
    396 	(void) ifname;
    397 	(void) unused;
    398 
    399 	umbp->roaming = 1;
    400 	return 0;
    401 }
    402 
    403 static int _set_roaming_deny(char const * ifname, struct umb_parameter * umbp,
    404 		char const * unused)
    405 {
    406 	(void) ifname;
    407 	(void) unused;
    408 
    409 	umbp->roaming = 0;
    410 	return 0;
    411 }
    412 
    413 
    414 /* umbctl_socket */
    415 static int _umbctl_socket(void)
    416 {
    417 	int fd;
    418 
    419 	if((fd = socket(AF_INET, SOCK_DGRAM, 0)) < 0)
    420 		return _error(-1, "socket: %s", strerror(errno));
    421 	return fd;
    422 }
    423 
    424 
    425 /* usage */
    426 static int _usage(void)
    427 {
    428 	fputs("Usage: umbctl [-v] ifname [parameter [value]] [...]\n"
    429 "       umbctl -f config-file ifname [...]\n",
    430 			stderr);
    431 	return 1;
    432 }
    433 
    434 
    435 /* utf16_to_char */
    436 static void _utf16_to_char(uint16_t *in, int inlen, char *out, size_t outlen)
    437 {
    438 	uint16_t c;
    439 
    440 	while (outlen > 0) {
    441 		c = inlen > 0 ? htole16(*in) : 0;
    442 		if (c == 0 || --outlen == 0) {
    443 			/* always NUL terminate result */
    444 			*out = '\0';
    445 			break;
    446 		}
    447 		*out++ = isascii(c) ? (char)c : '?';
    448 		in++;
    449 		inlen--;
    450 	}
    451 }
    452 
    453 
    454 /* main */
    455 int main(int argc, char * argv[])
    456 {
    457 	int o;
    458 	char const * filename = NULL;
    459 	int verbose = 0;
    460 
    461 	while((o = getopt(argc, argv, "f:v")) != -1)
    462 		switch(o)
    463 		{
    464 			case 'f':
    465 				filename = optarg;
    466 				break;
    467 			case 'v':
    468 				verbose++;
    469 				break;
    470 			default:
    471 				return _usage();
    472 		}
    473 	if(optind == argc)
    474 		return _usage();
    475 	if(filename != NULL)
    476 	{
    477 		if(optind + 1 != argc)
    478 			return _usage();
    479 		return _umbctl_file(argv[optind], filename, verbose);
    480 	}
    481 	return _umbctl(argv[optind], verbose, argc - optind - 1,
    482 			&argv[optind + 1]);
    483 }
    484