serval-dna/overlay_packetradio.c

#include "serval.h"
#include "conf.h"
#include <termios.h>

/* interface decoder states. broadly based on RFC1055 */
#define DC_NORMAL 0
#define DC_ESC 1

/* SLIP-style escape characters used for serial packet radio interfaces */
#define SLIP_END 0300
#define SLIP_ESC 0333
#define SLIP_ESC_END 0334
#define SLIP_ESC_ESC 0335

int overlay_packetradio_setup_port(overlay_interface *interface)
{
  struct termios t;

  tcgetattr(interface->alarm.poll.fd, &t);
  // XXX Speed and options should be configurable
  cfsetispeed(&t, B57600);
  cfsetospeed(&t, B57600);
  // 8N1
  t.c_cflag &= ~PARENB;
  t.c_cflag &= ~CSTOPB;
  t.c_cflag &= ~CSIZE;
  t.c_cflag |= CS8;

  // Enable CTS/RTS flow control (for now)
#ifndef CNEW_RTSCTS
  t.c_cflag |= CRTSCTS;
#else
  t.c_cflag |= CNEW_RTSCTS;
#endif
  // and software flow control
  t.c_iflag &= ~(IXON | IXOFF | IXANY);

  // raw data please
  t.c_lflag &= ~(ICANON | ECHO | ECHOE | ISIG);
  t.c_oflag &= ~OPOST;

  tcsetattr(interface->alarm.poll.fd, TCSANOW, &t);

  set_nonblock(interface->alarm.poll.fd);

  return 0;
}

int overlay_rx_packet_complete(overlay_interface *interface)
{
  dump("received packet",interface->rxbuffer,interface->recv_offset);
  if (interface->recv_offset) {
    // dispatch received packet
    if (packetOkOverlay(interface, interface->rxbuffer, interface->recv_offset, -1, 
			NULL,0)) {
      if (config.debug.packetradio)
	WARN("Corrupted or unsupported packet from packet radio interface");
    }
  }
  interface->recv_offset=0;
  return 0;
}

int overlay_rx_packet_append_byte(overlay_interface *interface,unsigned char byte)
{
  // Make sure we don't put the data outside the RX buffer
  if (interface->recv_offset<0
      ||interface->recv_offset>=OVERLAY_INTERFACE_RX_BUFFER_SIZE)
    interface->recv_offset=0;
  
  interface->rxbuffer[interface->recv_offset++]=byte;
  if (interface->recv_offset==OVERLAY_INTERFACE_RX_BUFFER_SIZE) {
    // packet fills buffer.  Who knows, we might be able to decode what we
    // have of it.
    return overlay_rx_packet_complete(interface);
  } 

  return 0;
}

