summaryrefslogtreecommitdiffstats
path: root/c-user/config/device-driver.rst
blob: d84da0a62c5600d0d6ba1706f4751ef10cc60d2d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2021 On-Line Applications Research Corporation (OAR)

.. This file 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 or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual.  The manual is provided as a part of
.. a release.  For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org

.. Generated from spec:/acfg/if/group-devdrv

Device Driver Configuration
===========================

This section describes configuration options related to the device drivers.
Note that network device drivers are not covered by the following options.

.. Generated from spec:/acfg/if/appl-does-not-need-clock-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER

.. _CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER:

CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
------------------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then a Clock Driver may be
initialized during system initialization.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then **no** Clock Driver is
initialized during system initialization.

.. rubric:: NOTES:

This configuration parameter is intended to prevent the common user error
of using the Hello World example as the baseline for an application and
leaving out a clock tick source.

The application shall define exactly one of the following configuration options

* :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,

* ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER``, or

* :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`,

otherwise a compile time error in the configuration file will occur.

.. Generated from spec:/acfg/if/appl-extra-drivers

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS

.. _CONFIGURE_APPLICATION_EXTRA_DRIVERS:

CONFIGURE_APPLICATION_EXTRA_DRIVERS
-----------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_EXTRA_DRIVERS``

.. rubric:: OPTION TYPE:

This configuration option is an initializer define.

.. rubric:: DEFAULT VALUE:

The default value is the empty list.

.. rubric:: DESCRIPTION:

The value of this configuration option is used to initialize the Device
Driver Table.

.. rubric:: NOTES:

The value of this configuration option is placed after the entries of other
device driver configuration options.

See :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS` for an alternative
placement of application device driver initializers.

.. rubric:: CONSTRAINTS:

The value of the configuration option shall be a list of initializers for
structures of type :c:type:`rtems_driver_address_table`.

.. Generated from spec:/acfg/if/appl-needs-ata-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER:

CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER
--------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the ATA Driver is
initialized during system initialization.

.. rubric:: 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.

.. Generated from spec:/acfg/if/appl-needs-clock-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER:

CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
----------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Clock Driver is
initialized during system initialization.

.. rubric:: NOTES:

The Clock Driver is responsible for providing a regular interrupt
which invokes a clock tick directive.

The application shall define exactly one of the following configuration options

* ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER``,

* :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or

* :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`,

otherwise a compile time error in the configuration file will occur.

.. Generated from spec:/acfg/if/appl-needs-console-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER:

CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
------------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Console Driver is
initialized during system initialization.

.. rubric:: NOTES:

The Console Driver is responsible for providing the :file:`/dev/console`
device file.  This device is used to initialize the standard input, output,
and error file descriptors.

BSPs should be constructed in a manner that allows :c:func:`printk` to work
properly without the need for the Console Driver to be configured.

The

* ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``,

* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and

* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`

configuration options are mutually exclusive.

.. Generated from spec:/acfg/if/appl-needs-framebuffer-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER:

CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
-----------------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Frame Buffer Driver is
initialized during system initialization.

.. rubric:: NOTES:

Most BSPs do not include support for a Frame Buffer Driver. This is
because many boards do not include the required hardware.

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.

.. Generated from spec:/acfg/if/appl-needs-ide-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER:

CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER
--------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the IDE Driver is
initialized during system initialization.

.. rubric:: 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.

.. Generated from spec:/acfg/if/appl-needs-null-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
.. index:: /dev/null

.. _CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER:

CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
---------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the :file:`/dev/null`
Driver is initialized during system initialization.

.. rubric:: NOTES:

This device driver is supported by all BSPs.

.. Generated from spec:/acfg/if/appl-needs-rtc-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER:

CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
--------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Real-Time Clock Driver
is initialized during system initialization.

.. rubric:: NOTES:

Most BSPs do not include support for a real-time clock (RTC). This is because
many boards do not include the required hardware.

If this is defined and the BSP does not have this device driver, then the
user will get a link time error for an undefined symbol.

.. Generated from spec:/acfg/if/appl-needs-simple-console-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER:

CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER
-------------------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Simple Console Driver
is initialized during system initialization.

.. rubric:: NOTES:

This device driver is responsible for providing the :file:`/dev/console`
device file.  This device is used to initialize the standard input, output,
and error file descriptors.

This device driver reads via :c:func:`getchark`.

This device driver writes via :c:func:`rtems_putc`.

The Termios framework is not used.  There is no support to change device
settings, e.g. baud, stop bits, parity, etc.

The

* :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`,

* ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and

* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`

configuration options are mutually exclusive.

.. Generated from spec:/acfg/if/appl-needs-simple-task-console-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER:

CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER
------------------------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Simple Task Console
Driver is initialized during system initialization.

.. rubric:: NOTES:

This device driver is responsible for providing the :file:`/dev/console`
device file.  This device is used to initialize the standard input, output,
and error file descriptors.

This device driver reads via :c:func:`getchark`.

This device driver writes into a write buffer.  The count of characters
written into the write buffer is returned.  It might be less than the
requested count, in case the write buffer is full.  The write is
non-blocking and may be called from interrupt context.  A dedicated task
reads from the write buffer and outputs the characters via
:c:func:`rtems_putc`.  This task runs with the least important priority.
The write buffer size is 2047 characters and it is not configurable.

