Merged r10418:10423 from jcorgan/pps into trunk. Adds usrp2::sync_every_pps

[debian/gnuradio] / usrp2 / firmware / lib / memory_map.h

diff --git a/usrp2/firmware/lib/memory_map.h b/usrp2/firmware/lib/memory_map.h
index 0519282bb2629f833f6f5a7970b7689aaf2e0a05..f4bf4201018b450ae66046d0ffe94fdf02ee8443 100644 (file)
--- a/usrp2/firmware/lib/memory_map.h
+++ b/usrp2/firmware/lib/memory_map.h
@@ -629,6 +629,25 @@ typedef struct {
 #define TIMESYNC_BASE  0xE800
 
 typedef struct {
+  /*!
+   * \brief Time sync configuration.
+   *
+   * <pre>
+   *
+   *    3                   2                   1                       
+   *  1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
+   * +-----------------------------------------------------+-+-+-+-+-+
+   * |                                                     |T|G|X|I|S|
+   * +-----------------------------------------------------+-+-+-+-+-+
+   *
+   * S - Tick source (0 = free run, 1 = pps, default=0)
+   * I - Tick interrupt enable (not implemented)
+   * X - Use external sync source (default=1)
+   * G - PPS edge selection (0=negedge, 1=posedge, default=0)
+   * T - Trigger sync every pps edge (default=0)
+   *
+   * </pre>
+   */
   volatile uint32_t tick_control;
   volatile uint32_t tick_interval;
   volatile uint32_t delta_time;