void overlay_packetradio_poll(struct sched_ent *alarm)
{
  overlay_interface *interface = (overlay_interface *)alarm;

  {
    if (interface->tx_bytes_pending>0) {
      int written=write(alarm->poll.fd,interface->txbuffer,
			interface->tx_bytes_pending);
      if (config.debug.packetradio) DEBUGF("Trying to write %d bytes",
					   interface->tx_bytes_pending);
      if (written>0) {
	interface->tx_bytes_pending-=written;
	bcopy(&interface->txbuffer[written],&interface->txbuffer[0],
	      interface->tx_bytes_pending);
	if (config.debug.packetradio) DEBUGF("Wrote %d bytes (%d left pending)",
					     written,interface->tx_bytes_pending);
      } else {
	if (config.debug.packetradio) DEBUGF("Failed to write any data");
      }
      alarm->poll.revents&=~POLLOUT;
      watch(alarm);
      if (interface->tx_bytes_pending>0) {
	// more to write, so keep POLLOUT flag
      } else {
	// nothing more to write, so clear POLLOUT flag
	alarm->poll.events&=~POLLOUT;
	watch(alarm);      
      }
    }
  }

  if (alarm->poll.revents==0){
    
    if (interface->state==INTERFACE_STATE_UP && interface->tick_ms>0){
      // tick the interface
      time_ms_t now = gettime_ms();
      overlay_route_queue_advertisements(interface);
      alarm->alarm=now+interface->tick_ms;
      alarm->deadline=alarm->alarm+interface->tick_ms/2;
      unschedule(alarm);
      schedule(alarm);
    }
    
    return;
  }

  // Read data from the serial port
  // We will almost certainly support more than one type of packet radio
  // so lets parameterise this.
  switch(1) {
  case 1:
    {
      unsigned char buffer[OVERLAY_INTERFACE_RX_BUFFER_SIZE];
      ssize_t nread = read(alarm->poll.fd, buffer, OVERLAY_INTERFACE_RX_BUFFER_SIZE);
      if (nread == -1){
	// WHY_perror("read");
	return;
      }
      if (nread>0) {
	/*
	  Examine received bytes for end of packet marker.
	  The challenge is that we need to make sure that the packet encapsulation
	  is self-synchronising in the event that a data error occurs (including
	  failure to receive an arbitrary number of bytes).
	  For now we will reuse the functional but sub-optimal method described in
	  RFC1055 for SLIP.
	*/
	int i;
	for(i=0;i<nread;i++)
	  {
	    switch (interface->decoder_state) {
	    case DC_ESC:
	      // escaped character
	      switch(buffer[i]) {
	      case SLIP_ESC_END: // escaped END byte
		overlay_rx_packet_append_byte(interface,SLIP_END); 
		break;
	      case SLIP_ESC_ESC: // escaped escape character
		overlay_rx_packet_append_byte(interface,SLIP_ESC); 
		break;
	      default: /* Unknown escape character. This is an error. */
		if (config.debug.packetradio)
		  WARN("Packet radio stream contained illegal escape sequence -- ignoring packet.");
		interface->decoder_state=DC_NORMAL;
		interface->recv_offset=0;
		break;
	      }
	      break;
	    default:
	      // non-escape character
	      switch(buffer[i]) {
	      case SLIP_ESC:
		interface->decoder_state=DC_ESC; 
		break;
	      case SLIP_END:
		overlay_rx_packet_complete(interface);
		break;
	      default:
		overlay_rx_packet_append_byte(interface,buffer[i]);
	      }
	      break;
	    }
	  }
      }
    }
    break;
  }
  
  watch(alarm);

  return ;
}

int overlay_packetradio_tx_packet(int interface_number,
				  struct sockaddr_in *recipientaddr,
				  unsigned char *bytes,int len)
{
  if (config.debug.packetradio) DEBUGF("Sending packet of %d bytes",len);
  
  /*
    This is a bit interesting, because we have to deal with RTS/CTS potentially
    blocking our writing of the packet.

    For now, just try to write it, and if we only write part of it, then so be it.

    We will surround each packet with SLIP END characters, so we should be able to
    deal with such truncation in a fairly sane manner.
  */
  
  if (len>OVERLAY_INTERFACE_RX_BUFFER_SIZE) {
    if (config.debug.packetradio) WHYF("Not sending over-size packet");
    return -1;
  }
  if (overlay_interfaces[interface_number].tx_bytes_pending) {
    if (config.debug.packetradio) 
      WHYF("Dropping packet due to congestion");
    return -1;
  }

  /* Encode packet with SLIP escaping.
     XXX - Add error correction here also */
  char buffer[len*2+4];
  int out_len=0;
  int i;

  buffer[out_len++]=SLIP_END;
  for(i=0;i<len;i++)
    {
      switch(bytes[i]) {
      case SLIP_END:
	buffer[out_len++]=SLIP_ESC;
	buffer[out_len++]=SLIP_ESC_END;
	break;
      case SLIP_ESC:
	buffer[out_len++]=SLIP_ESC;
	buffer[out_len++]=SLIP_ESC_ESC;
	break;
      default:
	buffer[out_len++]=bytes[i];
      }
    }
  buffer[out_len++]=SLIP_END;

  if (config.debug.packetradio) DEBUGF("Encoded length is %d",out_len);
  
  int written=write(overlay_interfaces[interface_number].alarm.poll.fd,
		    buffer,out_len);

  if (config.debug.packetradio) 
    DEBUGF("Wrote %d of %d bytes",written,out_len);
  
  if (written<out_len) {
    int deferred=out_len-written;
    if (deferred>OVERLAY_INTERFACE_TX_BUFFER_SIZE)
      deferred=OVERLAY_INTERFACE_TX_BUFFER_SIZE;
    bcopy(&buffer[written],overlay_interfaces[interface_number].txbuffer,deferred);
    overlay_interfaces[interface_number].tx_bytes_pending=deferred;
    overlay_interfaces[interface_number].alarm.poll.events|=POLLOUT;
    watch(&overlay_interfaces[interface_number].alarm);
    if (config.debug.packetradio) 
      DEBUGF("Buffered %d bytes for transmission",deferred);
  }

  return 0;
}