summaryrefslogtreecommitdiff
path: root/examples/atl_simple_talker/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/atl_simple_talker/README')
-rw-r--r--examples/atl_simple_talker/README29
1 files changed, 29 insertions, 0 deletions
diff --git a/examples/atl_simple_talker/README b/examples/atl_simple_talker/README
new file mode 100644
index 00000000..93a778e6
--- /dev/null
+++ b/examples/atl_simple_talker/README
@@ -0,0 +1,29 @@
+EXAMPLE APPLICATIONS
+
+The 'simple_talker' application illustrates the various steps to publish a stream
+and streaming 1722/61883 audio frames after a listener connects. The audio is a
+simple sine wave. This application was tested with AQC107 as talker, and i210
+running existing simple_listener application.
+
+The simple talker application requires root permissions to execute and
+attach to the driver.
+ sudo ./simple_talker
+
+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. This
+application also requires the mrpd daemon to be running to detect and
+establish various stream reservation parameters.
+
+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'.
+