summaryrefslogtreecommitdiffstats
path: root/c-user/io/introduction.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-29 16:42:22 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-10-11 15:26:38 +0200
commit4aae24d5b5cd9aa33ecf857d0f51210437d9b098 (patch)
treebbde9414aed368e866cec5ff7efe2ecb7dbca865 /c-user/io/introduction.rst
parenteng: Add placement link role (diff)
downloadrtems-docs-4aae24d5b5cd9aa33ecf857d0f51210437d9b098.tar.bz2
c-user: Generate I/O Manager documentation
The manager documentation is a consolidation of the comments in Doxygen markup and the documentation sources in Sphinx markup. The documentation was transfered to interface specification items. This header file was generated from the items by a script. Update #3993.
Diffstat (limited to '')
-rw-r--r--c-user/io/introduction.rst62
1 files changed, 49 insertions, 13 deletions
diff --git a/c-user/io/introduction.rst b/c-user/io/introduction.rst
index e097c7f..7368e8a 100644
--- a/c-user/io/introduction.rst
+++ b/c-user/io/introduction.rst
@@ -1,30 +1,66 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
+.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. Do not manually edit this file. It is part of the RTEMS quality process
+.. and was automatically generated.
+..
+.. If you find something that needs to be fixed or worded better please
+.. post a report to an RTEMS mailing list or raise a bug report:
+..
+.. https://docs.rtems.org/branches/master/user/support/bugs.html
+..
+.. For information on updating and regenerating please refer to:
+..
+.. https://docs.rtems.org/branches/master/eng/req/howto.html
+
+.. Generated from spec:/rtems/io/if/group
+
+.. _IOManagerIntroduction:
+
Introduction
============
-The input/output interface manager provides a well-defined mechanism for
-accessing device drivers and a structured methodology for organizing device
-drivers. The directives provided by the I/O manager are:
+.. The following list was generated from:
+.. spec:/rtems/io/if/register-driver
+.. spec:/rtems/io/if/unregister-driver
+.. spec:/rtems/io/if/initialize
+.. spec:/rtems/io/if/register-name
+.. spec:/rtems/io/if/open
+.. spec:/rtems/io/if/close
+.. spec:/rtems/io/if/read
+.. spec:/rtems/io/if/write
+.. spec:/rtems/io/if/control
-- :ref:`rtems_io_initialize`
+The Input/Output (I/O) Manager provides a well-defined mechanism for accessing
+device drivers and a structured methodology for organizing device drivers. The
+directives provided by the I/O Manager are:
-- :ref:`rtems_io_register_driver`
+* :ref:`InterfaceRtemsIoRegisterDriver` - Registers and initializes the device
+ with the specified device driver address table and device major number in the
+ Device Driver Table.
-- :ref:`rtems_io_unregister_driver`
+* :ref:`InterfaceRtemsIoUnregisterDriver` - Removes a device driver specified
+ by the device major number from the Device Driver Table.
-- :ref:`rtems_io_register_name`
+* :ref:`InterfaceRtemsIoInitialize` - Initializes the device specified by the
+ device major and minor numbers.
-- :ref:`rtems_io_lookup_name`
+* :ref:`InterfaceRtemsIoRegisterName` - Registers the device specified by the
+ device major and minor numbers in the file system under the specified name.
-- :ref:`rtems_io_open`
+* :ref:`InterfaceRtemsIoOpen` - Opens the device specified by the device major
+ and minor numbers.
-- :ref:`rtems_io_close`
+* :ref:`InterfaceRtemsIoClose` - Closes the device specified by the device
+ major and minor numbers.
-- :ref:`rtems_io_read`
+* :ref:`InterfaceRtemsIoRead` - Reads from the device specified by the device
+ major and minor numbers.
-- :ref:`rtems_io_write`
+* :ref:`InterfaceRtemsIoWrite` - Writes to the device specified by the device
+ major and minor numbers.
-- :ref:`rtems_io_control`
+* :ref:`InterfaceRtemsIoControl` - Controls the device specified by the device
+ major and minor numbers.