border-router-mac.c

Go to the documentation of this file.

/*
 * Copyright (c) 2011, Swedish Institute of Computer Science.
 * 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. Neither the name of the Institute 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 INSTITUTE 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 INSTITUTE 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.
 */
 
/**
 * \file
 *         A null RDC implementation that uses framer for headers and sends
 *         the packets over slip instead of radio.
 * \author
 *         Adam Dunkels <adam@sics.se>
 *         Joakim Eriksson <joakime@sics.se>
 *         Niclas Finne <nfi@sics.se>
 */
 
#include "net/packetbuf.h"
#include "net/queuebuf.h"
#include "net/netstack.h"
#include "net/mac/framer/frame802154.h"
#include "net/mac/mac-sequence.h"
#include "packetutils.h"
#include "border-router.h"
#include "border-router-cbor.h"
#include <string.h>
 
/*---------------------------------------------------------------------------*/
/* Log configuration */
#include "sys/log.h"
#define LOG_MODULE "BR-MAC"
#define LOG_LEVEL LOG_LEVEL_NONE
 
#define MAX_CALLBACKS 16
static int callback_pos;
 
/* a structure for calling back when packet data is coming back
   from radio... */
struct tx_callback {
  mac_callback_t cback;
  void *ptr;
  struct packetbuf_attr attrs[PACKETBUF_NUM_ATTRS];
  struct packetbuf_addr addrs[PACKETBUF_NUM_ADDRS];
};
/*---------------------------------------------------------------------------*/
static struct tx_callback callbacks[MAX_CALLBACKS];
/*---------------------------------------------------------------------------*/
void
init_sec(void)
{
  /* use the CSMA LLSEC config parameter */
#if LLSEC802154_USES_AUX_HEADER
  if(packetbuf_attr(PACKETBUF_ATTR_SECURITY_LEVEL) ==
     PACKETBUF_ATTR_SECURITY_LEVEL_DEFAULT) {
    packetbuf_set_attr(PACKETBUF_ATTR_SECURITY_LEVEL,
                       CSMA_LLSEC_SECURITY_LEVEL);
  }
#endif
}
/*---------------------------------------------------------------------------*/
 
void
packet_sent(uint8_t sessionid, uint8_t status, uint8_t tx)
{
  if(sessionid < MAX_CALLBACKS) {
    struct tx_callback *callback;
    callback = &callbacks[sessionid];
    packetbuf_clear();
    packetbuf_attr_copyfrom(callback->attrs, callback->addrs);
    mac_call_sent_callback(callback->cback, callback->ptr, status, tx);
  } else {
    LOG_ERR("Session id (%d) >= MAX_CALLBACKS (%d)\n", sessionid,
            MAX_CALLBACKS);
  }
}
/*---------------------------------------------------------------------------*/
static int
setup_callback(mac_callback_t sent, void *ptr)
{
  struct tx_callback *callback;
  int tmp = callback_pos;
  callback = &callbacks[callback_pos];
  callback->cback = sent;
  callback->ptr = ptr;
  packetbuf_attr_copyto(callback->attrs, callback->addrs);
 
  callback_pos++;
  if(callback_pos >= MAX_CALLBACKS) {
    callback_pos = 0;
  }
 
  return tmp;
}
/*---------------------------------------------------------------------------*/
static void
send_packet(mac_callback_t sent, void *ptr)
{
  uint8_t sid;
#if !BORDER_ROUTER_SERIAL_RADIO
  int size;
  /* 3 bytes per packet attribute is required for serialization */
  uint8_t buf[PACKETBUF_NUM_ATTRS * 3 + PACKETBUF_SIZE + 3];
#endif
 
  packetbuf_set_addr(PACKETBUF_ADDR_SENDER, &linkaddr_node_addr);
 
  /* ack or not ? */
  packetbuf_set_attr(PACKETBUF_ATTR_MAC_ACK, 1);
 
  /* Will make it send only DATA packets... for now */
  packetbuf_set_attr(PACKETBUF_ATTR_FRAME_TYPE, FRAME802154_DATAFRAME);
 
  /* set destination sequence number */
  mac_sequence_set_dsn();
 
  LOG_INFO("sending packet (%u bytes)\n", packetbuf_datalen());
 
  if(NETSTACK_FRAMER.create() < 0) {
    /* Failed to allocate space for headers */
    LOG_WARN("send failed, too large header\n");
    mac_call_sent_callback(sent, ptr, MAC_TX_ERR_FATAL, 1);
    return;
  }
 
#if BORDER_ROUTER_SERIAL_RADIO
  /* serialradio: hand the fully-framed 802.15.4 packet to the radio as a raw
     frame (it runs with no framer of its own and transmits it verbatim).  The
     TX result returns asynchronously as a TX_RESPONSE event, which calls
     packet_sent() for this session id. */
  sid = setup_callback(sent, ptr);
  br_cbor_send_tx_frame(sid, packetbuf_hdrptr(), packetbuf_totlen());
#else
  /* legacy slip-radio: send "!S" + serialized attributes + framed packet. */
#if SERIALIZE_ATTRIBUTES
  size = packetutils_serialize_atts(&buf[3], sizeof(buf) - 3);
#else
  size = 0;
#endif
  if(size < 0 || size + packetbuf_totlen() + 3 > sizeof(buf)) {
    LOG_WARN("send failed, too large header\n");
    mac_call_sent_callback(sent, ptr, MAC_TX_ERR_FATAL, 1);
  } else {
    sid = setup_callback(sent, ptr);
 
    buf[0] = '!';
    buf[1] = 'S';
    buf[2] = sid; /* sequence or session number for this packet */
 
    /* Copy packet data */
    memcpy(&buf[3 + size], packetbuf_hdrptr(), packetbuf_totlen());
 
    write_to_slip(buf, packetbuf_totlen() + size + 3);
  }
#endif /* BORDER_ROUTER_SERIAL_RADIO */
}
/*---------------------------------------------------------------------------*/
static void
packet_input(void)
{
  if(NETSTACK_FRAMER.parse() < 0) {
    LOG_DBG("failed to parse %u\n", packetbuf_datalen());
  } else {
    NETSTACK_NETWORK.input();
  }
}
/*---------------------------------------------------------------------------*/
static int
on(void)
{
  return 1;
}
/*---------------------------------------------------------------------------*/
static int
off()
{
  return 1;
}
/*---------------------------------------------------------------------------*/
static int
max_payload()
{
  init_sec();
  return 127 - NETSTACK_FRAMER.length();
}
/*---------------------------------------------------------------------------*/
static void
init(void)
{
  callback_pos = 0;
  mac_sequence_init();
}
/*---------------------------------------------------------------------------*/
const struct mac_driver border_router_mac_driver = {
  "br-mac",
  init,
  send_packet,
  packet_input,
  on,
  off,
  max_payload,
};
/*---------------------------------------------------------------------------*/