MilStd1553.h

Go to the documentation of this file.

//===------------------------------------------------------------*- C++ -*-===//
//
// T-EMU: The Terma Emulator
// (c) Terma 2015
// Authors: Mattias Holm <maho (at) terma.com>
//
//===----------------------------------------------------------------------===//

#ifndef TEMU_MIL_STD_1553_H
#define TEMU_MIL_STD_1553_H

#ifdef __cplusplus
extern "C" {
#endif

#include "temu-c/Support/Objsys.h"

#include <assert.h>
#include <stdbool.h>
#include <stdint.h>

typedef enum temu_Mil1553Error {
  teME_NoError     = 0,
  teME_ParityError = 1,
  teME_SyncError   = 1 << 1
} temu_Mil1553Error;

typedef enum temu_Mil1553MsgType {
  teMT_Cmd,
  teMT_Data,
  teMT_Stat,
  teMT_Mode,
} temu_Mil1553MsgType;


typedef struct temu_Mil1553Msg {
  unsigned WordCount; // Number of words including CmdStat
  temu_Mil1553MsgType MsgTyp; // Pre-computed for convenience, otherwise we need
                              // to construct nasty state machines for every model
  temu_Mil1553Error Err; // We can inject errors in every message. The
                         // interpretation is up to the model, but typically:
                         // parity error applies to command or status word if cmd
                         // or stat type message, and to the last data word, if the
                         // msg is a data transaction.
  uint16_t CmdStat;  // Is command or status word
  uint16_t *Data; // Pointer to data block
} temu_Mil1553Msg;

typedef struct temu_Mil1553DevIface {
  void (*send)(void *Device, temu_Mil1553Msg *Msg);
} temu_Mil1553DevIface;

TEMU_IFACE_REFERENCE_TYPE(temu_Mil1553Dev);

typedef struct {
  uint64_t LastReportSentWords; // Number of words sent during last report
  uint64_t SentWords; // Current number of sent words
} temu_Mil1553Stats;

typedef struct temu_Mil1553BusIface {
  void (*connect)(void *Bus, int Subaddr, temu_Mil1553DevIfaceRef Device);
  void (*disconnect)(void *Bus, int Subaddr);
  void (*reportStats)(void *Bus);
  void (*send)(void *Bus, void *Sender, temu_Mil1553Msg *Msg);

  // Controls whether events should be issued at send calls
  void (*enableSendEvents)(void *Bus);
  void (*disableSendEvents)(void *Bus);
} temu_Mil1553BusIface;

TEMU_IFACE_REFERENCE_TYPE(temu_Mil1553Bus);


// Compute messeage transfer time in nano seconds
// 1553 bus is 1 Mb/sec and we have 16 + 4 bits per word.
#define TEMU_1553_NS_PER_WORD 20000
static inline uint64_t
temu_mil1553TransferTime(unsigned Words)
{
  uint64_t Nanos = Words * TEMU_1553_NS_PER_WORD;
  return Nanos;
}

#define TEMU_1553_BITS_PER_WORD 20
static inline uint64_t
temu_mil1553BitCount(unsigned Words)
{
  return Words * TEMU_1553_BITS_PER_WORD;
}

// Conveniance functions to extract fields from the command word

static inline uint16_t
temu_mil1553CmdRtAddr(uint16_t Cmd)
{
  return (Cmd >> 11) & 0x1f;
}


static inline uint16_t
temu_mil1553CmdTR(uint16_t Cmd)
{
  return (Cmd >> 10) & 1;
}

static inline uint16_t
temu_mil1553CmdSubAddr(uint16_t Cmd)
{
  return (Cmd >> 5) & 0x1f;
}

// Return non-zero if the command is a mode command (sub addr == 0 or 0x1f)

static inline int
temu_mil1553CmdIsModeCodeCmd(uint16_t Cmd)
{
  if (temu_mil1553CmdSubAddr(Cmd) == 0x00
      || temu_mil1553CmdSubAddr(Cmd) == 0x1f) {
    return 1;
  }

  return 0;
}




static inline uint16_t
temu_mil1553CmdTRModeCode(uint16_t Cmd)
{
  return ((Cmd >> 5) & 0x20) | (Cmd & 0x1f);
}

static inline uint16_t
temu_mil1553CmdCount(uint16_t Cmd)
{
  return Cmd & 0x1f;
}


static inline uint16_t
temu_mil1553StatRtAddr(uint16_t Stat)
{
  return (Stat >> 11) & 0x1f;
}


static inline uint16_t
temu_mil1553StatME(uint16_t Stat)
{
  return (Stat >> 10) & 1;
}

static inline uint16_t
temu_mil1553StatInst(uint16_t Stat)
{
  return (Stat >> 9) & 1;
}

static inline uint16_t
temu_mil1553StatSR(uint16_t Stat)
{
  return (Stat >> 8) & 1;
}

static inline uint16_t
temu_mil1553StatBC(uint16_t Stat)
{
  return (Stat >> 4) & 1;
}


static inline uint16_t
temu_mil1553StatBusy(uint16_t Stat)
{
  return (Stat >> 3) & 1;
}

static inline uint16_t
temu_mil1553StatSubFlag(uint16_t Stat)
{
  return (Stat >> 2) & 1;
}

static inline uint16_t
temu_mil1553StatDynBusCtrl(uint16_t Stat)
{
  return (Stat >> 1) & 1;
}

static inline uint16_t
temu_mil1553StatTermFlag(uint16_t Stat)
{
  return Stat & 1;
}

// Useful constants, use temu_mil1553CmdTRMode() to extract bits,
// these constants are used for the optional mode control codes that
// are defined in the 1553 standard.
#define TEMU_1553_TR_BIT 0x20

#define teM1553MC_DynamicBusControl              (TEMU_1553_TR_BIT|0x00)
#define teM1553MC_Synchronize                    (TEMU_1553_TR_BIT|0x01)
#define teM1553MC_TransmitStatusWord             (TEMU_1553_TR_BIT|0x02)
#define teM1553MC_InitiateSelfTest               (TEMU_1553_TR_BIT|0x03)
#define teM1553MC_TransmitterShutdown            (TEMU_1553_TR_BIT|0x04)
#define teM1553MC_OverrideTransmitter            (TEMU_1553_TR_BIT|0x05)
#define teM1553MC_InhibitTerminalFlagBit         (TEMU_1553_TR_BIT|0x06)
#define teM1553MC_OverrideInhibitTerminalFlagBit (TEMU_1553_TR_BIT|0x07)
#define teM1553MC_ResetRT                        (TEMU_1553_TR_BIT|0x08)
#define teM1553MC_TransmitVectorWord             (TEMU_1553_TR_BIT|0x10)
#define teM1553MC_SynchronizeWithData            (0x11)
#define teM1553MC_TransmitLastCommand            (TEMU_1553_TR_BIT|0x12)
#define teM1553MC_TransmitBITWord                (TEMU_1553_TR_BIT|0x13)
#define teM1553MC_SelectedTransmitter            (0x14)
#define teM1553MC_OverrideSelectedTransmitter    (0x15)


#ifdef __cplusplus
}
#endif


#endif /* ! TEMU_MIL_STD_1553_H */