summaryrefslogtreecommitdiff
path: root/examples/send_packet_precisely/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/send_packet_precisely/README')
-rw-r--r--examples/send_packet_precisely/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/examples/send_packet_precisely/README b/examples/send_packet_precisely/README
new file mode 100644
index 00000000..20b88fd8
--- /dev/null
+++ b/examples/send_packet_precisely/README
@@ -0,0 +1,25 @@
+EXAMPLE APPLICATIONS
+
+The 'send_packet_precisely' application illustrates the various steps to schedule
+packets for sending.
+
+The simple spp application requires root permissions to execute and
+attach to the driver.
+ sudo ./send_packet_precisely
+
+To exit the app, hit Ctrl-C. The application gracefully tears down
+the connection to the driver. If the application unexpectedly aborts the
+kernel-mode driver also reclaims the various buffers and attempts to clean up.
+The application should be able to re-initialize and use the transmit queues
+without restarting the driver.
+
+/* Note this application requires using the provided gptp timesync daemon to
+provide the 802.1AS presentation times included in the 1722 frames. */
+
+Lastly, to build the application, you need to have the pciutils library
+installed. the latest version can be downloaded from:
+
+ < ftp://ftp.kernel.org/pub/software/utils/pciutils/ >.
+
+Download and extract the library, and run 'make;make install;make install-lib'.
+