platform.c

/*
 * Copyright (c) 2002, Adam Dunkels.
 * 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.
 * 3. The name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 *
 * 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.
 *
 * This file is part of the Contiki OS
 *
 */
 
/**
 * \ingroup platform
 *
 * \defgroup native_platform Native platform
 *
 * Platform running in the host (Windows or Linux) environment.
 *
 * Used mainly for development and debugging.
 * @{
 */
 
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <sys/select.h>
#include <errno.h>
 
#include "contiki.h"
#include "net/netstack.h"
 
#include "dev/serial-line.h"
#include "dev/button-hal.h"
#include "dev/gpio-hal.h"
#include "dev/leds.h"
 
#include "net/ipv6/uip.h"
#include "net/ipv6/uip-debug.h"
#include "net/queuebuf.h"
 
#if NETSTACK_CONF_WITH_IPV6
#include "net/ipv6/uip-ds6.h"
#endif /* NETSTACK_CONF_WITH_IPV6 */
 
#include "lib/assert.h"
#include "lib/csprng.h"
#ifdef __APPLE__
#include <Security/Security.h>
#include <Security/SecRandom.h>
#else /* __APPLE__ */
#include <sys/random.h>
#endif /* __APPLE__ */
 
/* Log configuration */
#include "sys/log.h"
#define LOG_MODULE "Native"
#define LOG_LEVEL LOG_LEVEL_MAIN
 
/*---------------------------------------------------------------------------*/
/**
 * \name Native Platform Configuration
 *
 * @{
 */
 
/*
 * Defines the maximum number of file descriptors monitored by the platform
 * main loop.
 */
#ifdef SELECT_CONF_MAX
#define SELECT_MAX SELECT_CONF_MAX
#else
#define SELECT_MAX 8
#endif
 
/*
 * Defines the timeout (in msec) of the select operation if no monitored file
 * descriptors becomes ready.
 */
#ifdef SELECT_CONF_TIMEOUT
#define SELECT_TIMEOUT SELECT_CONF_TIMEOUT
#else
#define SELECT_TIMEOUT 1000
#endif
 
/*
 * Adds the STDIN file descriptor to the list of monitored file descriptors.
 */
#ifdef SELECT_CONF_STDIN
#define SELECT_STDIN SELECT_CONF_STDIN
#else
#define SELECT_STDIN 1
#endif
/** @} */
/*---------------------------------------------------------------------------*/
 
static const struct select_callback *select_callback[SELECT_MAX];
static int select_max = 0;
 
#ifdef PLATFORM_CONF_MAC_ADDR
static uint8_t mac_addr[] = PLATFORM_CONF_MAC_ADDR;
#else /* PLATFORM_CONF_MAC_ADDR */
static uint8_t mac_addr[] = { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08 };
#endif /* PLATFORM_CONF_MAC_ADDR */
 
/*---------------------------------------------------------------------------*/
int
select_set_callback(int fd, const struct select_callback *callback)
{
  int i;
  if(fd >= 0 && fd < SELECT_MAX) {
    /* Check that the callback functions are set */
    if(callback != NULL &&
       (callback->set_fd == NULL || callback->handle_fd == NULL)) {
      callback = NULL;
    }
 
    select_callback[fd] = callback;
 
    /* Update fd max */
    if(callback != NULL) {
      if(fd > select_max) {
        select_max = fd;
      }
    } else {
      select_max = 0;
      for(i = SELECT_MAX - 1; i > 0; i--) {
        if(select_callback[i] != NULL) {
          select_max = i;
          break;
        }
      }
    }
    return 1;
  }
  return 0;
}
/*---------------------------------------------------------------------------*/
#if SELECT_STDIN
static int
stdin_set_fd(fd_set *rset, fd_set *wset)
{
  FD_SET(STDIN_FILENO, rset);
  return 1;
}
static int (*input_handler)(unsigned char c);
 
