summaryrefslogtreecommitdiffstats
path: root/c-user/config/device-driver.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-31 16:42:43 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-04-01 07:49:15 +0200
commit4032c96da9bce3d9a8224ffb06c278206d626241 (patch)
tree085b20c38fd9199d428172acdbe6ca6b35dd8605 /c-user/config/device-driver.rst
parentc-user: Use new template for integer config opts (diff)
downloadrtems-docs-4032c96da9bce3d9a8224ffb06c278206d626241.tar.bz2
c-user: Document all configuration options
Close #2806.
Diffstat (limited to 'c-user/config/device-driver.rst')
-rw-r--r--c-user/config/device-driver.rst81
1 files changed, 81 insertions, 0 deletions
diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst
index 0a18b2d..627c346 100644
--- a/c-user/config/device-driver.rst
+++ b/c-user/config/device-driver.rst
@@ -76,6 +76,33 @@ NOTES:
See :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS` for an alternative
placement of application device driver initializers.
+.. index:: CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER
+
+.. _CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER:
+
+CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER
+--------------------------------------
+
+CONSTANT:
+ ``CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER``
+
+OPTION TYPE:
+ This configuration option is a boolean feature define.
+
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the described feature is not
+ enabled.
+
+DESCRIPTION:
+ In case this configuration option is defined, then the ATA Driver is
+ initialized during system initialization.
+
+NOTES:
+ Most BSPs do not include support for an ATA Driver.
+
+ If this option is defined and the BSP does not have this device driver, then
+ the user will get a link time error for an undefined symbol.
+
.. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
.. _CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER:
@@ -178,6 +205,33 @@ NOTES:
If this option is defined and the BSP does not have this device driver, then
the user will get a link time error for an undefined symbol.
+.. index:: CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER
+
+.. _CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER:
+
+CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER
+--------------------------------------
+
+CONSTANT:
+ ``CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER``
+
+OPTION TYPE:
+ This configuration option is a boolean feature define.
+
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the described feature is not
+ enabled.
+
+DESCRIPTION:
+ In case this configuration option is defined, then the IDE Driver is
+ initialized during system initialization.
+
+NOTES:
+ Most BSPs do not include support for an IDE Driver.
+
+ If this option is defined and the BSP does not have this device driver, then
+ the user will get a link time error for an undefined symbol.
+
.. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
.. index:: /dev/null
@@ -471,6 +525,33 @@ NOTES:
See :ref:`CONFIGURE_APPLICATION_EXTRA_DRIVERS` for an alternative placement
of application device driver initializers.
+.. index:: CONFIGURE_ATA_DRIVER_TASK_PRIORITY
+
+.. _CONFIGURE_ATA_DRIVER_TASK_PRIORITY:
+
+CONFIGURE_ATA_DRIVER_TASK_PRIORITY
+----------------------------------
+
+CONSTANT:
+ ``CONFIGURE_ATA_DRIVER_TASK_PRIORITY``
+
+OPTION TYPE:
+ This configuration option is an integer define.
+
+DEFAULT VALUE:
+ The default value is 140.
+
+VALUE CONSTRAINTS:
+ The value of this configuration option shall be a valid Classic API task
+ priority. The set of valid task priorities is scheduler-specific.
+
+DESCRIPTION:
+ The value of this configuration option defines the ATA task priority.
+
+NOTES:
+ This configuration option is only evaluated if the configuration option
+ :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER` is defined.
+
.. index:: CONFIGURE_MAXIMUM_DRIVERS
.. _CONFIGURE_MAXIMUM_DRIVERS: