aboutsummaryrefslogtreecommitdiff
path: root/nuttx/drivers/sercomm
diff options
context:
space:
mode:
authorpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2012-03-24 22:39:52 +0000
committerpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2012-03-24 22:39:52 +0000
commitbfbf2cccdf561405f6fe6d07ca9bd05844d2a342 (patch)
tree9d17b838409ed72734f9362eab88660822390803 /nuttx/drivers/sercomm
parent285a023286cbf59fdb2d970b4dc2b0896f3a541f (diff)
downloadpx4-firmware-bfbf2cccdf561405f6fe6d07ca9bd05844d2a342.tar.gz
px4-firmware-bfbf2cccdf561405f6fe6d07ca9bd05844d2a342.tar.bz2
px4-firmware-bfbf2cccdf561405f6fe6d07ca9bd05844d2a342.zip
Additional documentation/README updates
git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@4519 7fd9a85b-ad96-42d3-883c-3090e2eb8679
Diffstat (limited to 'nuttx/drivers/sercomm')
-rwxr-xr-xnuttx/drivers/sercomm/README.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/nuttx/drivers/sercomm/README.txt b/nuttx/drivers/sercomm/README.txt
new file mode 100755
index 000000000..a9239a204
--- /dev/null
+++ b/nuttx/drivers/sercomm/README.txt
@@ -0,0 +1,19 @@
+drivers/sercomm README
+======================
+
+If CONFIG_SERCOMM_CONSOLE is defined in the NuttX configuration file, NuttX
+will attempt to use sercomm (HDLC protocol) to communicate with the
+host system. Sercomm is the transport used by osmocom-bb that runs on top
+of serial. See http://bb.osmocom.org/trac/wiki/nuttx-bb/run for detailed
+the usage of nuttx with sercomm.
+
+The drivers/sercomm build that you have the osmocom-bb project directory
+at same level as the nuttx project:
+
+ |- nuttx
+ |- apps
+ `- osmocom-bb
+
+If you attempt to build this driver without osmocom-bb, you will get
+compilation errors because ofheader files that are needed from the
+osmocom-bb directory.