Changeset 1532

Timestamp:

03/29/09 18:00:32 (15 years ago)

Author:

jwoithe

Message:

RME: documentation updates
RME: clean up some compile warnings
RME: introduce new defines for future work

Files:

• trunk/libffado/doc/rme_notes/rme_config_register_map.txt (modified) (6 diffs)
• trunk/libffado/src/rme/rme_avdevice.cpp (modified) (3 diffs)
• trunk/libffado/src/rme/rme_avdevice.h (modified) (2 diffs)

trunk/libffado/doc/rme_notes/rme_config_register_map.txt

@@ -2 +2 @@
-============================================
-
-5
+6
-Author: Jonathan Woithe
-15
+27
-
-
@@ -13 +13 @@
-FF800 = Fireface-800
-FF400 = Fireface-400
+
+Multi-byte values sent to/from the Fireface are generally little endian.
-
-
@@ -142 +144 @@
-
-
-Waiting for
-
+Interfacing to
+---
-
-To preserve the device's settings across power cycles the settings are
@@ -149 +151 @@
-initialisation to ensure the driver's status agrees with that of the device.
-
+There are several classes of things stored in flash: operational settings,
+volumes (ie: the mixer status) and configuration/firmware.  Device settings
+start at address 0x3000f0000 on the FF800 and 0x00060000 on the FF400.
+
+Mixer (volume) data starts at 0x3000e0000 on the FF800 and 0x00060000 on the
+FF400.  Mixer volumes are written in 64-quadlet (256-byte) blocks, one per
+hardware channel.  There are 28 hardware channels for the FF800 and 18 for
+the FF400.
+
+There are several control groups in the mixer:
+  0xe0000 (FF800): "mixer shadow", FF800 only, meaning unclear
+  0xe2000 (FF800) / 0x70000 (FF400), 0x0800 bytes: 16-bit volume array
+  0xe2800 (FF800) / 0x70800 (FF400), 0x0800 bytes: 16-bit pan array
+  0xe3000 (FF800) / 0x71000 (FF400), 0x0040 bytes: 16-bit "vol3" array + 
+    "enable MIDI" + "submix" + zero padding to 64 bytes
+The third row are the "hardware output volumes".
+
+The meaning of the "mixer shadow" section of the mixer flash is not
+understood at present.
+
+
+Reading the flash
+
+For the FF800 the entire buffer is read directly from flash as a single block.
+Polling for "device not busy" should commence after a wait of 5 ms.
+
+For the FF400, the buffer is read in 32-quadlet sub-blocks.  A partial block
+is read at the end if the total buffer size is not a multiple of
+32-quadlets.  To read a sub-block, the address is placed in register
+0x80100288 and the sub-block size (in bytes) in 0x8010028c.  A 0x02 is
+then written to CBA+(8*4) to initiate the read.  Polling for "device not
+busy" should commence after a wait of 2 ms.
+
+
+Writing the flash
+
+For the FF800, the entire buffer is written to flash as a single block.
+Polling for "device not busy" should commence after a wait of 5 ms.
+
+For the FF400, the buffer is written in 32-quadlet (128-byte) sub-blocks via
+a bounce buffer.  If the final sub-block is not 32-quadlets the write is only
+as big as the sub-block (that is, no padding takes place).  The sub-block
+data to be written is sent to register 0x80100290.  The 2-quadlet register
+at 0x80100288 is set with the flash address to write the block to and the
+size (in bytes) of the data block.  Finally, a 0x1 is written to CBA+(8*4)
+to initiate the write.  Polling for "device not busy" should commence after
+a wait of 2 ms.
+
+
+Erasing the flash
+
+The flash is divided into sections and it is possible to erase each section
+separately.  Therefore one only has to erase section of interest when
+changing something.
+
+On the FF400, erasure is controlled by writing a special magic number to
+the the flash erase control register (CBA+8*4):
+  Erase volume: write 0xe
+  Erase settings: write 0xd
+  Erase configuration (firmware): write 0xc
+
+On the FF800, erasing is controlled by writing 0 to the applicable register:
+  Erase volume: register is 0x3fffffff4
+  Erase settings: register is 0x3fffffff0
+  Erase firmware: register is 0x3fffffff8
+  Erase configuration: register is 0x3fffffffc
+
+It's not clear what the distinction between "configuration" and "firmware"
+is.  The FF400 appears to only support "configuration" but treats this as
+"firmware".  The FF800 supports both as distinct options.
+
+After issuing the erase command one should wait for 500 ms before polling
+the device for the "not busy" status.
+
+
+Waiting for flash
+
-When interacting with the device's flash memory one must wait for the
-completion of an operation before attempting another.  The location of the
@@ -163 +242 @@
-point in polling the device busy flag until at least this much time has
-elapsed.
+
+
+Device settings format
+----------------------
+
+The device settings are stored in flash as an array of 32 bit unsigned
+integers.  These are:
+  - Device ID
+  - Device revision
+  - ASIO latency
+  - Samples per frame
+  SPDIF input mode (0=coax?, 1=optical?)
+  SPDIF output emphasis active
+  SPDIF output is "professional" (ie: AES/EBU)
+  Clock mode (0=master?, 1=autosync?)
+  SPDIF output is non-audio (eg: AC3 passthrough)
+  Sync reference
+  SPDIF output mode (0=coax?, 1=optical?)
+  - Check input
+  - Status
+  - Register[4]
+  - Iso receive channel
+  - Iso transmit channel
+  - Timecode
+  - Number of devices
+  - TMS
+  - Speed
+  - Channels available (high)
+  - Channels available (low)
+  Limit bandwidth setting
+  - Bandwidth allocated
+  - Stop on dropout
+  Input level 
+  Output level
+  Mic level [0] - FF400:Phoneslevel-1 / F800:AnalogInput[1]* ???
+  Mic level [1] - AnalogInput[2] ???
+  Mic phantom power [4]
+  Instrument - AnalogInput[0]-1 ???
+  Filter (aka speaker emulation)
+  Fuzz (aka drive)
+  Sync align
+  - Device index
+  - Advanced dialog
+  Sample rate
+  - Interleaved
+  - Sn
+  Word clock single speed
+  - Number of channels
+  - Dropped samples
+  p12db_an[0] - Limiter==0&&AnalogInput[0]==2*: 1 else 0 ???
+  - p12db_an[1-9]
+
+"-" = elements not used
-
-
@@ -193 +325 @@
-Device (streaming) start register (FF800: 0x200000028, FF400: CBA+0x1c):
-
-800 in more than just the
-
+400 and FF800 in more than just
+the 
-as follows:
-  bits 10-0 = number of audio channels

trunk/libffado/src/rme/rme_avdevice.cpp

@@ -47 +47 @@
-static VendorModelEntry supportedDeviceList[] =
-{
-
-
+
+
+
-};
-
@@ -275 +276 @@
-
-unsigned int 
-unsigned in
+fb_nodeaddr_
-
-    quadlet_t quadlet;
@@ -287 +288 @@
-
-signed int
-unsigned in
+fb_nodeaddr_
-
-    unsigned int err = 0;

trunk/libffado/src/rme/rme_avdevice.h

@@ -55 +55 @@
-    unsigned int unit_version;
-    enum ERmeModel model;
-
-
+onst c
+onst c
-};
-
@@ -92 +92 @@
-    virtual bool stopStreamByIndex(int i);
-
-unsigned in
-unsigned in
+fb_nodeaddr_
+fb_nodeaddr_
-
-protected: