summaryrefslogtreecommitdiff
path: root/src/hal/drivers/mesa-hostmot2/doc/encoder/index.html
blob: da77e7532b9be2db38fcd9ca79bc92d2cc307b7f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858

<html>

<head>
<title>HostMot2 Encoder</title>
</head>


<body>
<center>

<table width=1000 cellpadding=10 border=1>

    <tr>
        <td>

            <p>Velocity estimation is made possible by a cool feature
            of the HostMot2 firmware:

            <p>The FPGA synthesizes a configurable-frequency "timestamp
            clock" by dividing ClockLow by the value in the Quadrature
            Counter Timestamp Divider Register.  ClockLow is 33 MHz on
            the PCI cards and 50 MHz on the 7i43.

            <p>The current value of the Timestamp Clock can be read from
            the 16-bit Timestamp Count (TSC) register.

            <p>When a quadrature counter instance in the HostMot2 FPGA
            detects a transition in its input Gray code, it increments
            the count and latches both the (16-bit) count and the 16
            bits of the timestamp clock into the Counter Register.

        </td>
    </tr>

    <tr>
        <td colspan=2>
            <p>Some Random Notes:
            <ul>

                <li><p>The encoder Count & Time ("C&T") are both 16-bit
                registers, which are latched and read together.

                <li><p>The encoder Count is initialized to 0 at firmware
                load time.

                <li><p>The Timestamp clock runs at 1 MHz (can run
                faster, but 1 meg is pretty fast and makes it easy to
                think about).

                <li><p>The Timestamp Counter is 16 bits wide.  It rolls
                over about every 65 milliseconds.

                <li><p>In the timing pics below i'm using a very
                slow servo loop of about 50 Hz.  The interval between
                reading the C&T register and the TSC register is also
                rediculously large.

            </ul>
        </td>
    </tr>
</table>


<br>
<hr>
<br>


<table width=1000 cellpadding=10 border=1>

    <tr>
        <td>

            <p>The velocity estimator used by the driver is similar
            to one described by David Auslander in a paper titled "<a
            href="http://repositories.cdlib.org/its/path/reports/UCB-ITS-PRR-95-3/">
            Vehicle-based Control Computer Systems</a>" (UCB ITS PRR
            95 3).

        </td>
    </tr>

    <tr>
        <td align=left valign=middle>
            <p>Algorithm notes:

            <ol>

                <li>

                    <p>The algorithm maintains some internal state.

                    <ul>

                        <li>

                            <p>Current-Motion-Mode: Stopped or Moving.

                            <ul>

                                <li><p><b>Stopped</b> means V=0 and there
                                is no known previous datapoint.  This is
                                the starting state.  If a new datapoint
                                comes while we're in the Stopped state,
                                we record the datapoint as the "old"
                                datapoint and move to the Moving state.

                                <li><p><b>Moving</b> means there is a
                                record of a recent previous datapoint
                                (Counts and Timestamp).  If we're in
                                the Moving state and no new datapoint
                                is seen for some runtime-configurable
                                amount of time (250 ms or so perhaps),
                                the algorithm forgets the old datapoint
                                and moves to the Stopped state.

                            </ul>

                        <li>

                            <p>Old datapoint: (Count, Timestamp) datapoint
                            of most recently seen encoder edge.

                            <p>Only valid when Current Motion Mode
                            is Moving.

                            <p>The count is the raw 16-bit count from
                            the firmware, extended to signed 32-bit.
                            In other words, the count in the datapoint
                            has been adjusted for rollover (both positive
                            and negative).

                            <p>The timestamp is the raw timestamp of
                            that edge.  Time has <b>not</b> been adjusted
                            for rollovers, that's handled elsewhere.

                        <li>

                            <p>R: The timestamp rollover counter.

                            <p>Only valid when Current Motion Mode
                            is Moving.

                            <p>This is the number of times the timestamp
                            clock has rolled over its 16-bit counter
                            since the "old" datapoint.

                        <li>

                            <p>Previous Time of Interest: This is a
                            relevant timestamp from the <b>previous</b>
                            time through the loop.  (Described in the
                            section on Rollover Detection below).

                            <p>Only valid when Motion Mode
                            is Moving.

                            <p>Think of this as "the time up through
                            which we've tracked TSC rollovers so far".

                    </ul>

                <li>

                    <p>On startup, the Current Motion Mode is set
                    to Stopped, so Old Datapoint, R, and PTI are all
                    dont-cares.

                <li>

                    <p>If the Motion Mode is Stopped and <b>no</b>
                    new datapoint comes in: Nothing to do, return.

                <li>
                
                    <p>If the Motion Mode is Stopped and a new datapoint comes in:

                    <ul>

                        <li>Set Old Datapoint to the new datapoint.

                        <li>Set R to 0.

                        <li>Set PTI to the new datapoint's timestamp.

                        <li>Set Motion Mode = Moving.

                        <li>Leave V at 0 for now.

                        <li>Finished!

                    </ul>

                <li>

                    <p>Motion Mode is Moving, <b>no</b> new datapoint
                    available:

                    <ul>

                        <li>TI = TSC, check for rollover.

                        <li>dT is ((TI - ODT) + (R * 2^16))

                        <li>dT > Horizon? If so V = 0 and MM = Stopped.

                        <li>Still waiting: use UBVE

                        <li>PTI = TI

                    </ul>


                <li>

                    <p>Motion Mode is Moving, new datapoint comes in:

                    <ul>

                        <li>TI = T, check for rollover

                        <li>dT is ((TI - ODT) + (R * 2^16))

                        <li>R = 0

                        <li>Use RTVE

                        <li>Old Datapoint = new datapoint.

                        <li>PTI = TI

                    </ul>


                <li><p>Rollover detection:

                    <ul>

                        <li><p>Rollover detection happens right after
                        reading the registers, before doing anything else.

                        <li><p>If there was a new datapoint, the <i>Time
                        of Interest</i> Ti is the datapoint's timestamp.

                        <li><p>If there was <b>no</b> new datapoint,
                        Ti is the TSC.

                        <li><p>If Ti &gt; 2^15, rollover detection reports
                        no rollover, records prevTi=Ti, and it's done.

                        <li><p>If Ti &gt; prevTi, rollover detection
                        reports no rollover, records prevTi=Ti, and
                        it's done.

                        <li><p>If we get here, it's a rollover!
                        Increment rollover count R.

                    </ul>

                <li>

                    <p>Relative Time Velocity Estimator (RTVE):

                    <p>Used when the C&T read indicates a new datapoint n
                    (in addition to having an old datapoint m).

                    <p>V = dS/dT = (Cn-Cm) / ((Tn-Tm) + (R*2^16))

                    <p>Reset R to 0.

                <li>

                    <p>Upper Bound Velocity Estimator (UBVE):

                    <p>Used when the C&T read indicates no new datapoint.

                    <p>So make one up (n), using the previous datapoint
                    m and the current TSC: (Cn=Cm+1, Tn=TSCn).  The Cm+1
                    is + or - 1 to be in the same direction as Vm

                    <p>V = dS/dT = (Cn-Cm) / ((Tn-Tm) + (R*2^16))

                    <p>There was no real datapoint, so we didn't use up
                    our rollovers, so we don't reset R to 0.

                <li>

                    <p>Timestamp clock speed and servo period are
                    constrained together.  C shows nearly a worst-case
                    scenario: edge comes just after the C&T read at 2,
                    gets picked up at 3, then we need to detect rollover
                    at 4.

                    <p>The servo frequency must be fast enough that Ti
                    has time to switch from an old datapoint-T to a TSC
                    before the rollover.  Two servo periods must be less
                    than half the rollover time.

            </ol>

        </td>
    </tr>
