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