new scxi README from Caleb Tennis

diff --git a/scxi/Makefile.am b/scxi/Makefile.am
index ba1823a8d566420f8af200ac206e1e190da5ca91..62a48b9dd741e0f13a158d9dcfc7f49afbfb9edb 100644 (file)
--- a/scxi/Makefile.am
+++ b/scxi/Makefile.am
@@ -1,4 +1,6 @@
 
+EXTRA_DIST = README
+
 if BUILD_SCXI
 lib_LTLIBRARIES = libscxi.la
 else

diff --git a/scxi/README b/scxi/README
new file mode 100644 (file)
index 0000000..b1740c8
--- /dev/null
+++ b/scxi/README
@@ -0,0 +1,37 @@
+Comedi SCXI Documentation - Caleb Tennis (caleb@aei-tech.com)
+
+SCXI is a National Instruments standard for signal conditioning.  It encompasses a set of
+hardware that has the capability of reading and writing multiple types of channels via a
+regular data acqusition card.
+
+A SCXI system consists of a chassis with one or more SCXI modules located inside.  The system
+is connected via a cable to the data acquisition system, which communicates with the modules.
+
+Comedi's SCXI support is available in a library, which will be built alongside the regular comedilib
+if the --enable-scxi option is passed during ./configure time
+
+
+
+The following functions are available:
+
+
+scxi_mod_t *comedi_scxi_open(comedi_t *dev, unsigned short chassis_address, unsigned short mod_slot)
+
+This function initializes the scxi module within a certain chassis and slot.  Returns a pointer
+to a scxi_module_struct which contains all of the pertinent information about the SCXI module.  It
+also attempts to figure out which module is located in the slot based on the information returned
+from the module.
+
+
+
+void comedi_scxi_close(scxi_mod_t *)
+
+Closes the SCXI module
+
+
+
+int comedi_scxi_register_readwrite(scxi_mod_t *mod, unsigned short reg_address, 
+                               unsigned int num_bytes, unsigned char *data_out, unsigned char *data_in)
+                        
+This is the low level function for communicating with the SCXI module.  It reads/writes the data
+in/out of the register.