Bluetooth: Add Bluetooth shell sample application

Bluetooth shell sample application make use of serial console shell
and register Bluetooth commands to it. It shows example how console
shell might be used.

Change-Id: I98340422b90e85dc7a2c44823536121999a08952
Co-authored-by: Johan Hedberg <johan.hedberg@intel.com>
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>

samples/bluetooth/shell/Makefile

@@ -0,0 +1,50 @@
+# Makefile - Bluetooth shell Makefile for microkernel
+
+#
+# Copyright (c) 2015 Intel Corporation
+#
+# 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.
+#
+# 3) Neither the name of Intel Corporation nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
+#
+
+# DESCRIPTION
+# Makefile for the console shell with Bluetooth commands
+
+include $(subst \,/,${VXMICRO_BASE})/make/env/defs.base
+
+# default BSP
+BSP ?= generic_pc
+
+PRJ_CONF = prj_${vARCH}.conf
+VPFILE = prj.vpf
+
+# console handler
+PRJ_INCPATH += ${vBASE}/include/drivers
+
+# UART for Bluetooth
+QEMU_EXTRA_FLAGS += -serial unix:/tmp/bt-server-bredr
+
+include ${vMAKE}/target/make.ukernel

samples/bluetooth/shell/prj.vpf

@@ -0,0 +1,5 @@
+% Application       : Bluetooth Shell
+
+% TASK NAME         PRIO ENTRY           STACK GROUPS
+% ===================================================
+  TASK MAIN            7 mainloop        2048 [EXE]

samples/bluetooth/shell/prj_x86.conf

@@ -0,0 +1,4 @@
+CONFIG_TEST_RANDOM_GENERATOR=y
+CONFIG_BLUETOOTH=y
+CONFIG_BLUETOOTH_UART=y
+CONFIG_CONSOLE_HANDLER=y

samples/bluetooth/shell/src/btshell.c

@@ -0,0 +1,181 @@
+/* btshell.c - Bluetooth shell */
+
+/*
+ * Copyright (c) 2015 Intel Corporation
+ *
+ * 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.
+ *
+ * 3) Neither the name of Intel Corporation nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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 <stdio.h>
+#include <string.h>
+
+#include <nanokernel.h>
+
+#include <console/uart_console.h>
+#include <misc/printk.h>
+
+#include "btshell.h"
+
+/* Static command array, commands identified by string cmd_name,
+ * which shall be allocated in the caller
+ * TODO: Check possibility of using statically allocated array
+ */
+#define MAX_CMD_NUM	20
+/* After last command there is zero entry to make it possible to
+ * use statically initialized arrays with last zero entry.
+ */
+static struct {
+	const char *cmd_name;
+	cmd_function_t cb;
+} commands[MAX_CMD_NUM + 1];
+
+static uint8_t last_cmd_index = 0;
+
+static const char *prompt;
+
+#define STACKSIZE 512
+static char stack[STACKSIZE];
+
+#define MAX_CMD_QUEUED 3
+static struct uart_console_input buf[MAX_CMD_QUEUED];
+
+static struct nano_fifo avail_queue;
+static struct nano_fifo cmds_queue;
+
+static void line_queue_init(void)
+{
+	int i;
+
+	for (i = 0; i < MAX_CMD_QUEUED; i++) {
+		nano_fifo_put(&avail_queue, &buf[i]);
+	}
+}
+
+void shell_cmd_register(const char *string, cmd_function_t cb)
+{
+	if (last_cmd_index > MAX_CMD_NUM - 1) {
+		return;
+	}
+
+	commands[last_cmd_index].cmd_name = string;
+	commands[last_cmd_index].cb = cb;
+
+	last_cmd_index++;
+}
+
+static size_t parse_string(char *p)
+{
+	size_t argc = 0;
+
+	while ((p = strchr(p, ' '))) {
+		*p++ = '\0';
+		argc++;
+	}
+
+	return argc;
+}
+
+static cmd_function_t get_cb(const char *string)
+{
+	int i;
+
+	for (i = 0; commands[i].cmd_name; i++) {
+		if (!strncmp(string, commands[i].cmd_name, strlen(string))) {
+			return commands[i].cb;
+		}
+	}
+
+	return NULL;
+}
+
+static int show_commands(int argc, const char *argv)
+{
+	int i;
+
+	printk("Available commands:\n");
+
+	for (i = 0; commands[i].cmd_name; i++) {
+		printk("%s\n", commands[i].cmd_name);
+	}
+
+	return 0;
+}
+
+static void shell(int arg1, int arg2)
+{
+	while (1) {
+		struct uart_console_input *cmd;
+		cmd_function_t cb;
+		size_t argc;
+
+		printk(prompt);
+
+		cmd = nano_fiber_fifo_get_wait(&cmds_queue);
+
+		argc = parse_string(cmd->line);
+
+		/* NOTE: example of using command line and arguments
+		 *
+		 * for (int i = 0; i <= argc; i++) {
+		 *	printk("%s: arg %d: %s\n", __func__, i, p);
+		 *	p += strlen(p) + 1;
+		 * }
+		 */
+
+		cb = get_cb(cmd->line);
+		if (!cb) {
+			printk("%s Unrecognozed command: %s\n",
+			       prompt, cmd->line);
+			nano_fiber_fifo_put(&avail_queue, cmd);
+			continue;
+		}
+
+		/* Execute callback with arguments */
+		cb(argc, cmd->line);
+
+		nano_fiber_fifo_put(&avail_queue, cmd);
+	}
+}
+
+void shell_init(const char *str)
+{
+	nano_fifo_init(&cmds_queue);
+	nano_fifo_init(&avail_queue);
+
+	memset(commands, 0, sizeof(commands));
+	line_queue_init();
+
+	prompt = str ? str : "";
+
+	/* Built-in command init */
+	shell_cmd_register("help", show_commands);
+
+	task_fiber_start(stack, STACKSIZE, shell, 0, 0, 7, 0);
+
+	/* Register serial console handler */
+	uart_register_input(&avail_queue, &cmds_queue);
+}

