hostside/safety.h

   1 /**/
   2
   3 #ifndef SAFETY_H
   4 #define SAFETY_H
   5
   6 /*========== basic types etc. ==========*/
   7
   8 typedef unsigned short TrainNum;
   9 typedef unsigned short SegmentNum;
  10 typedef unsigned short LocationNum;
  11 typedef unsigned short MovPosComb;
  12 typedef unsigned char Small;
  13 typedef short TimeInterval;
  14 typedef short Distance;
  15 typedef char Speed; /* non-negative, units of 4mm/s */
  16
  17 /*========== state of the layout ==========*/
  18
  19 typedef struct {
  20   SegmentNum foredetect;   /* train's detectable part is at most maxinto   */
  21   Distance maxinto, uncertainty;   /*   into foredetect but train may be   */
  22   unsigned                         /*   uncertainty less far advanced      */
  23     backwards:1; /* train is moving backwards wrt its own front and back */
  24   Speed speed;
  25 } TrainState;
  26
  27 typedef struct {
  28   unsigned
  29     owned:1, /* this track segment is reserved for a train */
  30     tr_backwards:1, /* train's motion is (would be) backwards wrt track */
  31     movfeat_moving:1, /* feature(s) have been told to change to movposcomb */
  32     cm_autostop:1, /* train should stop on detection */
  33     seg_inverted:1, /* polarity is inverted */
  34     tr_updated:1; /* for use by safety.c:lay_train etc.; otherwise 0 */
  35   TimeInterval until_here, /* ) nonnegative; */  /* ) always valid but */
  36     until_detect;          /* ) 0 if already */  /* )  only meaningful */
  37   TrainNum owner;                                /* )  iff owned       */
  38   MovPosComb movposcomb;
  39   /*polarity?*/
  40 } SegmentState;
  41
  42 typedef struct {
  43   unsigned next_backwards:1;
  44   SegmentNum next;
  45 } SegmentLinkInfo;
  46
  47 typedef struct {
  48   const char *pname;
  49   Small posns;
  50   MovPosComb weight;
  51 } MovFeatInfo;
  52
  53 typedef struct {
  54   SegmentLinkInfo backwards, forwards;
  55   Distance dist;
  56 } SegPosCombInfo;
  57
  58 typedef struct {
  59   const char *pname;
  60   unsigned invertible:1;
  61   Small n_movfeats;
  62   const MovFeatInfo *movfeats;
  63   MovPosComb n_poscombs;
  64   const SegPosCombInfo *poscombs;
  65 } SegmentInfo;
  66
  67 typedef struct {
  68   Speed maxspeed;
  69   Distance tail, detectable, head;
  70   const char *pname;
  71 } TrainInfo;
  72
  73 extern const TrainInfo info_trains[NUM_TRAINS];
  74 extern const SegmentInfo info_segments[NUM_SEGMENTS];
  75
  76 typedef struct {
  77   TrainState trains[NUM_TRAINS];
  78   SegmentState segments[NUM_SEGMENTS];
  79 } State;
  80
  81 extern State s;
  82
  83 /*========== safety.c ==========*/
  84 /*
  85  * safety.c is responsible for ensuring that things don't go
  86  * physically wrong (eg, collisions, derailments, short circuits,
  87  * etc.).
  88  */
  89
  90 void safety_emergencystop(TranNum);
  91   /* Callable directly in response to application command. */
  92
  93 void safety_requestspeed(TrainNum tran, long newspeed);
  94   /* To be called only by the speed manager, thus indirectly from
  95    * user request.
  96    * Will result in a call to speedmanager_speedchange_notify (and of
  97    * course to actual_setspeed.  Speed manager must apply accel/decel
  98    * curve so that if safety.c agrees the command, the actual speed of
  99    * the train changes straight away (at least for decel).
 100    */
 101
 102 void safety_notify_detection(SegmentNum segn);
 103   /* To be called by actual.c when new train detection occurs. */
 104
 105 /*========== speedmgr.c ==========*/
 106
 107 void speedmanager_speedchange_notify(TrainNum tran);
 108   /* To be called only by safety.c, whenever speed is actually set.
 109    * New speed has already been recorded in State. */
 110
 111 /*========== actual.c ==========*/
 112 /* actual.c should only be called from safety.c.
 113  * It is responsible for communicating with the PICs, including
 114  * repeating the NMRA commands and redacting detection information.
 115  *
 116  * In general, when State information is shared between actual.c
 117  * and safety.c, actual.c is responsible for modifying State, and
 118  * will then call an actual_... function to notify the change.
 119  */
 120
 121 void actual_setspeed(TrainNum tran);
 122
 123 void actual_inversions_start(void);
 124 void actual_inversions_segment(SegmentNum);
 125 void actual_inversions_done(void);
 126   /* safety.c will call these in this order: first start, then segment
 127    * for 0 or more segments (whose inversion may or may not have
 128    * changed), and finally done.  At done, the PICs should be told to
 129    * (de)invert the segments as specified.
 130    */
 131
 132 /*
 133  *
 134  * Entrypoints are:                  Called from, and as a result of:
 135  *   actual_setspeed                    safety.c
 136  *   actual_emergencystop               safety.c
 137
 138
 139 /*========== utils.c ==========*/
 140
 141 typedef struct TrackLocation TrackLocation;
 142 struct TrackLocation { /* transparent, and manipulable by trackloc_... fns */
 143   SegmentNum segn; /* current segment */
 144   long into; /* distance from start of segment */
 145   unsigned backwards:1; /* if 1, into is positive and measured from end */
 146 };
 147
 148 long trackloc_remaininseg(const TrackLocation *tloc);
 149   /* Returns dist that tloc can advance before it goes into next segment. */
 150
 151 void trackloc_further(TrackLocation *tloc, long *remain_io);
 152   /* Advances tloc, decrementing *remain_io, until either
 153    * *remain_io becomes zero, or tloc->segn changes. */
 154
 155 void trackloc_reverse(TrackLocation *tloc);
 156   /* Reverses tloc without changing its actual location. */
 157
 158 const SegmentLinkInfo *trackloc_segmentlink_near(const TrackLocation *tloc);
 159 const SegmentLinkInfo *trackloc_segmentlink_far(const TrackLocation *tloc);
 160
 161 #endif /*SAFETY_H*/