ALSA: dice: document quadlet alignment
authorClemens Ladisch <clemens@ladisch.de>
Sun, 8 Jan 2012 21:18:00 +0000 (22:18 +0100)
committerClemens Ladisch <clemens@ladisch.de>
Sun, 20 Oct 2013 20:07:57 +0000 (22:07 +0200)
Doing accesses without quadlet alignment is a bad idea because the
firmware's byte-swapping would garble the data; clarify this in the
documentation.

Signed-off-by: Clemens Ladisch <clemens@ladisch.de>
sound/firewire/dice-interface.h

index af916b9d07a49376b732800d7987cb7ec6ab373a..27b044f84c816f5b4f15efa9782b7c4fbd1a217d 100644 (file)
@@ -7,9 +7,9 @@
 
 /*
  * Generally, all registers can be read like memory, i.e., with quadlet read or
- * block read transactions with any alignment or length.  Writes are not
- * allowed except where noted; quadlet-sized registers must be written with
- * a quadlet write transaction.
+ * block read transactions with at least quadlet-aligned offset and length.
+ * Writes are not allowed except where noted; quadlet-sized registers must be
+ * written with a quadlet write transaction.
  *
  * All values are in big endian.  The DICE firmware runs on a little-endian CPU
  * and just byte-swaps _all_ quadlets on the bus, so values without endianness