Update the copyright notice

src/modems/mbim.c

@@ -0,0 +1,434 @@
+/* $Id$ */
+/* Copyright (c) 2018-2019 Pierre Pronchery <khorben@defora.org> */
+/* This file is part of DeforaOS Desktop Phone */
+/* 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, version 3 of the License.
+ *
+ * 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, see <http://www.gnu.org/licenses/>. */
+
+
+
+#if (defined(__NetBSD__) && __NetBSD_Version__ > 899000000) \
+	|| defined(__OpenBSD__)
+#include <unistd.h>
+#ifdef DEBUG
+# include <stdio.h>
+#endif
+#include <string.h>
+#include <ctype.h>
+#include <sys/ioctl.h>
+#include <sys/socket.h>
+#include <net/if.h>
+#include <errno.h>
+#include <glib.h>
+#include <System.h>
+#include <Phone/modem.h>
+
+#include <dev/usb/mbim.h>
+#include <dev/usb/if_umbreg.h>
+
+#ifndef SIOCGUMBINFO
+# define SIOCGUMBINFO	_IOWR('i', 190, struct ifreq)	/* get MBIM info */
+#endif
+#ifndef SIOCSUMBPARAM
+# define SIOCSUMBPARAM	_IOW('i', 191, struct ifreq)	/* set MBIM param */
+#endif
+#ifndef SIOCGUMBPARAM
+# define SIOCGUMBPARAM	_IOWR('i', 192, struct ifreq)	/* get MBIM param */
+#endif
+
+
+/* MBIM */
+/* private */
+/* types */
+typedef struct _ModemPlugin
+{
+	ModemPluginHelper * helper;
+
+	int fd;
+	struct ifreq ifr;
+
+	char provider[UMB_PROVIDERNAME_MAXLEN + 1];
+
+	unsigned int source;
+} MBIM;
+
+struct umb_valenum {
+	int		 val;
+	int		 conv;
+};
+
+
+/* constants */
+static const struct umb_valdescr _mbim_dataclass[] =
+	MBIM_DATACLASS_DESCRIPTIONS;
+static const struct umb_valenum _mbim_regstate[] =
+{
+	{ MBIM_REGSTATE_UNKNOWN,	MODEM_REGISTRATION_STATUS_UNKNOWN },
+	{ MBIM_REGSTATE_SEARCHING,	MODEM_REGISTRATION_STATUS_SEARCHING },
+	{ MBIM_REGSTATE_HOME,		MODEM_REGISTRATION_STATUS_REGISTERED },
+	{ MBIM_REGSTATE_ROAMING,	MODEM_REGISTRATION_STATUS_REGISTERED },
+	{ MBIM_REGSTATE_PARTNER,	MODEM_REGISTRATION_STATUS_REGISTERED },
+	{ MBIM_REGSTATE_DENIED,		MODEM_REGISTRATION_STATUS_DENIED },
+	{ 0,				-1 }
+};
+
+
+/* variables */
+static ModemConfig _mbim_config[] =
+{
+	{ "interface",	"Interface",		MCT_STRING	},
+	{ NULL,		NULL,			MCT_NONE	},
+};
+
+
+/* prototypes */
+/* plug-in */
+static ModemPlugin * _mbim_init(ModemPluginHelper * helper);
+static void _mbim_destroy(ModemPlugin * modem);
+static int _mbim_start(ModemPlugin * modem, unsigned int retry);
+static int _mbim_stop(ModemPlugin * modem);
+static int _mbim_request(ModemPlugin * modem, ModemRequest * request);
+static int _mbim_trigger(ModemPlugin * modem, ModemEventType event);
+
+/* useful */
+static int _mbim_ioctl(ModemPlugin * modem, unsigned long request, void * data);
+
+/* callbacks */
+static gboolean _mbim_on_timeout(gpointer data);
+
+static int umb_val2enum(const struct umb_valenum *vdp, int val);
+
+static int _char_to_utf16(const char * in, uint16_t * out, size_t outlen);
+static void _utf16_to_char(uint16_t *in, int inlen, char *out, size_t outlen);
+
+
+/* public */
+/* variables */
+ModemPluginDefinition plugin =
+{
+	"MBIM",
+	"applications-development",
+	_mbim_config,
+	_mbim_init,
+	_mbim_destroy,
+	_mbim_start,
+	_mbim_stop,
+	_mbim_request,
+	_mbim_trigger
+};
+
+
+/* private */
+/* functions */
+/* mbim_init */
+static ModemPlugin * _mbim_init(ModemPluginHelper * helper)
+{
+	MBIM * mbim;
+	char const * p;
+
+	if((mbim = object_new(sizeof(*mbim))) == NULL)
+		return NULL;
+	memset(mbim, 0, sizeof(*mbim));
+	mbim->helper = helper;
+	mbim->fd = -1;
+	if((p = helper->config_get(helper->modem, "interface")) == NULL
+			|| strlen(p) == 0)
+		p = "umb0";
+	strlcpy(mbim->ifr.ifr_name, p, sizeof(mbim->ifr.ifr_name));
+	mbim->source = 0;
+	return mbim;
+}
+
+
+/* mbim_destroy */
+static void _mbim_destroy(ModemPlugin * modem)
+{
+	MBIM * mbim = modem;
+
+	_mbim_stop(modem);
+	object_delete(mbim);
+}
+
+
+/* mbim_start */
+static int _mbim_start(ModemPlugin * modem, unsigned int retry)
+{
+	MBIM * mbim = modem;
+
+#ifdef DEBUG
+	fprintf(stderr, "DEBUG: %s()\n", __func__);
+#endif
+	if(mbim->fd < 0 && (mbim->fd = socket(AF_INET, SOCK_DGRAM, 0)) < 0)
+		return -1;
+	mbim->source = g_timeout_add(1000, _mbim_on_timeout, mbim);
+	return 0;
+}
+
+
+/* mbim_stop */
+static int _mbim_stop(ModemPlugin * modem)
+{
+	MBIM * mbim = modem;
+
+#ifdef DEBUG
+	fprintf(stderr, "DEBUG: %s()\n", __func__);
+#endif
+	if(mbim->source > 0)
+		g_source_remove(mbim->source);
+	mbim->source = 0;
+	if(mbim->fd >= 0)
+		close(mbim->fd);
+	mbim->fd = -1;
+	return 0;
+}
+
+
+/* mbim_request */
+static int _request_authenticate(ModemPlugin * modem, ModemRequest * request);
+static int _request_authenticate_error(ModemPlugin * modem,
+		ModemRequest * request, char const * error, int code);
+
+static int _mbim_request(ModemPlugin * modem, ModemRequest * request)
+{
+	switch(request->type)
+	{
+		case MODEM_REQUEST_AUTHENTICATE:
+			return _request_authenticate(modem, request);
+		/* TODO implement */
+#ifndef DEBUG
+		default:
+			break;
+#endif
+	}
+	return 0;
+}
+
+static int _request_authenticate(ModemPlugin * modem, ModemRequest * request)
+{
+	struct umb_parameter umbp;
+
+#ifdef DEBUG
+	fprintf(stderr, "DEBUG: %s(%u)\n", __func__, request->type);
+#endif
+	memset(&umbp, 0, sizeof(umbp));
+	if(_mbim_ioctl(modem, SIOCGUMBPARAM, &umbp) != 0)
+		return _request_authenticate_error(modem, request,
+				strerror(errno), -errno);
+	if(strcmp(request->authenticate.name, "SIM PIN") == 0)
+	{
+		umbp.is_puk = 0;
+		umbp.op = MBIM_PIN_OP_ENTER;
+	}
+	else if(strcmp(request->authenticate.name, "SIM PUK") == 0)
+	{
+		umbp.is_puk = 1;
+		umbp.op = MBIM_PIN_OP_ENTER;
+	}
+	else
+		return -_request_authenticate_error(modem, request,
+				"Unknown authentication", 1);
+	umbp.pinlen = _char_to_utf16(request->authenticate.password, umbp.pin,
+			sizeof(umbp.pin));
+	if(umbp.pinlen < 0 || (size_t)umbp.pinlen > sizeof(umbp.pin))
+		return -_request_authenticate_error(modem, request,
+				"PIN code too long", 1);
+	if(_mbim_ioctl(modem, SIOCSUMBPARAM, &umbp) != 0)
+		return _request_authenticate_error(modem, request,
+				strerror(errno), -errno);
+	return 0;
+}
+
+static int _request_authenticate_error(ModemPlugin * modem,
+		ModemRequest * request, char const * error, int code)
+{
+	MBIM * mbim = modem;
+	ModemEvent event;
+
+#ifdef DEBUG
+	fprintf(stderr, "DEBUG: %s(%u, \"%s\", %d)\n", __func__, request->type,
+			error, code);
+#endif
+	memset(&event, 0, sizeof(event));
+	event.type = MODEM_EVENT_TYPE_AUTHENTICATION;
+	event.authentication.name = request->authenticate.name;
+	event.authentication.status = MODEM_AUTHENTICATION_STATUS_ERROR;
+	event.authentication.error = error;
+	mbim->helper->event(mbim->helper->modem, &event);
+	return mbim->helper->error(mbim->helper->modem, error, code);
+}
+
+
+/* mbim_trigger */
+static int _trigger_info(MBIM * mbim, struct umb_info * umbi);
+static int _trigger_registration(MBIM * mbim, struct umb_info * umbi);
+
+static int _mbim_trigger(ModemPlugin * modem, ModemEventType event)
+{
+	struct umb_info umbi;
+
+#ifdef DEBUG
+	fprintf(stderr, "DEBUG: %s(%u)\n", __func__, event);
+#endif
+	switch(event)
+	{
+		case MODEM_EVENT_TYPE_REGISTRATION:
+			if(_trigger_info(modem, &umbi) != 0)
+				return -1;
+			return _trigger_registration(modem, &umbi);
+		case MODEM_EVENT_TYPE_ERROR:
+			break;
+		/* TODO implement the rest */
+#ifndef DEBUG
+		default:
+			break;
+#endif
+	}
+	return -1;
+}
+
+static int _trigger_info(MBIM * mbim, struct umb_info * umbi)
+{
+	ModemEvent event;
+
+#ifdef DEBUG
+	fprintf(stderr, "DEBUG: %s()\n", __func__);
+#endif
+	if(_mbim_ioctl(mbim, SIOCGUMBINFO, umbi) != 0)
+		return mbim->helper->error(mbim->helper->modem, strerror(errno),
+				-errno);
+	if(umbi->pin_state == UMB_PIN_REQUIRED)
+	{
+		memset(&event, 0, sizeof(event));
+		event.type = MODEM_EVENT_TYPE_AUTHENTICATION;
+		event.authentication.name = "SIM PIN";
+		event.authentication.method = MODEM_AUTHENTICATION_METHOD_PIN;
+		event.authentication.status = MODEM_AUTHENTICATION_STATUS_REQUIRED;
+		event.authentication.retries = umbi->pin_attempts_left;
+		event.authentication.error = NULL;
+		mbim->helper->event(mbim->helper->modem, &event);
+	}
+	return 0;
+}
+
+static int _trigger_registration(MBIM * mbim, struct umb_info * umbi)
+{
+	ModemEvent event;
+
+#ifdef DEBUG
+	fprintf(stderr, "DEBUG: %s()\n", __func__);
+#endif
+	memset(&event, 0, sizeof(event));
+	event.type = MODEM_EVENT_TYPE_REGISTRATION;
+	event.registration.mode = MODEM_REGISTRATION_MODE_AUTOMATIC;
+	event.registration.status = umb_val2enum(_mbim_regstate,
+			umbi->regstate);
+	event.registration.media = umb_val2descr(_mbim_dataclass,
+			umbi->cellclass);
+	_utf16_to_char(umbi->provider, UMB_PROVIDERNAME_MAXLEN,
+			mbim->provider, sizeof(mbim->provider));
+	event.registration._operator = mbim->provider;
+	event.registration.signal = 0.0 / 0.0;
+	event.registration.roaming = (umbi->regstate == MBIM_REGSTATE_ROAMING)
+		? 1 : 0;
+	mbim->helper->event(mbim->helper->modem, &event);
+	return 0;
+}
+
+
+/* useful */
+/* mbim_ioctl */
+static int _mbim_ioctl(ModemPlugin * modem, unsigned long request,
+		void * data)
+{
+	MBIM * mbim = modem;
+
+	mbim->ifr.ifr_data = data;
+	if(ioctl(mbim->fd, request, &mbim->ifr) != 0)
+		return -1;
+	return 0;
+}
+
+
+/* callbacks */
+/* mbim_on_timeout */
+static gboolean _mbim_on_timeout(gpointer data)
+{
+	ModemPlugin * mbim = data;
+	ModemPluginHelper * helper = mbim->helper;
+	struct umb_info umbi;
+
+	memset(&umbi, 0, sizeof(umbi));
+	if(_mbim_ioctl(mbim, SIOCGUMBINFO, &umbi) != 0)
+	{
+		helper->error(helper->modem, strerror(errno), -errno);
+		return TRUE;
+	}
+	return TRUE;
+}
+
+
+/* char_to_utf16 */
+static int _char_to_utf16(const char * in, uint16_t * out, size_t outlen)
+{
+	int	n = 0;
+	uint16_t c;
+
+	for (;;) {
+		c = *in++;
+
+		if (c == '\0') {
+			/*
+			 * NUL termination is not required, but zero out the
+			 * residual buffer
+			 */
+			memset(out, 0, outlen);
+			return n;
+		}
+		if (outlen < sizeof(*out))
+			return -1;
+
+		*out++ = htole16(c);
+		n += sizeof(*out);
+		outlen -= sizeof(*out);
+	}
+}
+
+
+/* umb_val2enum */
+static int umb_val2enum(const struct umb_valenum *vdp, int val)
+{
+	while (vdp->conv != -1) {
+		if (vdp->val == val)
+			return vdp->conv;
+		vdp++;
+	}
+	return -1;
+}
+
+
+/* utf16_to_char */
+static void _utf16_to_char(uint16_t *in, int inlen, char *out, size_t outlen)
+{
+	uint16_t c;
+
+	while (outlen > 0) {
+		c = inlen > 0 ? htole16(*in) : 0;
+		if (c == 0 || --outlen == 0) {
+			/* always NUL terminate result */
+			*out = '\0';
+			break;
+		}
+		*out++ = isascii(c) ? (char)c : '?';
+		in++;
+		inlen--;
+	}
+}
+#endif