</table>





<br>

<table width=1000 cellpadding=10 border=1>

    <tr>
        <td>
            <p>Legend:
        </td>
        <td align=center valign=middle>
            <img src="legend.png">
        </td>
    </tr>

</table>




<br>

<table width=1000 cellpadding=10 border=1>

    <tr>

        <td align=center valign=middle>
            <p>
        </td>

        <td align=center valign=middle>
            <p>1. No encoder edge
        </td>

        <td align=center valign=middle>
            <p>2. Encoder edge before TSC read
        </td>

        <td align=center valign=middle>
            <p>3. Encoder edge between TSC read and C&T read
        </td>

    </tr>

    <tr>

        <td>
            <p>A. No rollover
        </td>

        <td align=center valign=middle>
            <img src="case-a1.png">
        </td>

        <td align=center valign=middle>
            <img src="case-a2.png">
        </td>

        <td align=center valign=middle>
            <img src="case-a3.png">
        </td>

    </tr>

    <tr>

        <td>
            <p>B. Rollover happens first
        </td>

        <td align=center valign=middle>
            <img src="case-b1.png">
        </td>

        <td align=center valign=middle>
            <img src="case-b2.png">
        </td>

        <td align=center valign=middle>
            <img src="case-b3.png">
        </td>

    </tr>

    <tr>

        <td>
            <p>C. Rollover happens second
        </td>

        <td align=center valign=middle>
            <img src="case-c1.png">
        </td>

        <td align=center valign=middle>
            <img src="case-c2.png">
        </td>

        <td align=center valign=middle>
            <img src="case-c3.png">
        </td>

    </tr>

    <tr>

        <td>
            <p>D. Rollover happens third
        </td>

        <td align=center valign=middle>
            <p>There is no Case D1
        </td>

        <td align=center valign=middle>
            <img src="case-d2.png">
        </td>

        <td align=center valign=middle>
            <img src="case-d3.png">
        </td>

    </tr>

</table>




