NetBSD/usr.sbin/btattach/btattach.c

/*	$NetBSD: btattach.c,v 1.16 2023/02/07 20:45:44 mlelstv Exp $	*/

/*-
 * Copyright (c) 2008 Iain Hibbert
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/cdefs.h>
__COPYRIGHT("@(#) Copyright (c) 2008 Iain Hibbert.  All rights reserved.");
__RCSID("$NetBSD: btattach.c,v 1.16 2023/02/07 20:45:44 mlelstv Exp $");

#include <sys/ioctl.h>
#include <sys/param.h>
#include <sys/uio.h>

#include <bluetooth.h>
#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <signal.h>
#include <termios.h>
#include <unistd.h>
#include <util.h>

#include "btattach.h"

static void sighandler(int);
__dead static void usage(void);
static void test(const char *, tcflag_t, tcflag_t);

static int sigcount = 0;	/* signals received */
static int opt_debug = 0;	/* global? */

static const struct devtype types[] = {
    {
	.name = "bcm2035",
	.line = "btuart",
	.descr = "Broadcom BCM2035",
	.init = &init_bcm2035,
	.speed = B115200,
    },
    {
	.name = "bcm43xx",
	.line = "btuart",
	.descr = "Broadcom BCM43xx",
	.init = &init_bcm43xx,
	.speed = B115200,
    },
    {
	.name = "bcm43xx-3wire",
	.line = "bth5",
	.descr = "Broadcom BCM43xx (3-wire)",
	.init = &init_bcm43xx,
	.speed = B115200,
    },
    {
	.name = "bcsp",
	.line = "bcsp",
	.descr = "Generic BlueCore Serial Protocol",
	.cflag = CRTSCTS | PARENB,
	.speed = B57600,
    },
    {
	.name = "bgb2xx",
	.line = "btuart",
	.descr = "Philips BGB2xx module",
	.init = &init_bgb2xx,
	.cflag = CRTSCTS,
	.speed = B115200,
    },
    {
	.name = "btuart",
	.line = "btuart",
	.descr = "Generic UART (the default)",
    },
    {
	.name = "csr",
	.line = "btuart",
	.descr = "Cambridge Silicon Radio based modules (not BCSP)",
	.init = &init_csr,
	.cflag = CRTSCTS,
	.speed = B57600,
    },
    {
	.name = "digi",
	.line = "btuart",
	.descr = "Digianswer based cards",
	.init = &init_digi,
	.cflag = CRTSCTS,
	.speed = B9600,
    },
    {
	.name = "ericsson",
	.line = "btuart",
	.descr = "Ericsson based modules",
	.init = &init_ericsson,
	.cflag = CRTSCTS,
	.speed = B57600,
    },
    {
	.name = "st",
	.line = "btuart",
	.descr = "ST Microelectronics minikits based on STLC2410/STLC2415",
	.init = &init_st,
	.cflag = CRTSCTS,
	.speed = B57600,
    },
    {
	.name = "stlc2500",
	.descr = "ST Microelectronics minikits based on STLC2500",
	.init = &init_stlc2500,
	.cflag = CRTSCTS,
	.speed = B115200,
    },
    {
	.name = "swave",
	.line = "btuart",
	.descr = "Silicon Wave kits",
	.init = &init_swave,
	.cflag = CRTSCTS,
	.speed = B57600,
    },
    {
	.name = "texas",
	.line = "btuart",
	.descr = "Texas Instruments",
	.cflag = CRTSCTS,
	.speed = B115200,
    },
    {
	.name = "unistone",
	.line = "btuart",
	.descr = "Infineon UniStone",
	.init = &init_unistone,
	.cflag = CRTSCTS,
	.speed = B115200,
    },
};

