summaryrefslogtreecommitdiffstats
path: root/c-user/io_manager.rst
blob: cb8f70d78e3e86897e5c36b221e74a6bca5c47ca (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
.. comment SPDX-License-Identifier: CC-BY-SA-4.0

.. COMMENT: COPYRIGHT (c) 1988-2008.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.

I/O Manager
***********

.. index:: device drivers
.. index:: IO Manager

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:

- rtems_io_initialize_ - Initialize a device driver

- rtems_io_register_driver_ - Register a device driver

- rtems_io_unregister_driver_ - Unregister a device driver

- rtems_io_register_name_ - Register a device name

- rtems_io_lookup_name_ - Look up a device name

- rtems_io_open_ - Open a device

- rtems_io_close_ - Close a device

- rtems_io_read_ - Read from a device

- rtems_io_write_ - Write to a device

- rtems_io_control_ - Special device services

Background
==========

Device Driver Table
-------------------
.. index:: Device Driver Table

Each application utilizing the RTEMS I/O manager must specify the address of a
Device Driver Table in its Configuration Table. This table contains each device
driver's entry points that is to be initialised by RTEMS during initialization.
Each device driver may contain the following entry points:

- Initialization

- Open

- Close

- Read

- Write

- Control

If the device driver does not support a particular entry point, then that entry
in the Configuration Table should be NULL.  RTEMS will return
``RTEMS_SUCCESSFUL`` as the executive's and zero (0) as the device driver's
return code for these device driver entry points.

Applications can register and unregister drivers with the RTEMS I/O manager
avoiding the need to have all drivers statically defined and linked into this
table.

The :file:`confdefs.h` entry ``CONFIGURE_MAXIMUM_DRIVERS`` configures the
number of driver slots available to the application.

Major and Minor Device Numbers
------------------------------
.. index:: major device number
.. index:: minor device number

Each call to the I/O manager must provide a device's major and minor numbers as
arguments.  The major number is the index of the requested driver's entry
points in the Device Driver Table, and is used to select a specific device
driver.  The exact usage of the minor number is driver specific, but is
commonly used to distinguish between a number of devices controlled by the same
driver.

.. index:: rtems_device_major_number
.. index:: rtems_device_minor_number

The data types ``rtems_device_major_number`` and ``rtems_device_minor_number``
are used to manipulate device major and minor numbers, respectively.

Device Names
------------
.. index:: device names

The I/O Manager provides facilities to associate a name with a particular
device.  Directives are provided to register the name of a device and to look
up the major/minor number pair associated with a device name.

Device Driver Environment
-------------------------

Application developers, as well as device driver developers, must be aware of
the following regarding the RTEMS I/O Manager:

- A device driver routine executes in the context of the invoking task.  Thus
  if the driver blocks, the invoking task blocks.

- The device driver is free to change the modes of the invoking task, although
  the driver should restore them to their original values.

- Device drivers may be invoked from ISRs.

- Only local device drivers are accessible through the I/O manager.

- A device driver routine may invoke all other RTEMS directives, including I/O
  directives, on both local and global objects.

Although the RTEMS I/O manager provides a framework for device drivers, it
makes no assumptions regarding the construction or operation of a device
driver.

Runtime Driver Registration
---------------------------
.. index:: runtime driver registration

Board support package and application developers can select wether a device
driver is statically entered into the default device table or registered at
runtime.

Dynamic registration helps applications where:

- The BSP and kernel libraries are common to a range of applications for a
  specific target platform. An application may be built upon a common library
  with all drivers. The application selects and registers the drivers. Uniform
  driver name lookup protects the application.

- The type and range of drivers may vary as the application probes a bus during
  initialization.

- Support for hot swap bus system such as Compact PCI.

- Support for runtime loadable driver modules.

Device Driver Interface
-----------------------
.. index:: device driver interface

When an application invokes an I/O manager directive, RTEMS determines which
device driver entry point must be invoked.  The information passed by the
application to RTEMS is then passed to the correct device driver entry point.
RTEMS will invoke each device driver entry point assuming it is compatible with
the following prototype:

.. code-block:: c

    rtems_device_driver io_entry(
        rtems_device_major_number  major,
        rtems_device_minor_number  minor,
        void                      *argument_block
    );

The format and contents of the parameter block are device driver and entry
point dependent.

It is recommended that a device driver avoid generating error codes which
conflict with those used by application components.  A common technique used to
generate driver specific error codes is to make the most significant part of
the status indicate a driver specific code.

Device Driver Initialization
----------------------------

RTEMS automatically initializes all device drivers when multitasking is
initiated via the ``rtems_initialize_executive`` directive.  RTEMS initializes
the device drivers by invoking each device driver initialization entry point
with the following parameters:

``major``
    the major device number for this device driver.

``minor``
    zero.

``argument_block``
    will point to  the Configuration Table.

The returned status will be ignored by RTEMS.  If the driver cannot
successfully initialize the device, then it should invoke the
fatal_error_occurred directive.

Operations
==========

Register and Lookup Name
------------------------

The ``rtems_io_register`` directive associates a name with the specified device
(i.e. major/minor number pair).  Device names are typically registered as part
of the device driver initialization sequence.  The ``rtems_io_lookup``
directive is used to determine the major/minor number pair associated with the
specified device name.  The use of these directives frees the application from
being dependent on the arbitrary assignment of major numbers in a particular
application.  No device naming conventions are dictated by RTEMS.

Accessing an Device Driver
--------------------------

The I/O manager provides directives which enable the application program to
utilize device drivers in a standard manner.  There is a direct correlation
between the RTEMS I/O manager directives ``rtems_io_initialize``,
``rtems_io_open``, ``rtems_io_close``, ``rtems_io_read``, ``rtems_io_write``,
and ``rtems_io_control`` and the underlying device driver entry points.

Directives
==========

This section details the I/O manager's directives.  A subsection is dedicated
to each of this manager's directives and describes the calling sequence,
related constants, usage, and status codes.

.. raw:: latex

   \clearpage

.. _rtems_io_register_driver:

IO_REGISTER_DRIVER - Register a device driver
---------------------------------------------
.. index:: register a device driver
.. index:: rtems_io_register_driver

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_register_driver(
            rtems_device_major_number   major,
            rtems_driver_address_table *driver_table,
            rtems_device_major_number  *registered_major
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully registered
     * - ``RTEMS_INVALID_ADDRESS``
       - invalid registered major pointer
     * - ``RTEMS_INVALID_ADDRESS``
       - invalid driver table
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number
     * - ``RTEMS_TOO_MANY``
       - no available major device table slot
     * - ``RTEMS_RESOURCE_IN_USE``
       - major device number entry in use

DESCRIPTION:
    This directive attempts to add a new device driver to the Device Driver
    Table. The user can specify a specific major device number via the
    directive's ``major`` parameter, or let the registration routine find the
    next available major device number by specifing a major number of
    ``0``. The selected major device number is returned via the
    ``registered_major`` directive parameter. The directive automatically
    allocation major device numbers from the highest value down.

    This directive automatically invokes the ``IO_INITIALIZE`` directive if the
    driver address table has an initialization and open entry.

    The directive returns ``RTEMS_TOO_MANY`` if Device Driver Table is full,
    and ``RTEMS_RESOURCE_IN_USE`` if a specific major device number is
    requested and it is already in use.

NOTES:
    The Device Driver Table size is specified in the Configuration Table
    condiguration. This needs to be set to maximum size the application
    requires.

.. raw:: latex

   \clearpage

.. _rtems_io_unregister_driver:

IO_UNREGISTER_DRIVER - Unregister a device driver
-------------------------------------------------
.. index:: unregister a device driver
.. index:: rtems_io_unregister_driver

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_unregister_driver(
            rtems_device_major_number   major
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully registered
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number

DESCRIPTION:
    This directive removes a device driver from the Device Driver Table.

NOTES:
    Currently no specific checks are made and the driver is not closed.

.. raw:: latex

   \clearpage

.. _rtems_io_initialize:

IO_INITIALIZE - Initialize a device driver
------------------------------------------
.. index:: initialize a device driver
.. index:: rtems_io_initialize

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_initialize(
            rtems_device_major_number  major,
            rtems_device_minor_number  minor,
            void                      *argument
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number

DESCRIPTION:
    This directive calls the device driver initialization routine specified in
    the Device Driver Table for this major number. This directive is
    automatically invoked for each device driver when multitasking is initiated
    via the initialize_executive directive.

    A device driver initialization module is responsible for initializing all
    hardware and data structures associated with a device. If necessary, it can
    allocate memory to be used during other operations.

NOTES:
    This directive may or may not cause the calling task to be preempted.  This
    is dependent on the device driver being initialized.

.. raw:: latex

   \clearpage

.. _rtems_io_register_name:

IO_REGISTER_NAME - Register a device
------------------------------------
.. index:: register device
.. index:: rtems_io_register_name

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_register_name(
            const char                *name,
            rtems_device_major_number  major,
            rtems_device_minor_number  minor
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_TOO_MANY``
       - too many devices registered

DESCRIPTION:
    This directive associates name with the specified major/minor number pair.

NOTES:
    This directive will not cause the calling task to be preempted.

.. raw:: latex

   \clearpage

.. _rtems_io_lookup_name:

IO_LOOKUP_NAME - Lookup a device
--------------------------------
.. index:: lookup device major and minor number
.. index:: rtems_io_lookup_name

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_lookup_name(
            const char          *name,
            rtems_driver_name_t *device_info
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_UNSATISFIED``
       - name not registered

DESCRIPTION:
    This directive returns the major/minor number pair associated with the
    given device name in ``device_info``.

NOTES:
    This directive will not cause the calling task to be preempted.

.. raw:: latex

   \clearpage

.. _rtems_io_open:

IO_OPEN - Open a device
-----------------------
.. index:: open a devive
.. index:: rtems_io_open

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_open(
            rtems_device_major_number  major,
            rtems_device_minor_number  minor,
            void                      *argument
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number

DESCRIPTION:
    This directive calls the device driver open routine specified in the Device
    Driver Table for this major number.  The open entry point is commonly used
    by device drivers to provide exclusive access to a device.

NOTES:
    This directive may or may not cause the calling task to be preempted.  This
    is dependent on the device driver being invoked.

.. raw:: latex

   \clearpage

.. _rtems_io_close:

IO_CLOSE - Close a device
-------------------------
.. index:: close a device
.. index:: rtems_io_close

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_close(
            rtems_device_major_number  major,
            rtems_device_minor_number  minor,
            void                      *argument
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number

DESCRIPTION:
    This directive calls the device driver close routine specified in the
    Device Driver Table for this major number.  The close entry point is
    commonly used by device drivers to relinquish exclusive access to a device.

NOTES:
    This directive may or may not cause the calling task to be preempted.  This
    is dependent on the device driver being invoked.

.. raw:: latex

   \clearpage

.. _rtems_io_read:

IO_READ - Read from a device
----------------------------
.. index:: read from a device
.. index:: rtems_io_read

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_read(
            rtems_device_major_number  major,
            rtems_device_minor_number  minor,
            void                      *argument
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number

DESCRIPTION:
    This directive calls the device driver read routine specified in the Device
    Driver Table for this major number.  Read operations typically require a
    buffer address as part of the argument parameter block.  The contents of
    this buffer will be replaced with data from the device.

NOTES:
    This directive may or may not cause the calling task to be preempted.  This
    is dependent on the device driver being invoked.

.. raw:: latex

   \clearpage

.. _rtems_io_write:

IO_WRITE - Write to a device
----------------------------
.. index:: write to a device
.. index:: rtems_io_write

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_write(
            rtems_device_major_number  major,
            rtems_device_minor_number  minor,
            void                      *argument
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number

DESCRIPTION:
    This directive calls the device driver write routine specified in the
    Device Driver Table for this major number.  Write operations typically
    require a buffer address as part of the argument parameter block.  The
    contents of this buffer will be sent to the device.

NOTES:
    This directive may or may not cause the calling task to be preempted.  This
    is dependent on the device driver being invoked.

.. raw:: latex

   \clearpage

.. _rtems_io_control:

IO_CONTROL - Special device services
------------------------------------
.. index:: special device services
.. index:: IO Control
.. index:: rtems_io_control

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_io_control(
            rtems_device_major_number  major,
            rtems_device_minor_number  minor,
            void                      *argument
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - successfully initialized
     * - ``RTEMS_INVALID_NUMBER``
       - invalid major device number

DESCRIPTION:
    This directive calls the device driver I/O control routine specified in the
    Device Driver Table for this major number.  The exact functionality of the
    driver entry called by this directive is driver dependent.  It should not
    be assumed that the control entries of two device drivers are compatible.
    For example, an RS-232 driver I/O control operation may change the baud
    rate of a serial line, while an I/O control operation for a floppy disk
    driver may cause a seek operation.

NOTES:
    This directive may or may not cause the calling task to be preempted.  This
    is dependent on the device driver being invoked.