<br>
<hr>
<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case A1: No rollover, no encoder edge.
        </td>
        <td align=center valign=middle>
            <img src="case-a1.png">
        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Stopped</td>

        <td>

            <p>Nothing to do.

        </td>

    </tr>

    <tr>

        <td><p>MM = Moving</td>

        <td>

            <p>TI is TSC.  Do rollover check.  We detect rollover here if
            PTI was pre-rollover, which means the previous time through
            the loop was case C1 or C2 or D2 or D3.

            <p>dT is ((TI - OT) + (R * 2^16)).  dT > Horizon? If so V =
            0 and MM = Stopped.

            <p>We'll wait a little longer, Use UBVE.

            <p>PTI gets the value of TI (TSC).

        </td>
    </tr>
</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case A2: No rollover, encoder edge before TSC read.
        </td>
        <td align=center valign=middle>
            <img src="case-a2.png">
        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Stopped</td>

        <td>

            <p>Old Datapoint = new datapoint

            <p>R = 0

            <p>MM = Moving

            <p>PTI = T

        </td>

    </tr>

    <tr>

        <td><p>MM = Moving</td>

        <td>

            <p>TI = T, do rollover detection.  We detect rollover here
            if PTI was pre-rollover.

            <p>Use RTVE.

            <p>OD = new datapoint

            <p>PTI = TI (= T)

        </td>
    </tr>
</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case A3: No rollover, encoder edge between TSC read and C&T read.
        </td>
        <td align=center valign=middle>
            <img src="case-a3.png">
        </td>
    </tr>

    <tr>
        <td colspan=2 align=left valign=middle>

            <p>Identical to A2.

        </td>
    </tr>
</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case B1: Rollover happens first, no encoder edge
        </td>
        <td align=center valign=middle>
            <img src="case-b1.png">
        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Stopped</td>

        <td align=left valign=middle>

            <p>Nothing happens.

        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Moving</td>

        <td align=left valign=middle>

            <p>TI = TSC.  Check for rollover.  Rollover detected, because
            PTI is either T or TSC from the previous servo loop, which
            ended just before the rollover.

            <p>Compute dT, check for Stop.

            <p>Use UBVE.

            <p>PTI = TI (= TSC)

        </td>
    </tr>

</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case B2: Rollover happens first, encoder edge before TSC read.
        </td>
        <td align=center valign=middle>
            <img src="case-b2.png">
        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Stopped</td>

        <td align=left valign=middle>

            <p>Identical to A2.

        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Moving</td>

        <td align=left valign=middle>

            <p>TI = T, check for rollover, rollover detected, because
            PTI is either T or TSC from the previous servo loop, which
            ended just before the rollover.

            <p>RTVE

            <p>PTI = TI (= T)

        </td>
    </tr>

</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case B3: Rollover happens first, encoder edge between TSC read and C&T read
        </td>
        <td align=center valign=middle>
            <img src="case-b3.png">
        </td>
    </tr>

    <tr>
        <td colspan=2 align=left valign=middle>

            <p>Identical to B2

        </td>
    </tr>
</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case C1: Rollover happens second, no encoder edge
        </td>
        <td align=center valign=middle>
            <img src="case-c1.png">
        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Stopped</td>

        <td align=left valign=middle>

            <p>Nothing to do.

        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Moving</td>

        <td align=left valign=middle>

            <p>TI = TSC, check for rollover, no rollover detected
            (because TSC is just before the rollover).

            <p>UBVE

            <p>PTI = TI (= TSC)

        </td>
    </tr>

</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case C2: Rollover happens second, encoder edge before TSC read.
        </td>
        <td align=center valign=middle>
            <img src="case-c2.png">
        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Stopped</td>

        <td align=left valign=middle>

            <p>Like A2.

        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Moving</td>

        <td align=left valign=middle>

            <p>TI = T, check for rollover, no rollover detected
            (because T is just before the rollover).

            <p>RTVE

            <p>PTI = TI (= T)

        </td>
    </tr>

</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case C3: Rollover happens second, encoder edge between TSC read and C&T read
        </td>
        <td align=center valign=middle>
            <img src="case-c3.png">
        </td>
    </tr>

    <tr>
        <td colspan=2 align=left valign=middle>

            <p>Identical to B2 and B3.

        </td>
    </tr>
</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case D2: Rollover happens third, encoder edge before TSC read.
        </td>
        <td align=center valign=middle>
            <img src="case-d2.png">
        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Stopped</td>

        <td align=left valign=middle>

            <p>Like A2.

        </td>
    </tr>

    <tr>
        <td align=left valign=middle><p>MM = Moving</td>

        <td align=left valign=middle>

            <p>TI = T, check for rollover, no rollover detected
            (because T is just before the rollover).

            <p>RTVE

            <p>PTI = TI (= T)

        </td>
    </tr>

</table>




<br>

<table width=1000 cellpadding=10 border=1>
    <tr>
        <td>
            <p>Case D3: Rollover happens third, encoder edge between TSC read and C&T read.
        </td>
        <td align=center valign=middle>
            <img src="case-d3.png">
        </td>
    </tr>

    <tr>
        <td colspan=2 align=left valign=middle>

            <p>Identical to D2.

        </td>
    </tr>
</table>




<br>
<hr>
<br>




</center>
</body>


</html>