examples/timer_gpio/timer_gpio_main.c

/****************************************************************************
 * apps/examples/timer_gpio/timer_gpio_main.c
 *
 * 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 <sys/ioctl.h>
#include <stdio.h>
#include <stdlib.h>
#include <fcntl.h>
#include <signal.h>
#include <errno.h>
#include <string.h>
#include <unistd.h>

#include <nuttx/timers/timer.h>
#include <nuttx/ioexpander/gpio.h>

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

#define DEVNAME_SIZE 32

/****************************************************************************
 * Private Types
 ****************************************************************************/

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

static char g_devtim[DEVNAME_SIZE];
static char g_devgpio[DEVNAME_SIZE];
static bool g_timer_gpio_daemon_started = false;

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

/****************************************************************************
 * Name: timer_status
 *
 * Description:
 *   Auxiliary function to get the timer status and print it.
 *
 * Parameters:
 *   fd           - Timer file descriptor to access the timer.
 *
 ****************************************************************************/

static void timer_status(int fd)
{
  struct timer_status_s status;
  int ret;

  /* Get timer status */

  ret = ioctl(fd, TCIOC_GETSTATUS, (unsigned long)((uintptr_t)&status));
  if (ret < 0)
    {
      fprintf(stderr, "ERROR: Failed to get timer status: %d\n", errno);
      close(fd);
      exit(EXIT_FAILURE);
    }

  /* Print the timer status */

  printf("  flags: %08lx timeout: %lu timeleft: %lu\n",
         (unsigned long)status.flags, (unsigned long)status.timeout,
         (unsigned long)status.timeleft);
}

/****************************************************************************
 * Name: timer_gpio_daemon
 *
 * Description:
 *   Deamon that will be active waiting on a signal to change the digital
 *   output state.
 *
 ****************************************************************************/

static int timer_gpio_daemon(int argc, char *argv[])
{
  struct timer_notify_s notify;
  sigset_t set;
  struct siginfo value;
  int fd_timer;
  int fd_gpio;
  int ret;
  bool state = false;

  /* Indicate that the deamon is running */

  g_timer_gpio_daemon_started = true;
  printf("timer_gpio_daemon: timer_gpio_daemon started\n");

  /* Open the timer device */

  printf("Open %s\n", g_devtim);

  fd_timer = open(g_devtim, O_RDONLY);
  if (fd_timer < 0)
    {
      int errcode = errno;
      printf("timer_gpio_daemon: Failed to open %s: %d\n",
              g_devtim, errcode);
      return EXIT_FAILURE;
    }

  /* Open the GPIO driver */

  printf("Open %s\n", g_devgpio);

  fd_gpio = open(g_devgpio, O_RDWR);
  if (fd_gpio < 0)
    {
      int errcode = errno;
      printf("timer_gpio_daemon: Failed to open %s: %d\n",
              g_devgpio, errcode);
      close(fd_timer);
      return EXIT_FAILURE;
    }

  /* Show the timer status before setting the timer interval */

  timer_status(fd_timer);

  /* Set the timer interval */

  printf("Set timer interval to %lu\n",
         (unsigned long)CONFIG_EXAMPLES_TIMER_GPIO_INTERVAL);

  ret = ioctl(fd_timer, TCIOC_SETTIMEOUT,
              CONFIG_EXAMPLES_TIMER_GPIO_INTERVAL);
  if (ret < 0)
    {
      int errcode = errno;
      printf("timer_gpio_daemon: Failed to set the timer interval: %d\n",
             errcode);
      goto errout;
    }

  /* Show the timer status before attaching the timer handler */

  timer_status(fd_timer);

  /* Configure the signal set for this task */

  sigemptyset(&set);
  sigaddset(&set, CONFIG_EXAMPLES_TIMER_GPIO_SIGNO);

  /* Configure the timer notifier to receive a signal when timeout occurs.
   * Inform the PID of the process that will be notified by the internal
   * timer callback, and configure the event to describe the way this
   * task will be notified. In this case, through a signal.
   */

  printf("Configure the timer notification.\n");

  notify.pid      = getpid();
  notify.periodic = true;

  notify.event.sigev_notify = SIGEV_SIGNAL;
  notify.event.sigev_signo  = CONFIG_EXAMPLES_TIMER_GPIO_SIGNO;
  notify.event.sigev_value.sival_ptr = NULL;

  ret = ioctl(fd_timer, TCIOC_NOTIFICATION,
              (unsigned long)((uintptr_t)&notify));
  if (ret < 0)
    {
      int errcode = errno;
      printf("timer_gpio_daemon: Failed to set the timer handler: %d\n",
             errcode);
      goto errout;
    }

  /* Start the timer */

  printf("Start the timer\n");

  ret = ioctl(fd_timer, TCIOC_START, 0);
  if (ret < 0)
    {
      int errcode = errno;
      printf("timer_gpio_daemon: Failed to start the timer: %d\n", errcode);
      goto errout;
    }

  while (1)
    {
      ret = sigwaitinfo(&set, &value);
      if (ret < 0)
        {
          int errcode = errno;
          printf("timer_gpio_daemon: ERROR: sigwaitinfo() failed: %d\n",
                 errcode);
          goto errout;
        }

      /* Change the gpio state */

      state = !state;

      /* Write the pin value */

      ret = ioctl(fd_gpio, GPIOC_WRITE, (unsigned long)state);
      if (ret < 0)
        {
          int errcode = errno;
          printf("timer_gpio_daemon: Failed to write value"
                 " %u from %s: %d\n",
                (unsigned int)state, g_devgpio, errcode);
          goto errout;
        }
    }

errout:
  close(fd_timer);
  close(fd_gpio);
  g_timer_gpio_daemon_started = false;

  printf("timer_gpio_daemon: Terminating!\n");
  return EXIT_FAILURE;
}

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