Use ``fsync( STDOUT_FILENO )`` or ``fdatasync( STDOUT_FILENO )`` to drain the
write buffer.

The Termios framework is not used.  There is no support to change device
settings, e.g.  baud, stop bits, parity, etc.

The

* :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`,

* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and

* ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER``

configuration options are mutually exclusive.

.. Generated from spec:/acfg/if/appl-needs-stub-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER:

CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
---------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Stub Driver is
initialized during system initialization.

.. rubric:: NOTES:

This device driver simply provides entry points that return successful and
is primarily a test fixture. It is supported by all BSPs.

.. Generated from spec:/acfg/if/appl-needs-timer-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER:

CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
----------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Benchmark Timer Driver is
initialized during system initialization.

.. rubric:: NOTES:

The Benchmark Timer Driver is intended for the benchmark tests of the RTEMS
Testsuite.  Applications should not use this driver.

The application shall define exactly one of the following configuration options

* :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,

* :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or

* ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER``,

otherwise a compile time error will occur.

.. Generated from spec:/acfg/if/appl-needs-watchdog-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER

.. _CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER:

CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
-------------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the Watchdog Driver is
initialized during system initialization.

.. rubric:: NOTES:

Most BSPs do not include support for a watchdog device driver. This is
because many boards do not include the required hardware.

If this is defined and the BSP does not have this device driver, then the
user will get a link time error for an undefined symbol.

.. Generated from spec:/acfg/if/appl-needs-zero-driver

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
.. index:: /dev/zero

.. _CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER:

CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
---------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the :file:`/dev/zero`
Driver is initialized during system initialization.

.. rubric:: NOTES:

This device driver is supported by all BSPs.

.. Generated from spec:/acfg/if/appl-prerequisite-drivers

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS

.. _CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS:

CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
------------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS``

.. rubric:: OPTION TYPE:

This configuration option is an initializer define.

.. rubric:: DEFAULT VALUE:

The default value is the empty list.

.. rubric:: DESCRIPTION:

The value of this configuration option is used to initialize the Device
Driver Table.

.. rubric:: NOTES:

The value of this configuration option is placed after the entries defined by
:ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS` and before all other device driver
configuration options.

See :ref:`CONFIGURE_APPLICATION_EXTRA_DRIVERS` for an alternative placement
of application device driver initializers.

.. rubric:: CONSTRAINTS:

The value of the configuration option shall be a list of initializers for
structures of type :c:type:`rtems_driver_address_table`.

.. Generated from spec:/acfg/if/ata-driver-task-priority

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_ATA_DRIVER_TASK_PRIORITY

.. _CONFIGURE_ATA_DRIVER_TASK_PRIORITY:

CONFIGURE_ATA_DRIVER_TASK_PRIORITY
----------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_ATA_DRIVER_TASK_PRIORITY``

.. rubric:: OPTION TYPE:

This configuration option is an integer define.

.. rubric:: DEFAULT VALUE:

The default value is 140.

.. rubric:: DESCRIPTION:

The value of this configuration option defines the ATA task priority.

.. rubric:: NOTES:

This configuration option is only evaluated if the configuration option
:ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER` is defined.

.. rubric:: CONSTRAINTS:

The value of the configuration option shall be a valid Classic API task
priority.  The set of valid task priorities depends on the scheduler
configuration.

.. Generated from spec:/acfg/if/exception-to-signal-mapping

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_EXCEPTION_TO_SIGNAL_MAPPING

.. _CONFIGURE_EXCEPTION_TO_SIGNAL_MAPPING:

CONFIGURE_EXCEPTION_TO_SIGNAL_MAPPING
-------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_EXCEPTION_TO_SIGNAL_MAPPING``

.. rubric:: OPTION TYPE:

This configuration option is a boolean feature define.

.. rubric:: DEFAULT CONFIGURATION:

If this configuration option is undefined, then the described feature is not
enabled.

.. rubric:: DESCRIPTION:

In case this configuration option is defined, then the machine exception to
POSIX signal mapping is configured during system initialization.

.. rubric:: NOTES:

This device driver is responsible for setting up a mapping from machine
exceptions to POSIX signals so that applications may consume them and alter
task execution as necessary.

This is especially useful for applications written in Ada or C++.

.. Generated from spec:/acfg/if/max-drivers

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_DRIVERS

.. _CONFIGURE_MAXIMUM_DRIVERS:

CONFIGURE_MAXIMUM_DRIVERS
-------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_DRIVERS``

.. rubric:: OPTION TYPE:

This configuration option is an integer define.

.. rubric:: DEFAULT VALUE:

This is computed by default, and is set to the number of statically
configured device drivers configured using the following configuration
options:

* :ref:`CONFIGURE_APPLICATION_EXTRA_DRIVERS`

* :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`

* :ref:`CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER`

* :ref:`CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER`

* :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`

* :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`

.. rubric:: DESCRIPTION:

The value of this configuration option defines the number of device drivers.

.. rubric:: NOTES:

If the application will dynamically install device drivers, then the
configuration option value shall be larger than the number of statically
configured device drivers.

.. rubric:: CONSTRAINTS:

The following constraints apply to this configuration option:

* The value of the configuration option shall be less than or equal to
  `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.

* The value of the configuration option shall be greater than or equal than the
  number of statically configured device drivers.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.