summaryrefslogtreecommitdiffstats
path: root/cpukit/sapi/include/rtems/io.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-18 15:46:38 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-18 15:46:38 -0500
commit11109ea227913904ae24b68ada25a9a18d73ec4c (patch)
tree8282b9742bf53758929a77a2575664b7e21221ad /cpukit/sapi/include/rtems/io.h
parentposix: Doxygen Enhancement Task #11 (diff)
downloadrtems-11109ea227913904ae24b68ada25a9a18d73ec4c.tar.bz2
libfs: Doxygen Enhancement Task #2
http://www.google-melange.com/gci/task/view/google/gci2012/8032207
Diffstat (limited to '')
-rw-r--r--cpukit/sapi/include/rtems/io.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/cpukit/sapi/include/rtems/io.h b/cpukit/sapi/include/rtems/io.h
index f4e7d49edc..2a268fa51e 100644
--- a/cpukit/sapi/include/rtems/io.h
+++ b/cpukit/sapi/include/rtems/io.h
@@ -4,6 +4,9 @@
* @ingroup ClassicIO
*
* @brief Classic Input/Output Manager API.
+ *
+ * This file emulates the old Classic RTEMS IO manager directives
+ * which register and lookup names using the in-memory filesystem.
*/
/*
@@ -115,9 +118,11 @@ rtems_status_code rtems_io_unregister_driver(
/**
* @brief Registers the name @a device_name in the file system for the device
* with number tuple @a major and @a minor.
+ *
+ * This assumes that all registered devices are character devices.
*
* @retval RTEMS_SUCCESSFUL Name successfully registered.
- * @retval RTEMS_TOO_MANY Name already in use or other errors.
+ * @retval RTEMS_TOO_MANY Name already in use or other errors.
*/
rtems_status_code rtems_io_register_name(
const char *device_name,