aboutsummaryrefslogtreecommitdiff
path: root/src/modules/px4iofirmware/protocol.h
diff options
context:
space:
mode:
authorpx4dev <px4@purgatory.org>2013-05-22 22:09:00 +0200
committerpx4dev <px4@purgatory.org>2013-05-22 22:09:00 +0200
commit308ec6001a2e1ac31ea818b1d482a34b8ed0099b (patch)
treeaba047ec67024b49b0fce8f98d5955835ec9747a /src/modules/px4iofirmware/protocol.h
parent437d9e4180b6248d0f0a4176c875b41deceef17d (diff)
downloadpx4-firmware-308ec6001a2e1ac31ea818b1d482a34b8ed0099b.tar.gz
px4-firmware-308ec6001a2e1ac31ea818b1d482a34b8ed0099b.tar.bz2
px4-firmware-308ec6001a2e1ac31ea818b1d482a34b8ed0099b.zip
Add serial read-length handling.
Diffstat (limited to 'src/modules/px4iofirmware/protocol.h')
-rw-r--r--src/modules/px4iofirmware/protocol.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/modules/px4iofirmware/protocol.h b/src/modules/px4iofirmware/protocol.h
index 29107f79f..6cdf86b2b 100644
--- a/src/modules/px4iofirmware/protocol.h
+++ b/src/modules/px4iofirmware/protocol.h
@@ -36,7 +36,8 @@
/**
* @file protocol.h
*
- * PX4IO interface protocol.
+ * PX4IO interface protocol
+ * ========================
*
* Communication is performed via writes to and reads from 16-bit virtual
* registers organised into pages of 255 registers each.
@@ -63,19 +64,21 @@
* readable pages to be densely packed. Page numbers do not need to be
* packed.
*
- * PX4IO I2C interface notes:
+ * PX4IO I2C interface notes
+ * -------------------------
*
* Register read/write operations are mapped directly to PX4IO register
* read/write operations.
*
- * PX4IO Serial interface notes:
+ * PX4IO Serial interface notes
+ * ----------------------------
*
* The MSB of the page number is used to distinguish between read and
* write operations. If set, the operation is a write and additional
* data is expected to follow in the packet as for I2C writes.
*
* If clear, the packet is expected to contain a single byte giving the
- * number of bytes to be read. PX4IO will respond with a packet containing
+ * number of registers to be read. PX4IO will respond with a packet containing
* the same header (page, offset) and the requested data.
*
* If a read is requested when PX4IO does not have buffer space to store