void
native_uart_set_input(int (*input)(unsigned char c))
{
  input_handler = input;
}
static void
stdin_handle_fd(fd_set *rset, fd_set *wset)
{
  char c;
  if(FD_ISSET(STDIN_FILENO, rset)) {
    ssize_t n = read(STDIN_FILENO, &c, 1);
    if(n > 0) {
      input_handler(c);
    } else if(n == 0) {
      /* EOF: stop monitoring stdin so the main loop does not busy-spin
         on a perpetually-ready fd. */
      LOG_INFO("stdin closed (EOF); no longer monitoring stdin\n");
      select_set_callback(STDIN_FILENO, NULL);
    } else if(errno != EINTR && errno != EAGAIN) {
      LOG_ERR("read(stdin): %s; no longer monitoring stdin\n",
              strerror(errno));
      select_set_callback(STDIN_FILENO, NULL);
    }
  }
}
const static struct select_callback stdin_fd = {
  stdin_set_fd, stdin_handle_fd
};
#endif /* SELECT_STDIN */
/*---------------------------------------------------------------------------*/
static void
set_lladdr(void)
{
  linkaddr_t addr;
 
  memset(&addr, 0, sizeof(linkaddr_t));
#if NETSTACK_CONF_WITH_IPV6
  memcpy(addr.u8, mac_addr, sizeof(addr.u8));
#else
  int i;
  for(i = 0; i < sizeof(linkaddr_t); ++i) {
    addr.u8[i] = mac_addr[7 - i];
  }
#endif
  linkaddr_set_node_addr(&addr);
}
/*---------------------------------------------------------------------------*/
#if NETSTACK_CONF_WITH_IPV6
static void
set_global_address(void)
{
  uip_ipaddr_t ipaddr;
  const uip_ipaddr_t *default_prefix = uip_ds6_default_prefix();
 
  /* Assign a unique local address (RFC4193,
     http://tools.ietf.org/html/rfc4193). */
  uip_ip6addr_copy(&ipaddr, default_prefix);
 
  /* Assumes that the uip_lladdr is set */
  uip_ds6_set_addr_iid(&ipaddr, &uip_lladdr);
  uip_ds6_addr_add(&ipaddr, 0, ADDR_AUTOCONF);
 
  LOG_INFO("Added global IPv6 address ");
  LOG_INFO_6ADDR(&ipaddr);
  LOG_INFO_("\n");
 
  /* set the PREFIX::1 address to the IF */
  uip_ip6addr_copy(&ipaddr, default_prefix);
  ipaddr.u8[15] = 1;
  uip_ds6_defrt_add(&ipaddr, 0);
}
#endif
/*---------------------------------------------------------------------------*/
void
platform_init_stage_one()
{
  gpio_hal_init();
  button_hal_init();
  leds_init();
#if CSPRNG_ENABLED
  struct csprng_seed seed;
#ifdef __APPLE__
  if(SecRandomCopyBytes(kSecRandomDefault, CSPRNG_SEED_LEN, seed.u8)
      == errSecSuccess) {
#else /* __APPLE__ */
  if(getrandom(seed.u8, CSPRNG_SEED_LEN, GRND_RANDOM) == CSPRNG_SEED_LEN) {
#endif /* __APPLE__ */
    csprng_feed(&seed);
  }
#endif /* CSPRNG_ENABLED */
}
/*---------------------------------------------------------------------------*/
void
platform_init_stage_two()
{
  set_lladdr();
  serial_line_init();
 
#if SELECT_STDIN
  if(NULL == input_handler) {
    native_uart_set_input(serial_line_input_byte);
  }
#endif
}
/*---------------------------------------------------------------------------*/
void
platform_init_stage_three()
{
#if NETSTACK_CONF_WITH_IPV6
  set_global_address();
#endif /* NETSTACK_CONF_WITH_IPV6 */
 
  /* Make standard output unbuffered. */
  setvbuf(stdout, (char *)NULL, _IONBF, 0);
}
/*---------------------------------------------------------------------------*/
void
platform_main_loop()
{
#if SELECT_STDIN
  select_set_callback(STDIN_FILENO, &stdin_fd);
#endif /* SELECT_STDIN */
  while(1) {
    fd_set fdr;
    fd_set fdw;
    int maxfd;
    int i;
    int retval;
    struct timeval tv;
 
    retval = process_run();
 
    tv.tv_sec = retval ? 0 : SELECT_TIMEOUT / 1000;
    tv.tv_usec = retval ? 1 : (SELECT_TIMEOUT * 1000) % 1000000;
 
    FD_ZERO(&fdr);
    FD_ZERO(&fdw);
    maxfd = 0;
    for(i = 0; i <= select_max; i++) {
      if(select_callback[i] != NULL && select_callback[i]->set_fd(&fdr, &fdw)) {
        maxfd = i;
      }
    }
 
    retval = select(maxfd + 1, &fdr, &fdw, NULL, &tv);
    if(retval < 0) {
      if(errno != EINTR) {
        LOG_ERR("select: %s\n", strerror(errno));
      }
    } else if(retval > 0) {
      /* timeout => retval == 0 */
      for(i = 0; i <= maxfd; i++) {
        if(select_callback[i] != NULL) {
          select_callback[i]->handle_fd(&fdr, &fdw);
        }
      }
    }
 
    etimer_request_poll();
  }
}
/*---------------------------------------------------------------------------*/
/** @} */