src/modems/project.conf

@@ -1,4 +1,4 @@
-targets=debug,hayes,osmocom,template
+targets=debug,hayes,mbim,osmocom,template
 cppflags_force=-I ../../include
 cppflags=
 cflags_force=`pkg-config --cflags glib-2.0` -fPIC
@@ -42,6 +42,13 @@ depends=hayes/quirks.h
 [hayes.h]
 install=$(INCLUDEDIR)/Desktop/Phone/modems
 
+[mbim]
+type=plugin
+sources=mbim.c
+cflags=`pkg-config --cflags libSystem`
+ldflags=`pkg-config --libs libSystem`
+install=$(LIBDIR)/Phone/modem
+
 [osmocom]
 type=plugin
 enabled=0

tests/modems.c

@@ -1,5 +1,5 @@
 /* $Id$ */
-/* Copyright (c) 2013 Pierre Pronchery <khorben@defora.org> */
+/* Copyright (c) 2013-2019 Pierre Pronchery <khorben@defora.org> */
 /* This file is part of DeforaOS Desktop Phone */
 /* 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
@@ -58,6 +58,13 @@ static int _modems(void)
 			continue;
 		if(strcmp(&de->d_name[len - sizeof(ext) + 1], ext) != 0)
 			continue;
+#if (defined(__NetBSD__) && __NetBSD_Version__ < 699000000) \
+		|| !defined(__OpenBSD__)
+		/* the MBIM plug-in may not build */
+		if(strncmp(de->d_name, "mbim.", 5) == 0
+				&& strcmp(&de->d_name[4], ext) == 0)
+			continue;
+#endif
 		if((s = malloc(sizeof(path) + len + 1)) == NULL)
 		{
 			ret += _perror(de->d_name, 1);