comparison include/BeagleRT.h @ 48:42a683058b6a newapi

Documentation updates, and move some defines from BeagleRT.h into specific projects where they are used

  *  of the Hackable Instruments project (EPSRC) at Queen Mary University
  *  of London, 2013-14.
  *
  *  (c) 2014-15 Andrew McPherson, Victor Zappi and Giulio Moro,
  *  Queen Mary University of London
+ */
+
+/**
+ * \mainpage
+ *
+ * BeagleRT is a hard-real-time, ultra-low latency audio and sensor environment for
+ * BeagleBone Black, which works with the BeagleBone Audio Cape or a custom "BeagleRT Cape"
+ * which incorporates stereo audio with 8x, 16-bit analog inputs and outputs.
+ *
+ * BeagleRT is based on the Xenomai real-time Linux extensions (http://xenomai.org) and
+ * uses the BeagleBone %PRU subsystem to address the audio and sensor hardware.
+ *
+ * Further information can be found at http://beaglert.cc
  */
 
 
 #ifndef BEAGLERT_H_
 #define BEAGLERT_H_

 #define BEAGLERT_FLAG_INTERLEAVED				(1 << 0)	// Set if buffers are interleaved
 /**
  * Flag for BeagleRTContext. If set, indicates analog outputs persist for future frames.
  */
 #define BEAGLERT_FLAG_ANALOG_OUTPUTS_PERSIST	(1 << 1)	// Set if analog/digital outputs persist for future buffers
-
-// Mappings from pin numbers on PCB to actual DAC channels
-// This gives the DAC and ADC connectors the same effective pinout
-#define DAC_PIN0	6
-#define DAC_PIN1	4
-#define DAC_PIN2	2
-#define DAC_PIN3	0
-#define DAC_PIN4	1
-#define DAC_PIN5	3
-#define DAC_PIN6	5
-#define DAC_PIN7	7
-
-#define ADC_PIN0	0
-#define ADC_PIN1	1
-#define ADC_PIN2	2
-#define ADC_PIN3	3
-#define ADC_PIN4	4
-#define ADC_PIN5	5
-#define ADC_PIN6	6
-#define ADC_PIN7	7
 
 /**
  * \ingroup control
  * \brief Structure containing initialisation parameters for the real-time
  * audio control system.