int
main(int argc, char *argv[])
{
	const struct devtype *type;
	struct termios tio;
	unsigned int init_speed, speed;
	tcflag_t cflag, Cflag;
	int fd, ch, tflag, i;
	const char *name;
	char *ptr;

	init_speed = 0;
	cflag = CLOCAL;
	Cflag = 0;
	tflag = 0;
	name = "btuart";

	while ((ch = getopt(argc, argv, "dFfi:oPpt")) != -1) {
		switch (ch) {
		case 'd':
			opt_debug++;
			break;

		case 'F':
			Cflag |= CRTSCTS;
			break;

		case 'f':
			cflag |= CRTSCTS;
			break;

		case 'i':
			init_speed = strtoul(optarg, &ptr, 10);
			if (ptr[0] != '\0')
				errx(EXIT_FAILURE, "invalid speed: %s", optarg);

			break;

		case 'o':
			cflag |= (PARENB | PARODD);
			break;

		case 'P':
			Cflag |= PARENB;
			break;

		case 'p':
			cflag |= PARENB;
			break;

		case 't':
			tflag = 1;
			break;

		case '?':
		default:
			usage();
		}
	}
	argc -= optind;
	argv += optind;

	if (tflag) {
		if (argc != 1)
			usage();
		test(argv[0], cflag, Cflag);
		exit(EXIT_SUCCESS);
	}

	if (argc == 3) {
		name = argv[0];
		argv++;
		argc--;
	}

	for (i = 0; ; i++) {
		if (i == __arraycount(types))
			errx(EXIT_FAILURE, "unknown type: %s", name);

		type = &types[i];
		if (strcasecmp(type->name, name) == 0)
			break;
	}

	if (argc != 2)
		usage();

	/* parse tty speed */
	speed = strtoul(argv[1], &ptr, 10);
	if (ptr[0] != '\0')
		errx(EXIT_FAILURE, "invalid speed: %s", argv[1]);

	if (init_speed == 0)
		init_speed = (type->speed ? type->speed : speed);

	/* open tty */
	if ((fd = open(argv[0], O_RDWR | O_EXLOCK, 0)) < 0)
		err(EXIT_FAILURE, "%s", argv[0]);

	/* setup tty */
	if (tcgetattr(fd, &tio) < 0)
		err(EXIT_FAILURE, "tcgetattr");

	cfmakeraw(&tio);
	tio.c_cflag |= (cflag | type->cflag);
	tio.c_cflag &= ~Cflag;

	if (cfsetspeed(&tio, init_speed) < 0
	    || tcsetattr(fd, TCSANOW, &tio) < 0
	    || tcflush(fd, TCIOFLUSH) < 0)
		err(EXIT_FAILURE, "tty setup failed");

	/* initialize device */
	if (type->init != NULL)
		(*type->init)(fd, speed);

	if (speed != init_speed) {
		if (cfsetspeed(&tio, speed) < 0
		    || tcsetattr(fd, TCSANOW, &tio) < 0)
			err(EXIT_FAILURE, "tty setup failed");
	}

	/* start line discipline */
	if (ioctl(fd, TIOCSLINED, type->line) < 0)
		err(EXIT_FAILURE, "%s", type->line);

	if (opt_debug == 0 && daemon(0, 0) < 0)
		warn("detach failed!");

	/* store PID in "/var/run/btattach-{tty}.pid" */
	ptr = strrchr(argv[0], '/');
	asprintf(&ptr, "%s-%s", getprogname(), (ptr ? ptr + 1 : argv[0]));
	if (ptr == NULL || pidfile(ptr) < 0)
		warn("no pidfile");

	free(ptr);

	(void)signal(SIGHUP, sighandler);
	(void)signal(SIGINT, sighandler);
	(void)signal(SIGTERM, sighandler);
	(void)signal(SIGTSTP, sighandler);
	(void)signal(SIGUSR1, sighandler);
	(void)signal(SIGUSR2, sighandler);

	while (sigcount == 0)
		select(0, NULL, NULL, NULL, NULL);

	return EXIT_SUCCESS;
}

static void
usage(void)
{
	size_t i;

	fprintf(stderr,
		"Usage: %s [-dFfoPp] [-i speed] [type] tty speed\n"
		"       %s -t [-dFfoPp] tty\n"
		"\n"
		"Where:\n"
		"\t-d          debug mode (no detach, dump io)\n"
		"\t-F          disable flow control\n"
		"\t-f          enable flow control\n"
		"\t-i speed    init speed\n"
		"\t-o          odd parity\n"
		"\t-P          no parity\n"
		"\t-p          even parity\n"
		"\t-t          test mode\n"
		"\n"
		"Known types:\n"
		"", getprogname(), getprogname());

	for (i = 0; i < __arraycount(types); i++)
		fprintf(stderr, "\t%-12s%s\n", types[i].name, types[i].descr);

	exit(EXIT_FAILURE);
}

static void
sighandler(int s)
{

	sigcount++;
}

static void
timeout(int s)
{

}

