nuttx/graphics/nxmu/nxmu_start.c

/****************************************************************************
 * graphics/nxmu/nxmu_start.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 <nuttx/config.h>

#include <stdbool.h>
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>
#include <sched.h>
#include <assert.h>
#include <errno.h>
#include <debug.h>

#include <nuttx/board.h>
#include <nuttx/signal.h>
#include <nuttx/kthread.h>
#include <nuttx/nx/nx.h>
#include <nuttx/nx/nxmu.h>

#include "nxmu.h"

#ifdef CONFIG_VNCSERVER
#  include <nuttx/video/vnc.h>
#endif

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

static bool g_nxserver_started[CONFIG_NX_NDISPLAYS];

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

/****************************************************************************
 * Name: nx_server
 *
 * Description:
 *   NX server thread.  This is the entry point into the server kernel
 *   thread that serializes the multi-threaded accesses to the display.
 *
 * Input Parameters:
 *   Standard task start-up parameters (none of which are used)
 *
 * Returned Value:
 *   This function does not normally return but may exit with EXIT_FAILURE
 *   under certain error conditions.
 *
 ****************************************************************************/

static int nx_server(int argc, char *argv[])
{
  FAR NX_DRIVERTYPE *dev;
  int ret;

#if defined(CONFIG_NXSTART_EXTERNINIT)
  /* Use external graphics driver initialization */

  dev = board_graphics_setup(CONFIG_NXSTART_DEVNO);
  if (!dev)
    {
      gerr("ERROR: board_graphics_setup failed, devno=%d\n",
           CONFIG_NXSTART_DEVNO);
      return EXIT_FAILURE;
    }

#elif defined(CONFIG_NX_LCDDRIVER)
  /* Initialize the LCD device */

  ret = board_lcd_initialize();
  if (ret < 0)
    {
      gerr("ERROR: board_lcd_initialize failed: %d\n", ret);
      return EXIT_FAILURE;
    }

  /* Get the device instance */

  dev = board_lcd_getdev(CONFIG_NXSTART_DEVNO);
  if (!dev)
    {
      gerr("ERROR: board_lcd_getdev failed, devno=%d\n",
           CONFIG_NXSTART_DEVNO);
      return EXIT_FAILURE;
    }

  /* Turn the LCD on at 75% power */

  dev->setpower(dev, ((3 * CONFIG_LCD_MAXPOWER + 3) / 4));

#else /* CONFIG_NX_LCDDRIVER */
#  ifdef CONFIG_VNCSERVER
  /* Initialize the VNC server */
  int display;

  /* Get display parameters from the command line */

  display = atoi(argv[1]);

  ret = vnc_fb_register(display);
  if (ret < 0)
    {
       gerr("ERROR: vnc_fb_register() failed: %d\n", ret);
    }

#  else /* CONFIG_VNCSERVER */

  /* Initialize the frame buffer device. */

  int display;
  int plane;

  /* Get display parameters from the command line */

  display = atoi(argv[1]);
  plane   = atoi(argv[2]);

  ret = up_fbinitialize(display);
  if (ret < 0)
    {
      gerr("ERROR: up_fbinitialize failed: %d\n", ret);
      return EXIT_FAILURE;
    }

  dev = up_fbgetvplane(display, plane);
  if (!dev)
    {
      gerr("ERROR: up_fbgetvplane failed, vplane=%d\n", plane);
      return EXIT_FAILURE;
    }

#  endif /* CONFIG_VNCSERVER */
#endif /* CONFIG_NX_LCDDRIVER */

  /* Then start the server (nx_run does not normally return) */

  ret = nx_run(dev);
  ginfo("nx_run returned: %d\n", ret);
  UNUSED(ret);

  return EXIT_FAILURE;
}

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

/****************************************************************************
 * Name: nxmu_start
 *
 * Description:
 *   nxmu_start() provides a wrapper function to simplify and standardize
 *   the starting of the NX server.
 *
 *   nxmu_start() can be called (indirectly) from applications via the
 *   boardctl() interface with the BOARDIOC_NX_START command.
 *
 * Input Parameters:
 *   display - Display number served by this NXMU instance.
 *   plane   - Plane number to use for display info
 *
 * Returned Value:
 *   Zero (OK) is returned on success.  This indicates that the NX server
 *   has been successfully started, is running, and waiting to accept
 *   connections from NX clients.
 *
 *   A negated errno value is returned on failure.  The errno value indicates
 *   the nature of the failure.
 *
 ****************************************************************************/

int nxmu_start(int display, int plane)
{
  DEBUGASSERT((unsigned)display < CONFIG_NX_NDISPLAYS &&
              (unsigned)plane   < CONFIG_NX_NPLANES);

  /* Do nothing is the server has already been started */

  if (!g_nxserver_started[display])
    {
      FAR char display_str[8];
      FAR char plane_str[8];
      int server;
      FAR char * const argv[3] =
      {
        (FAR char * const)display_str,
        (FAR char * const)plane_str,
        NULL
      };

      /* Start the server kernel thread */

      snprintf(display_str, 8, "%d", display);
      snprintf(plane_str, 8, "%d", plane);

      ginfo("Starting server task\n");
      server = kthread_create("NX Server", CONFIG_NXSTART_SERVERPRIO,
                              CONFIG_NXSTART_SERVERSTACK, nx_server, argv);
      if (server < 0)
        {
          gerr("ERROR: Failed to create nx_server kernel thread: %d\n",
               server);
          return server;
        }

      g_nxserver_started[display] = true;

      /* Wait a bit to make sure that the server get started.  NOTE that
       * this operation cannot be done from the IDLE thread!
       */

      nxsig_usleep(50 * 1000);
    }

  return OK;
}