hostside/realtime.h

   1 /*
   2  * declarations for realtime daemon
   3  */
   4
   5 #ifndef REALTIME_H
   6 #define REALTIME_H
   7
   8 #include "daemons.h"
   9 #include "auproto-pic.h"
  10 #include "dliste.h"
  11
  12 #include <stdarg.h>
  13 #include <string.h>
  14 #include <errno.h>
  15 #include <assert.h>
  16 #include <stdlib.h>
  17 #include <limits.h>
  18 #include <stddef.h>
  19 #include <ctype.h>
  20
  21 #include <sys/types.h>
  22 #include <sys/time.h>
  23 #include <sys/stat.h>
  24 #include <sys/mman.h>
  25 #include <sys/wait.h>
  26
  27 #include <unistd.h>
  28 #include <fcntl.h>
  29 #include <dirent.h>
  30
  31 #include "../layout/layout-data.h"
  32
  33 typedef struct Segment Segment;
  34 typedef struct Train Train;
  35
  36 /*---------- from retransmit.c ----------*/
  37
  38 typedef struct RetransmitRelaxedNode RetransmitRelaxedNode;
  39 typedef union RetransmitUrgentNode RetransmitUrgentNode;
  40 typedef unsigned Retransmit__Time;
  41
  42   /* Contents of the retransmission nodes is generally all for use by
  43    * retransmit.c only; as a special exception, caller may edit pi
  44    * directly.  Normally, though, pi is set by supplying an NMRA
  45    * command to one of the _queue functions; iff the Nmra* is
  46    * non-null, _queue will add an NMRA checksum and update pi.
  47    */
  48 struct RetransmitRelaxedNode {
  49   PicInsn pi;
  50   DLIST_NODE(RetransmitRelaxedNode) rr;
  51 };
  52 union RetransmitUrgentNode {
  53   PicInsn pi;
  54   struct {
  55     RetransmitRelaxedNode relaxed;
  56     int ix;
  57     Retransmit__Time when;
  58     DLIST_NODE(RetransmitUrgentNode) queue;
  59   } u;
  60 };
  61
  62 void retransmit_start(void);
  63 void retransmit_something(void);
  64
  65 void retransmit_relaxed_queue(RetransmitRelaxedNode *rn, Nmra *n);
  66 void retransmit_relaxed_requeue(RetransmitRelaxedNode *rn, Nmra *n);
  67 void retransmit_relaxed_cancel(RetransmitRelaxedNode *rn);
  68
  69 void retransmit_urgent_queue(RetransmitUrgentNode *rn, Nmra *n);
  70 void retransmit_urgent_queue_relaxed(RetransmitUrgentNode *urg, Nmra *n);
  71 void retransmit_urgent_requeue(RetransmitUrgentNode *rn, Nmra *n);
  72 void retransmit_urgent_cancel(RetransmitUrgentNode *rn);
  73
  74   /* ... NB: these are NOT idempotent.  Use _requeue it's queued;
  75    * _requeue is just _cancel followed by queue. */
  76
  77 /*---------- features, filled in by record, used by features.c ----------*/
  78
  79 #define FEATURESADDR_TRANSMITS 4
  80   /* 0..2 are func0to4 func5to8 func9to12 and speed cmd
  81    * pi.l is 0 if not transmitting */
  82
  83 typedef struct FeaturesAddr {
  84   struct FeaturesAddr *next;
  85   int addr, cbitmap;
  86   RetransmitRelaxedNode rn[FEATURESADDR_TRANSMITS];
  87 } FeaturesAddr;
  88
  89 typedef struct {
  90   FeaturesAddr *a;
  91   int bitval; /* may have no or several bits set */
  92   int speedstep; /* -ve means backwards; 0 means not to use motor for feat */
  93 } FeaturesFeature;
  94
  95 typedef struct FeaturesTarget {
  96   struct FeaturesTarget *next;
  97   char *pname;
  98   char *featchs; /* null-terminated */
  99   FeaturesFeature **feats; /* same order as featchs */
 100 } FeaturesTarget;
 101
 102 extern int n_trains;
 103 extern Train *trains;
 104 extern Segment *segments;
 105
 106 extern FeaturesTarget *feattargs;
 107 extern FeaturesAddr *feataddrs;
 108
 109 /*---------- global variables, in realtime.c ----------*/
 110
 111 extern CommandInput cmdi;
 112 extern int picio_send_noise;
 113
 114 #define UPO (&(cmdi.out))
 115
 116 /*---------- from/for startup.c ----------*/
 117
 118 #include "stastate.h"
 119
 120 void sta_startup(void);
 121 void sta_finalising_done(void);
 122 void serial_moredata(PicInsn *buf);
 123
 124 extern StartupState sta_state;
 125 extern const char *const stastatelist[];
 126
 127 void resolve_begin(void); /* from resolve.c */
 128 int resolve_complete(void);
 129 void resolve_motioncheck(void);
 130
 131 /*---------- from/for record.c and persist.c ----------*/
 132
 133 void records_parse(const char **argv);
 134 void persist_entrails_interpret(void);
 135 void persist_entrails_run_converter(void);
 136 void persist_install(void);
 137
 138 extern const char *persist_fn;
 139 extern char *persist_record_converted;
 140
 141 void persist_map_veryearly(void);
 142
 143 /*---------- from/for realtime.c ----------*/
 144
 145 void oupicio(const char *dirn, const PicInsnInfo *pii, int objnum);
 146 void ouhex(const char *word, const Byte *command, int length);
 147
 148 void serial_transmit(const PicInsn *pi);
 149
 150 /*---------- from actual.c ----------*/
 151
 152 int picinsn_polarity_testbit(const PicInsn *pi, const SegmentInfo *segi);
 153   /* this belongs in {au,skel}proto-pic.[ch] really but it's
 154    * more convenient here. */
 155
 156 /*---------- from movpos.c ----------*/
 157
 158 void points_turning_on(void);
 159 void points_all_abandon(void);
 160
 161 /*---------- tbi ----------*/
 162
 163 void choreographers_all_abandon(void);
 164
 165
 166 #include "record.h"
 167
 168 #define PERSIST_CONVERT_OPTION "--persist-convert-entrails"
 169
 170 #include "safety.h"
 171
 172 #define CTYPE(isfoobar,ch) (isfoobar((unsigned char)(ch)))
 173
 174 #endif /*REALTIME_H*/