static void
hexdump(uint8_t *ptr, size_t len)
{

	while (len--)
		printf(" %2.2x", *ptr++);
}

/*
 * send HCI comamnd
 */
int
uart_send_cmd(int fd, uint16_t opcode, void *buf, size_t len)
{
	struct iovec iov[2];
	hci_cmd_hdr_t hdr;
	int r;
	struct sigaction oaction, taction;

	hdr.type = HCI_CMD_PKT;
	hdr.opcode = htole16(opcode);
	hdr.length = len;

	iov[0].iov_base = &hdr;
	iov[0].iov_len = sizeof(hdr);
	iov[1].iov_base = buf;
	iov[1].iov_len = len;

	if (opt_debug) {
		printf("<<");
		hexdump(iov[0].iov_base, iov[0].iov_len);
		hexdump(iov[1].iov_base, iov[1].iov_len);
		printf("\n");
		fflush(stdout);
	}

	if (writev(fd, iov, __arraycount(iov)) < 0)
		err(EXIT_FAILURE, "writev");

	taction.sa_handler = timeout,
	sigemptyset(&taction.sa_mask);
	taction.sa_flags = 0,

	sigaction(SIGALRM, &taction, &oaction);
	alarm(1);
	r = tcdrain(fd);
	alarm(0);
	sigaction(SIGALRM, &oaction, NULL);

	return r;
}

/*
 * get next character
 * store in iovec and inc counter if it fits
 */
static uint8_t
uart_getc(int fd, struct iovec *iov, int ioc, size_t *count)
{
	uint8_t ch, *b;
	ssize_t n;
	size_t off;

	n = read(fd, &ch, sizeof(ch));
	if (n < 0)
		err(EXIT_FAILURE, "read");

	if (n == 0)
		errx(EXIT_FAILURE, "eof");

	if (opt_debug)
		printf(" %2.2x", ch);

	off = *count;
	while (ioc > 0) {
		if (iov->iov_len > off) {
			b = iov->iov_base;
			b[off] = ch;
			*count += 1;
			break;
		}

		off -= iov->iov_len;
		iov++;
		ioc--;
	}

	return ch;
}

/*
 * read next packet, storing into iovec
 */
static size_t
uart_recv_pkt(int fd, struct iovec *iov, int ioc)
{
	size_t count, want;
	uint8_t type;

	if (opt_debug)
		printf(">>");

	count = 0;
	type = uart_getc(fd, iov, ioc, &count);
	switch(type) {
	case HCI_EVENT_PKT:
		(void)uart_getc(fd, iov, ioc, &count);	/* event */
		want = uart_getc(fd, iov, ioc, &count);
		break;

	case HCI_ACL_DATA_PKT:
		(void)uart_getc(fd, iov, ioc, &count);	/* handle LSB */
		(void)uart_getc(fd, iov, ioc, &count);	/* handle MSB */
		want = uart_getc(fd, iov, ioc, &count) |	/* LSB */
		  uart_getc(fd, iov, ioc, &count) << 8;		/* MSB */
		break;

	case HCI_SCO_DATA_PKT:
		(void)uart_getc(fd, iov, ioc, &count);	/* handle LSB */
		(void)uart_getc(fd, iov, ioc, &count);	/* handle MSB */
		want = uart_getc(fd, iov, ioc, &count);
		break;

	default: /* out of sync? */
		errx(EXIT_FAILURE, "unknown packet type 0x%2.2x", type);
	}

	while (want-- > 0)
		(void)uart_getc(fd, iov, ioc, &count);

	if (opt_debug)
		printf("\n");

	return count;
}

/*
 * read next matching event packet to buffer
 */
size_t
uart_recv_ev(int fd, uint8_t event, void *buf, size_t len)
{
	struct iovec iov[2];
	hci_event_hdr_t hdr;
	size_t n;

	iov[0].iov_base = &hdr;
	iov[0].iov_len = sizeof(hdr);
	iov[1].iov_base = buf;
	iov[1].iov_len = len;

	for (;;) {
		n = uart_recv_pkt(fd, iov, __arraycount(iov));
		if (n < sizeof(hdr)
		    || hdr.type != HCI_EVENT_PKT
		    || hdr.event != event)
			continue;

		n -= sizeof(hdr);
		break;
	}

	return n;
}

/*
 * read next matching command_complete event to buffer
 */
