nuttx-apps/examples/shv-nxboot-updater/shv_nxboot_updater.c

/****************************************************************************
 * apps/examples/shv-nxboot-updater/shv_nxboot_updater.c
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <shv/tree/shv_tree.h>
#include <shv/tree/shv_file_node.h>
#include <shv/tree/shv_connection.h>
#include <shv/tree/shv_methods.h>
#include <shv/tree/shv_clayer_posix.h>
#include <shv/tree/shv_dotdevice_node.h>
#include <shv/tree/shv_dotapp_node.h>

#include <stdio.h>
#include <signal.h>
#include <time.h>
#include <unistd.h>
#include <stdlib.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include <semaphore.h>

#include <nxboot.h>
#include <nuttx/mtd/mtd.h>
#include <sys/boardctl.h>

/****************************************************************************
 * Private Function Prototypes
 ****************************************************************************/

static int shv_nxboot_opener(struct shv_file_node *item);
static int shv_fwstable_confirm(struct shv_con_ctx *shv_ctx,
                                struct shv_node *item, int rid);
static int shv_fwstable_get(struct shv_con_ctx *shv_ctx,
                            struct shv_node *item, int rid);
static void quit_handler(int signum);
static void print_help(char *name);

static struct shv_node *shv_tree_create(void);
static void attention_cb(struct shv_con_ctx *shv_ctx,
                         enum shv_attention_reason r);

/****************************************************************************
 * Private Data
 ****************************************************************************/

/* An execution barrier */

static sem_t running;

/* ------------------------- ROOT METHODS --------------------------------- */

static const struct shv_method_des * const shv_dev_root_dmap_items[] =
{
  &shv_dmap_item_dir,
  &shv_dmap_item_ls,
};

static const struct shv_dmap shv_dev_root_dmap =
  SHV_CREATE_NODE_DMAP(root, shv_dev_root_dmap_items);

/* ------------------------- fwstable METHODS ---------------------------- */

static const struct shv_method_des shv_dev_fwstable_dmap_item_confirm =
{
  .name = "confirm",
  .method = shv_fwstable_confirm
};

static const struct shv_method_des shv_dev_fwstable_dmap_item_get =
{
  .name = "get",
  .method = shv_fwstable_get
};

static const struct shv_method_des * const shv_dev_fwstable_dmap_items[] =
{
  &shv_dev_fwstable_dmap_item_confirm,
  &shv_dmap_item_dir,
  &shv_dev_fwstable_dmap_item_get,
  &shv_dmap_item_ls
};

static const struct shv_dmap shv_dev_fwstable_dmap =
  SHV_CREATE_NODE_DMAP(dotdevice, shv_dev_fwstable_dmap_items);

/****************************************************************************
 * Private Functions
 ****************************************************************************/

static int shv_fwstable_confirm(struct shv_con_ctx *shv_ctx,
                                struct shv_node *item, int rid)
{
  shv_unpack_data(&shv_ctx->unpack_ctx, 0, 0);
  nxboot_confirm();
  shv_send_empty_response(shv_ctx, rid);
  return 0;
}

static int shv_fwstable_get(struct shv_con_ctx *shv_ctx,
                            struct shv_node *item, int rid)
{
  shv_unpack_data(&shv_ctx->unpack_ctx, 0, 0);
  int ret = nxboot_get_confirm();
  if (ret >= 0)
    {
      shv_send_int(shv_ctx, rid, ret);
    }
  else
    {
      shv_send_error(shv_ctx, rid, SHV_RE_PLATFORM_ERROR,
                     "nxboot_get_confirm failed");
    }

  return 0;
}

static int shv_nxboot_opener(struct shv_file_node *item)
{
  struct shv_file_node_fctx *fctx = (struct shv_file_node_fctx *)item->fctx;
  if (!(fctx->flags & SHV_FILE_POSIX_BITFLAG_OPENED))
    {
      fctx->fd = nxboot_open_update_partition();
      if (fctx->fd < 0)
        {
          return -1;
        }

      fctx->flags |= SHV_FILE_POSIX_BITFLAG_OPENED;
    }

  return 0;
}

static struct shv_node *shv_tree_create(void)
{
  struct shv_node           *tree_root;
  struct shv_node           *fwstable_node;
  struct shv_dotdevice_node *dotdevice_node;
  struct shv_file_node      *fwupdate_node;
  struct shv_dotapp_node    *dotapp_node;

  struct mtd_geometry_s geometry;
  int flash_fd;
  flash_fd = nxboot_open_update_partition();
  if (flash_fd < 0)
    {
      return NULL;
    }

  puts("Creating the SHV Tree root");
  tree_root = shv_tree_node_new("", &shv_dev_root_dmap, 0);
  if (tree_root == NULL)
    {
      close(flash_fd);
      return NULL;
    }

  fwupdate_node = shv_tree_file_node_new("fwUpdate",
                                         &shv_file_node_dmap, 0);
  if (fwupdate_node == NULL)
    {
      close(flash_fd);
      free(tree_root);
      return NULL;
    }

  if (ioctl(flash_fd, MTDIOC_GEOMETRY,
            (unsigned long)((uintptr_t)&geometry)) < 0)
    {
      close(flash_fd);
      free(tree_root);
      free(fwupdate_node);
      return NULL;
    }