/****************************************************************************
 * timer_gpio main
 ****************************************************************************/

int main(int argc, FAR char *argv[])
{
  int ret;
  int opt;

  if (g_timer_gpio_daemon_started)
    {
      printf("timer_gpio_main: timer_gpio daemon already running\n");
      return EXIT_SUCCESS;
    }

  /* Retrieve the arguments */

  /* Use the ones configured on menuconfig */

  strlcpy(g_devtim, CONFIG_EXAMPLES_TIMER_GPIO_TIM_DEVNAME,
          sizeof(g_devtim));
  strlcpy(g_devgpio, CONFIG_EXAMPLES_TIMER_GPIO_GPIO_DEVNAME,
          sizeof(g_devgpio));

  /* Or the ones passed as arguments */

  while ((opt = getopt(argc, argv, ":t:g:")) != -1)
    {
      switch (opt)
      {
        case 't':
            strlcpy(g_devtim, optarg, sizeof(g_devtim));
            break;
        case 'g':
            strlcpy(g_devgpio, optarg, sizeof(g_devgpio));
            break;
        case ':':
            fprintf(stderr, "ERROR: Option needs a value\n");
            exit(EXIT_FAILURE);
        default: /* '?' */
            fprintf(stderr, "Usage: %s [-t /dev/timer0] [-g /dev/gpio0]\n",
                    argv[0]);
            exit(EXIT_FAILURE);
      }
    }

  printf("timer_gpio_main: Starting the timer_gpio daemon\n");
  ret = task_create("timer_gpio_daemon",
                    CONFIG_EXAMPLES_TIMER_GPIO_PRIORITY,
                    CONFIG_EXAMPLES_TIMER_GPIO_STACKSIZE,
                    timer_gpio_daemon,
                    NULL);
  if (ret < 0)
    {
      int errcode = errno;
      printf("timer_gpio_main: Failed to start timer_gpio_daemon: %d\n",
             errcode);
      return EXIT_FAILURE;
    }

  return EXIT_SUCCESS;
}