size_t
uart_recv_cc(int fd, uint16_t opcode, void *buf, size_t len)
{
	struct iovec iov[3];
	hci_event_hdr_t hdr;
	hci_command_compl_ep cc;
	size_t n;

	iov[0].iov_base = &hdr;
	iov[0].iov_len = sizeof(hdr);
	iov[1].iov_base = &cc;
	iov[1].iov_len = sizeof(cc);
	iov[2].iov_base = buf;
	iov[2].iov_len = len;

	for (;;) {
		n = uart_recv_pkt(fd, iov, __arraycount(iov));
		if (n < sizeof(hdr)
		    || hdr.type != HCI_EVENT_PKT
		    || hdr.event != HCI_EVENT_COMMAND_COMPL)
			continue;

		n -= sizeof(hdr);
		if (n < sizeof(cc)
		    || cc.opcode != htole16(opcode))
			continue;

		n -= sizeof(cc);
		break;
	}

	return n;
}

static void
test(const char *tty, tcflag_t cflag, tcflag_t Cflag)
{
	struct termios tio;
	int fd, guessed;
	size_t i, j, k;
	ssize_t n;
	unsigned char buf[32];
	const int bauds[] = {
		 57600,		/* BCSP specific default */
		921600,		/* latest major baud rate */
		115200,		/* old major baud rate */

		460800,
		230400,
//		 76800,
		 28800,
		 38400,
		 19200,
		 14400,
		  9600,
		  7200,
		  4800,
		  2400,
		  1800,
		  1200,
		   600,
		   300,
		   200,
		   150,
		   134,
		   110,
		    75,
		    50,
	};
	const unsigned char bcsp_lepkt[] =
	    /* ESC  ------- header -------  --- link establish ---   ESC */
	    { 0xc0, 0x00, 0x41, 0x00, 0xbe, 0xda, 0xdc, 0xed, 0xed, 0xc0 };

	printf("test mode\n");

	/* open tty */
	if ((fd = open(tty, O_RDWR | O_NONBLOCK | O_EXLOCK, 0)) < 0)
		err(EXIT_FAILURE, "%s", tty);

	/* setup tty */
	if (tcgetattr(fd, &tio) < 0)
		err(EXIT_FAILURE, "tcgetattr");
	cfmakeraw(&tio);
	tio.c_cflag |= (CLOCAL | CRTSCTS | PARENB);
	tio.c_cflag |= cflag;
	tio.c_cflag &= ~Cflag;

	guessed = 0;
	for (i = 0; i < __arraycount(bauds); i++) {
		if (cfsetspeed(&tio, bauds[i]) < 0
		    || tcsetattr(fd, TCSANOW, &tio) < 0
		    || tcflush(fd, TCIOFLUSH) < 0) {
			if (bauds[i] > 115200)
				continue;
			else
				err(EXIT_FAILURE, "tty setup failed");
		}

		if (opt_debug)
			printf("  try with B%d\n", bauds[i]);

		sleep(bauds[i] < 9600 ? 3 : 1);

		n = read(fd, buf, sizeof(buf));
		if (opt_debug > 1)
			printf("  %zd bytes read\n", n);
		if (n < 0) {
			if (i == 0 && errno == EAGAIN) {
				printf("This module is *maybe* supported by btuart(4).\n"
				    "you specify aproporiate <speed>.\n"
				    "  Also can specify <type> for initialize.\n");
				guessed = 1;
				break;
			}
			if (errno == EAGAIN)
				continue;

			err(EXIT_FAILURE, "read");
		} else {
			if ((size_t)n < sizeof(bcsp_lepkt))
				continue;
			for (j = 0; j < n - sizeof(bcsp_lepkt); j++) {
				for (k = 0; k < sizeof(bcsp_lepkt); k++)
					if (buf[j + k] != bcsp_lepkt[k]) {
						j += k;
						break;
					}
				if (k < sizeof(bcsp_lepkt))
					continue;

				printf(
				    "This module is supported by bcsp(4).\n"
				    "  baud rate %d\n",
				    bauds[i]);
				if (tio.c_cflag & PARENB)
					printf("  with %sparity\n",
					    tio.c_cflag & PARODD ? "odd " : "");
				guessed = 1;
				break;
			}
			if (guessed)
				break;
		}

	}

	close(fd);

	if (!guessed)
		printf("don't understand...\n");
}