mos/com/include/com.h

Go to the documentation of this file.

//  This file is part of MOS, the MANTIS Operating System
//  See http://mantis.cs.colorado.edu/
//
//  Copyright (c) 2002 - 2007 University of Colorado, Boulder
//
//   All rights reserved.
//
//   Redistribution and use in source and binary forms, with or without
//   modification, are permitted provided that the following conditions are
//   met:
//
//       * Redistributions of source code must retain the above copyright
//         notice, this list of conditions and the following disclaimer.
//       * 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. 
//       * Neither the name of the MANTIS Project 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 COPYRIGHT HOLDERS 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 COPYRIGHT
//   OWNER 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.

#ifndef _COM_H_
#define _COM_H_

#include "mos.h"
#include "mutex.h"
#include <stdarg.h>

#ifdef SCONS
#include "optsconfig.h"
#else

/* Defines which MAC layer to use */
//#define CC1000_RAW
#define CC1000_CSMA
//#define CC1000_CSMA_ACK
//#define CC1000_TDMA
//#define CC1000_BMAC


//ANS: Enable signal strength measurement

#define GET_RSSI
//#define TS_PACKET

#endif


#ifndef PLATFORM_LINUX
// enable FEC code
//#define RADIO_USE_FEC 1
// send three size bytes instead of one, compute packet size from majority bits
//#define RADIO_REDUNDANT_SIZE
// Send 2 CRC bytes after the data that will be checked after FEC is done
//#define RADIO_EXTRA_CRC
#endif

#ifdef RADIO_USE_FEC
//#define FEC_SIZE_PARITY_COUNT 2
#define FEC_DATA_PARITY_COUNT 8
#endif

#ifndef RADIO_EXTRA_CRC
#define COM_DATA_SIZE 90 /* Size of com buffer. */
#else
// Add two more bytes to include a CRC that is checked AFTER error-correction
// FIXME this is an ugly way to do this, since some protocols may use
// this number to determine their payload sizes
#define COM_DATA_SIZE 92
#endif

#ifdef PLATFORM_LINUX
#define NUM_BUFS 255 /* Size of buffer pool. */

#else
#define NUM_BUFS 5
#endif


#ifdef TS_PACKET
#ifdef ARCH_AVR
#include "realtime.h"
#endif
#endif


typedef struct comBuf_t {
   struct comBuf_t *next;
   uint8_t data[COM_DATA_SIZE];

#ifdef GET_RSSI

   uint16_t signal;
#endif
#ifdef TS_PACKET

   uint32_t ts;
   uint8_t tcnt;
#endif

   uint8_t size;
   uint16_t source;
} comBuf;


#define IFACE_SERIAL   0 

#define IFACE_SERIAL2  1

#define IFACE_RADIO    2 

#define IFACE_LOOPBACK 3

#define MAX_IFS        7


#ifdef PLATFORM_LINUX
#define IFACE_UDP      4 // udp/ip sockets
#define IFACE_TCP      5 // tcp/ip sockets
#define IFACE_TERMINAL 6 // terminal (input reading)
#endif

#ifdef PLATFORM_TELOSB
#define com_send_IFACE_STDIO com_send_IFACE_SERIAL2
#define com_ioctl_IFACE_STDIO com_ioctl_IFACE_SERIAL2
#define com_mode_IFACE_STDIO com_mode_IFACE_SERIAL2
#else

#define com_send_IFACE_STDIO com_send_IFACE_SERIAL

#define com_ioctl_IFACE_STDIO com_ioctl_IFACE_SERIAL

#define com_mode_IFACE_STDIO com_mode_IFACE_SERIAL
#endif

/********* Device-specific function prototypes ************/
uint8_t com_send_IFACE_SERIAL(comBuf *buf);
void com_mode_IFACE_SERIAL(uint8_t mode);
void com_ioctl_IFACE_SERIAL(uint8_t request, ...);

uint8_t com_send_IFACE_SERIAL2(comBuf *buf);
void com_mode_IFACE_SERIAL2(uint8_t mode);
void com_ioctl_IFACE_SERIAL2(uint8_t request, ...);

uint8_t com_send_IFACE_RADIO(comBuf *buf);
void com_mode_IFACE_RADIO(uint8_t mode);
void com_ioctl_IFACE_RADIO(uint8_t request, ...);

uint8_t com_send_IFACE_TERMINAL(comBuf *buf);
void com_mode_IFACE_TERMINAL(uint8_t mode);
void com_ioctl_IFACE_TERMINAL(uint8_t request, ...);

uint8_t com_send_IFACE_UDP(comBuf *buf);
void com_mode_IFACE_UDP(uint8_t mode);
void com_ioctl_IFACE_UDP(uint8_t request, ...);


uint8_t com_send_IFACE_LOOPBACK(comBuf *buf);
void com_mode_IFACE_LOOPBACK(uint8_t mode);
void com_ioctl_IFACE_LOOPBACK(uint8_t request, ...);



enum {
   IF_OFF = 0, 
   IF_STANDBY,
   IF_IDLE,
   IF_LISTEN,
#ifdef RADIO_USE_FEC

   IF_FEC_ENABLE,
   IF_FEC_DISABLE 
#endif
};

#define PREAMBLE            0x53
#define PREAMBLE_SIZE       2


#define SELECT_IFACE_BUSY 150

#define IFACE_NOT_REGISTERED 160


typedef uint8_t IF_SET;

/* NOTE: These implementations limit the number of devices to 8. */

#define IF_SET(iface, set) (*set |= 1 << iface) // TODO: check shift direction

#define IF_CLEAR(iface, set) (*set &= ~(1 << iface))

#define IF_ZERO(set) (*set = 0)

#define IF_ISSET(iface, set) (*set & (1 << iface))

uint8_t com_select (IF_SET *iset, uint32_t msec);

#define COM_BLOCK -1

#define COM_NOBLOCK 0




uint8_t com_init();
extern mos_mutex_t if_send_mutexes[MAX_IFS];


void com_flush (uint8_t iface);


#define com_send(iface,buf) com_send_##iface (buf)
#define com_sendto(iface,buf,dest) com_sendto_##iface(buf,dest)

comBuf *com_recv(uint8_t iface);

comBuf *com_recv_timed(uint8_t iface, uint32_t msecs);

#define com_ioctl(iface,request,args...) com_ioctl_##iface (request, ##args)

#define com_mode(iface,mode) com_mode_##iface (mode)

void com_free_buf (comBuf *buf);

void com_swap_bufs (uint8_t iface, comBuf *buf, comBuf **ret);

void buf_insert16(uint8_t* p, uint16_t pos, uint16_t word);

void buf_insert32(uint8_t* p, uint16_t pos, uint32_t dword);

uint16_t buf_extract16(uint8_t* p, uint16_t pos);

uint32_t buf_extract32(uint8_t* p, uint16_t pos);




/* ELF object propagation support */
char is_elf_packet(comBuf *buf);
#define ELFPKT_BYTE0 65

#define ELFPKT_BYTE1 75

#define ELFPKT_BYTE2 85

#define ELFPKT_BYTE3 95

#ifdef USING_ELF

#include "msched.h"
#include "com.h"
mos_thread_t *elfthread;
comBuf *elfbuf;
char is_elf_packet(comBuf *buf);

#endif


#endif

---