cebpic/README.protocol

   1 PROTOCOL BETWEEN HOST AND MASTER PIC
   2 ====================================
   3
   4 9600 8N1 over the serial port.  The PIC must obey the host's flow
   5 control line, so that if the host gets backed up none of the PICs
   6 messages can get lost.  (If this is too hard, then the PIC should
   7 attempt to buffer some data while the host is busy but if the PIC's
   8 buffer gets too full it should panic.)
   9
  10 Each message consists of a number of 8-bit bytes.  The top bit of each
  11 byte is 1 iff there is another byte in the message.
  12
  13  First       Second      ASCII  Message   Brief
  14   Byte        byte etc.  or hex  name      description
  15
  16 From host to PIC:
  17
  18  > 1 0100 TTT  0 TTTTTTT  (a0)  POINT     Point T fire
  19  > 1 1111 111  ....       (ff)  NMRADATA  NMRA data
  20  > 1 0001 XXX  0 XXXXXXX  (88+) PING      Ping `X' (please Pong `X')
  21  > 1 0010 RRR  E RRR...   (90+) POLARITY  Set polarity
  22  > 1 0011 000  0 MMMMMMM  (98+) WATCHDOG  W'dog reset, t/o <M*16>ms from now
  23  > 0 0010 001             (11)  ON        Power on
  24  > 0 0010 000             (10)  OFF       Power off
  25
  26 ;> 00000000                     CRASHED   Acknowledge panic, go to readout mode
  27 ;> 00001002               (0a)  TELLMODE  Confirm mode - say HELLO or CRASHED
  28 ;                                          if crashed, undoes the effect of ack
  29
  30 ; In crash readout mode:
  31 ;
  32 ;       00000000  MS    Select crash readout mode if not already
  33 ;                       Reset crash readout pointer to 0
  34 ;
  35 ;       00001000        Acknowledge RS232 framing error or overrun
  36 ;       00001001        Reboot
  37 ;
  38 ;       1vvvvvvv  M     Prepare byte 0vvvvvvv for transmission to the slave
  39 ;
  40 ;       00000nnn  M     (n>0) prepare to receive nnnn bytes from slave
  41 ;       0001nnnn  M     (n>0) transmit nnnn bytes of our own from the
  42 ;                         readout pointer
  43 ;
  44 ;       001sssss  M     Select slave S^0x10.  Then:
  45 ;                        After 1vvvvvvv
  46 ;                         Transmit just 0vvvvvvv to slave
  47 ;                         and then send some some unspecified byte to host
  48 ;                        After 0000nnnn
  49 ;                         Receive nnnn bytes, forwarding each one
  50 ;                         to the host.
  51 ;                        After the transaction is complete, 1vvvvvvv
  52 ;                         or 0000nnnn must be specified again before
  53 ;                         001sssss is repeated.
  54 ;
  55 ;       01bbbbbb  MS    Supply 6 bits for crash readout pointer
  56 ;                        (crash readout mode only)
  57 ;                        Effect is   FSR << 6; FSR |= bbbbbb
  58
  59 From PIC to host:
  60
  61  < 1 001Y SSS  0 SSSSSSS  (9?)  DETECT    Train is (Y=1) or is not (Y=0) at S
  62  < 1 0001 XXX  0 XXXXXXX  (88+) PONG      Pong `X' (reply to Ping `X')
  63  < 0 000 1001             (HT)  HELLO     I am booted
  64  < 0 000 1011             (VT)  AAARGH    Followed by debug chars (only)
  65  < 0 000 1101             (CR)  WATCHDOG  Timeout happened
  66  < 0 000 0111             (BEL) FAULT     Fault exists
  67  < 0 000 0110             (ACK) FIXED     Fault now fixed
  68  < 0 0100 PPP             (20+) POINTED   Point change done using capacitor P
  69  < 0 0101 PPP             (28+) CHARGED   Point capacitor P is now charged
  70  < 0 00000 FF                   NMRADONE  Have processed F NMRADATA message(s)
  71
  72  < 0000 1010              (LF)  } debugging output        0x0a (newline) and
  73  < 001C CCCC                    } (works with terminal      0x20-0x7e
  74  < 01CC CCCC except 0111 1111   }  emulator, or host logs)  (printing ASCII)
  75
  76 (These are all shown big-endian, and all of the numerical
  77 representations are big-endian too.  Where a number is split across
  78 two or more bytes, the relevant bits are to be concatenated, in the
  79 order shown, ie bits from the MS byte first, into a larger number.)
  80
  81
  82 HELLO, AAARGH and debugging output
  83 ----------------------------------
  84
  85 When the master PIC starts up and has confirmed that all is well (all
  86 of the other PICs are there, etc), it should send HELLO once.
  87
  88 If the host makes a mistake (eg, sends an unknown command, or does
  89 something else wrong) or something goes horribly wrong, the master PIC
  90 should send AAARGH.
  91
  92 The PIC may always send printing ASCII characters and spaces and
  93 newlines (ie, bytes 0x0a, 0x20-0x7e).  These will print out nicely in
  94 a terminal emulator, if that's what's running on the host.  If the
  95 host is running the real software, that software will put the
  96 characters sent in its log or somewhere else nicely accessible.
  97
  98 Apart from debugging output, the PIC should send nothing before HELLO
  99 and nothing after AAARGH.
 100
 101
 102 POWER AND FAULT
 103 ---------------
 104
 105 The host can send ON and OFF to turn the track (and various other
 106 stuff) on and off.  After ON, the track power should be enabled and
 107 transmitting NMRA idle, and the CDU should be enabled.
 108
 109 If the power is ON, and a track power short circuit is detected, the
 110 PIC should send FAULT.  When the short circuit is removed, the PIC
 111 should send FIXED but not fully reenable track power; track power
 112 should be reenabled when the host transmits ON.
 113
 114
 115        Track and CDU                     Track and CDU
 116         disabled      -------ON------->   enabled
 117                 .
 118                /|\                           |
 119                 |                            |Short circuit detected
 120                  \                           |
 121                   \FIXED                   FAULT
 122                    \                         |
 123                     \__________________      V
 124                         operator       `
 125                     fixes the short     Short circuit
 126                                       (User Fault indicator lit)
 127
 128
 129
 130 POINTS and CDU
 131 --------------
 132
 133 The ON command should cause the CDU to be enabled (and of course all
 134 point motor outputs should be disabled first - see README.circuitry).
 135
 136 Following ON the host must wait until it receives CHARGED before
 137 attempting to change a point.  After CHARGED it may send POINT, to
 138 activate the point and direction specified by T.  The PICs will report
 139 POINTED when the point has stopped moving, and CHARGED when the CDU is
 140 ready to change another point (the host may not send POINT for a point
 141 on the same CDU until then).
 142
 143 Currently there is only one CDU so P is always 0 (but the PICs need
 144 not check that the received P value is 0; they may simply assume it).
 145
 146
 147     ----ON-----> CDU is  ------CHARGED---> CDU is charged
 148                  charging              _.  and ready
 149                                        /|
 150                         ,----CHARGED--'       |
 151                        /                      |POINT
 152                       /                       |
 153            Point has '                        V
 154          changed; CDU
 155         is recharging  <----POINTED----  Point is changing
 156
 157
 158
 159 PING and PONG
 160 -------------
 161
 162 The host may send PING at any time; the PIC should reply with PONG
 163 with the same X as was in the PING message.  The host may not send
 164 another PING until the first one's PONG has come back.
 165
 166
 167 POLARITY and POLARISED
 168 ----------------------
 169
 170 The POLARITY command may be sent whether the track power is enabled or
 171 disabled.  The polarity of each segment is `unreversed' after ON; it
 172 remains constant until from then on except as modified by POLARITY.
 173
 174 The command is of variable length (but at least two bytes):
 175
 176  > 1 0010 RRR  E RRR...         POLARITY  Set polarity
 177
 178 Each byte after the first contains 7 more R bits.  The first R bit
 179 (most significant R bit in the first byte) corresponds to track
 180 reversal segment 1; The next bit (2nd most significant bit in the
 181 first byte) corresponds to track reversal segment 2; and so on.
 182
 183 Bits which do not correspond to defined reversal segments will be
 184 ignored by the PICs.  The host must send exactly as many bytes as are
 185 necessary to include all of the reversal segments for each reversers
 186 board (for every potential reversal segment, regardless of whether
 187 that segment is a defined segment corresponding to some actual track).
 188
 189 For example, if there are 14 reversible segments (numbered 1 to 14)
 190 then the following message
 191    1 0010 000    1 000 1000    0 111 1010     Actual message
 192   (E      RRR)  (E RRR RRRR)  (E RRR R---)    } helpful annotations
 193                           1      111 1111     }  and commentary
 194           123      456 7890      123 4567     }
 195 specifies to reverse segments 7 and 11 to 14.  The trailing bits are
 196 for segments 15 to 17 and are ignored.  (Note that the assignment of
 197 physical segments to segment numbers is complex due to bit-twiddling.
 198 see detpic/reverse.asm and layout/data2safety.)
 199
 200 The PIC will reply to POLARITY with POLARISED when the polarity change
 201 is complete.  The host must not send another POLARITY until then.
 202
 203
 204 NMRADATA and NMRAFULL
 205 ---------------------
 206
 207 The data bits in all of the bytes of the NMRADATA command (including
 208 the first) are simply transmitted as NMRA data to the track (most
 209 significant bit first).  The top `end of packet' bit is not
 210 transmitted, though.
 211
 212 The first 14 data bits in the NMRA packet should be 1s.  (i.e. the
 213 first two complete bytes should be 11111111 11111111).  Packets
 214 beginning with a different first byte are reserved for other commands
 215 to the PIC and the 14 idle bits are a requirement of the NMRA
 216 specification.
 217
 218 The maximum NMRA message length is 15 bytes each carrying 7 bits of
 219 actual NMRA data (i.e. 105 bits).
 220
 221 Up to three NMRADATA commands may be supplied by the host to the
 222 master PIC, and their will be transmitted in sequence.  After each
 223 NMRADATA is completed, the PIC will send an NMRAFULL message to the
 224 host.  In the NMRAFULL message, F is the number of completely-received
 225 NMRADATA commands awaiting transmission to the track.
 226
 227 If the PIC runs out of NMRA data, it will transmit an NMRA idle
 228 stream.  It is an error for the host to try to have more than three
 229 outstanding NMRADATA commands.
 230
 231
 232 DETECT
 233 ------
 234
 235 The DETECT command indicates to the host whether there is currently a
 236 train being detected at a specific location.  The PIC must send a
 237 DETECT with Y=1 when a train is detected in a location where there was
 238 previously none, and with Y=0 when a train ceases to be detectable for
 239 more than a small amount of time.
 240
 241 At HELLO, the host will assume that no trains are being detected.
 242
 243
 244 RAM (data) memory map
 245 =====================
 246
 247 The data memory map (for PIC18F458) looks like this:
 248
 249  0x000-0x05f    Access bank RAM - RAM locations accessible via
 250                  access bank instructions; also form part of
 251                  RAM page 0
 252  0x060-0x0ff    Remainder of RAM page 0, accessible only via correct
 253                  BSR setting (ie, BSR==0), INDF, etc.
 254
 255  0x100-0x1ff    RAM page 1, accessible only via bank switching etc.
 256  0x200-0x2ff    RAM page 2, accessible only via bank switching etc.
 257  0x300-0x3ff    RAM page 3, accessible only via bank switching etc.
 258  0x400-0x4ff    RAM page 4, accessible only via bank switching etc.
 259  0x500-0x5ff    RAM page 5, accessible only via bank switching etc.
 260
 261  0x600-0xeff    Nothing here, don't try to access.
 262
 263  0xf00-0xf5f    SFR's (memory-mapped peripherals etc.) accessible
 264                  only via correct BSR, INDF, etc - but these are only
 265                  the CAN SFR's and we do not use the CAN controller.
 266  0xf60-0xfff    SFR's accessible via access bank (also form part
 267                  of RAM page 15).
 268
 269
 270 See common.inc for actual uses of the RAM areas.
 271
 272
 273 Program (flash etc.) memory map
 274 ===============================
 275
 276 Program memory map (for PIC18F458) looks like this:
 277
 278   0x00 0000-    Program memory
 279   0x00 7fff      Contains actual program instructions and can also
 280                  contain preprogrammed data provided via special .asm
 281                  files.  Notable contents and addresses:
 282                    0x00 0000  reset vector
 283                    0x00 0008  high-priority interrupt vector
 284                    0x00 0018  low-priority interrupt vector
 285                  See common.inc for some special tables in here, for
 286                  morse messages, pin/hardware-object definitions, etc.
 287
 288   0x20 0000-    ID locations
 289   0x20 0007      Programming which varies per PIC.  Programmed by
 290                  idlocs*.asm which are made by make-idlocs and
 291                  included in perpic*.hex.  Contents:
 292
 293                 0x20 0000
 294                   bits 7-5 = 000
 295                   bits 4-0 = PIC number (guaranteed to be
 296                              in the range 0..31 inclusive)
 297                 0x20 0001
 298                   bit 7     = 1 for the main PIC (#0)
 299                               0 otherwise
 300                   bit 6     = 1 for Reversers board, 0 for Detectors
 301                   bits 0-5  = currently unused, set to 0
 302
 303                 0x20 0002-  } not currently used,
 304                 0x20 0007   }  may contain anything
 305
 306   0x30 0000-    Hardware configuration
 307   0x30 000f      Defines (clock source, WDT operation, etc.)
 308                  Probably best not to touch.  `config.asm' provides
 309                  correct contents, which is included in *-withcfg.hex
 310                  and perpic*.hex.
 311
 312   0x3f fffe-    Hardware device ID
 313   0x3f ffff      Fixed at manufacturing time; can be read to discover
 314                  hardware type and version (probably not very useful)
 315
 316   0xf0 0000-    EEPROM data area
 317   0xf0 00ff      Not currently used by us
 318
 319   0x01 0000-    } These locations, not listed above,
 320   0x1f ffff     }   do not correspond to anything - there
 321   0x20 0008-    }   is no hardware or memory in the chip
 322   0x2f ffff     }   at these locations.
 323   0x30 0010-    }
 324   0x3f fffd     } Accessing them isn't useful
 325   0x40 0000-    }   and should probably be avoided.
 326   0xef ffff     }
 327
 328
 329 (Buffer page 50 0000h reserved for NMRA)    XXXX these look wrong
 330 (Buffer page 40 0000h reserved for i2c)     XXXX   -iwj
 331
 332
 333
 334 I2C
 335 ===
 336 (slave addresses will be 10xxxxx where xxxxx=PIC number above)