samples/bluetooth/shell/src/btshell.h

@@ -0,0 +1,52 @@
+/* btshell.h - Bluetooth shell headers */
+
+/*
+ * Copyright (c) 2015 Intel Corporation
+ *
+ * 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.
+ *
+ * 3) Neither the name of Intel Corporation nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
+ */
+
+typedef int (*cmd_function_t)(int argc, const char *argv);
+
+/** @brief Initialize shell with optional prompt, NULL in case no prompt is
+ *         needed
+ *
+ *  @param prompt Prompt to be printed on serial console
+ *
+ *  @return None
+ */
+void shell_init(const char *prompt);
+
+/** @brief Register collback which would be run when string is entered in
+ *         console
+ *
+ *  @param argc Number of parameters and
+ *  @param line String of argc parameters separated by '\0'
+ *
+ *  @return None
+ */
+void shell_cmd_register(const char *string, cmd_function_t cb);

samples/bluetooth/shell/src/main.c

@@ -0,0 +1,68 @@
+/* main.c - Application main entry point */
+
+/*
+ * Copyright (c) 2015 Intel Corporation
+ *
+ * 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.
+ *
+ * 3) Neither the name of Intel Corporation nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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 <stdint.h>
+#include <stddef.h>
+
+#include <console/uart_console.h>
+#include <bluetooth/bluetooth.h>
+
+#include "btshell.h"
+
+static int cmd_init(int argc, const char *line)
+{
+	int err;
+
+	err = bt_init();
+	if (err) {
+		printk("Bluetoot init failed (err %d)\n", err);
+	} else {
+		printk("Bluetooth initialized\n");
+	}
+
+	return 0;
+}
+
+static int cmd_reset(int argc, const char *line)
+{
+	bt_hci_reset();
+
+	return 0;
+}
+
+void mainloop(void)
+{
+	shell_init("btshell> ");
+
+	shell_cmd_register("init", cmd_init);
+	shell_cmd_register("reset", cmd_reset);
+}