  fwupdate_node->file_type = SHV_FILE_MTD;
  fwupdate_node->file_maxsize = geometry.erasesize * geometry.neraseblocks;
  fwupdate_node->file_pagesize = geometry.blocksize;
  fwupdate_node->file_erasesize = geometry.erasesize;

  /* Update the fops table in the file node */

  fwupdate_node->fops.opener = shv_nxboot_opener;
  shv_tree_add_child(tree_root, &fwupdate_node->shv_node);
  close(flash_fd);

  dotapp_node = shv_tree_dotapp_node_new(&shv_dotapp_dmap, 0);
  if (dotapp_node == NULL)
    {
      free(tree_root);
      free(fwupdate_node);
      return NULL;
    }

  dotapp_node->name = "NuttX shv-libs4c FW Updater";
  dotapp_node->version = "1.0.0";

  shv_tree_add_child(tree_root, &dotapp_node->shv_node);

  dotdevice_node = shv_tree_dotdevice_node_new(&shv_dotdevice_dmap, 0);
  if (dotdevice_node == NULL)
    {
      free(tree_root);
      free(fwupdate_node);
      free(dotapp_node);
      return NULL;
    }

  dotdevice_node->name = "SHV Compatible Device";
  dotdevice_node->serial_number = "0xDEADBEEF";
  dotdevice_node->version = "0.1.0";
  shv_tree_add_child(tree_root, &dotdevice_node->shv_node);

  fwstable_node = shv_tree_node_new("fwStable", &shv_dev_fwstable_dmap, 0);
  if (fwstable_node == NULL)
    {
      free(tree_root);
      free(fwupdate_node);
      free(dotapp_node);
      return NULL;
    }

  shv_tree_add_child(tree_root, fwstable_node);

  return tree_root;
}

static void quit_handler(int signum)
{
  puts("Stopping SHV FW Updater!");
  sem_post(&running);
}

static void print_help(char *name)
{
  printf("%s: [OPTIONS]\n", name);
  puts("SHV Firmware Updater for NXBoot");
  puts("Showcases the file handling capabilities and usage with NXBoot.");
  puts("Mandatory options:");
  puts("  -m <mount-point>: mount point in the SHV broker");
  puts("  -i <ip-addr>: IPv4 address of the SHV broker");
  puts("  -p <passwd>: password to access the SHV broker");
  puts("  -t <port>: TCP/IP port of the SHV broker");
  puts("  -u <user>: user to access the SHV broker");
  puts("Nonmandatory options:");
  puts("  -h: print help");
}

static void attention_cb(struct shv_con_ctx *shv_ctx,
                         enum shv_attention_reason r)
{
  if (r == SHV_ATTENTION_ERROR)
    {
      printf("Error occurred in SHV, the reason is: %s\n",
             shv_errno_str(shv_ctx));
      sem_post(&running);
    }
}

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: main
 ****************************************************************************/

int main(int argc, char *argv[])
{
  /* Define the SHV Communication parameters */

  int ret;
  int opt;
  struct shv_connection connection;
  struct shv_node *tree_root;
  struct shv_con_ctx *ctx;
  const int comthrd_prio = CONFIG_EXAMPLES_SHV_NXBOOT_UPDATER_PRIORITY - 1;

  const char *user = NULL;
  const char *passwd = NULL;
  const char *mount = NULL;
  const char *ip = NULL;
  const char *port_s = NULL;
  int port = 0;

  /* Initialize the communication. But only if parameters are passed. */

  while ((opt = getopt(argc, argv, "hm:i:p:t:u:")) != -1)
    {
      switch (opt)
        {
          case 'h':
            print_help(argv[0]);
            return 0;
          case 'm':
            mount = optarg;
            break;
          case 'i':
            ip = optarg;
            break;
          case 'p':
            passwd = optarg;
            break;
          case 't':
            port_s = optarg;
            port = atoi(port_s);
            break;
          case 'u':
            user = optarg;
            break;
          case '?':
            print_help(argv[0]);
            return 1;
        }
    }

  if (!user || !passwd || !mount || !ip || !port_s)
    {
      print_help(argv[0]);
      return 1;
    }

  shv_connection_init(&connection, SHV_TLAYER_TCPIP);
  connection.broker_user =     user;
  connection.broker_password = passwd;
  connection.broker_mount =    mount;
  connection.reconnect_period = 10;
  connection.reconnect_retries = 0;
  if (shv_connection_tcpip_init(&connection, ip, port) < 0)
    {
      fprintf(stderr, "Have you supplied valid params to shv_connection?\n");
      return 1;
    }

  puts("SHV Connection Init OK");

  tree_root = shv_tree_create();
  if (tree_root == NULL)
    {
      fprintf(stderr, "Can't create the SHV tree.");
      return 1;
    }

  puts("SHV Tree created!");
  ctx = shv_com_init(tree_root, &connection, attention_cb);
  if (ctx == NULL)
    {
      fprintf(stderr, "Can't establish the comm with the broker.\n");
      return 1;
    }

  ret = shv_create_process_thread(comthrd_prio, ctx);
  if (ret < 0)
    {
      fprintf(stderr, "%s\n", shv_errno_str(ctx));
      free(ctx);
      return 1;
    }

  sem_init(&running, 0, 0);
  signal(SIGTERM, quit_handler);

  sem_wait(&running);

  puts("Close the communication");
  shv_com_destroy(ctx);
  shv_tree_destroy(tree_root);

  return 0;
}