summaryrefslogtreecommitdiffstats
path: root/c-user/object-services/directives.rst
blob: 54f234f08b37a606a7fa04d2e0b35c3c146fea89 (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
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2009 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

.. _ObjectServicesDirectives:

Directives
==========

This section details the directives of the Object Services. A subsection is
dedicated to each of this manager's directives and lists the calling sequence,
parameters, description, return values, and notes of the directive.

.. Generated from spec:/rtems/object/if/build-id

.. raw:: latex

    \clearpage

.. index:: rtems_build_id()

.. _InterfaceRtemsBuildId:

rtems_build_id()
----------------

Builds the object identifier from the API, class, MPCI node, and index
components.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_id rtems_build_id(
      uint32_t api,
      uint32_t the_class,
      uint32_t node,
      uint32_t index
    );

.. rubric:: PARAMETERS:

``api``
    This parameter is the API of the object identifier to build.

``the_class``
    This parameter is the class of the object identifier to build.

``node``
    This parameter is the MPCI node of the object identifier to build.

``index``
    This parameter is the index of the object identifier to build.

.. rubric:: RETURN VALUES:

Returns the object identifier built from the API, class, MPCI node, and index
components.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/build-name

.. raw:: latex

    \clearpage

.. index:: rtems_build_name()

.. _InterfaceRtemsBuildName:

rtems_build_name()
------------------

Builds the object name composed of the four characters.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_name rtems_build_name( char c1, char c2, char c3, char c4 );

.. rubric:: PARAMETERS:

``c1``
    This parameter is the first character of the name.

``c2``
    This parameter is the second character of the name.

``c3``
    This parameter is the third character of the name.

``c4``
    This parameter is the fourth character of the name.

.. rubric:: DESCRIPTION:

This directive takes the four characters provided as arguments and composes a
32-bit object name with ``c1`` in the most significant 8-bits and ``c4`` in the
least significant 8-bits.

.. rubric:: RETURN VALUES:

Returns the object name composed of the four characters.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/get-classic-name

.. raw:: latex

    \clearpage

.. index:: rtems_object_get_classic_name()

.. _InterfaceRtemsObjectGetClassicName:

rtems_object_get_classic_name()
-------------------------------

Gets the object name associated with the object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_object_get_classic_name(
      rtems_id    id,
      rtems_name *name
    );

.. rubric:: PARAMETERS:

``id``
    This parameter is the object identifier to get the name.

``name``
    This parameter is the pointer to an object name variable.  When the
    directive call is successful, the object name associated with the object
    identifier will be stored in this variable.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``name`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no object information available for the object identifier.

:c:macro:`RTEMS_INVALID_ID`
    The object name associated with the object identifier was a string.

:c:macro:`RTEMS_INVALID_ID`
    There was no object associated with the object identifier.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/get-name

.. raw:: latex

    \clearpage

.. index:: rtems_object_get_name()

.. _InterfaceRtemsObjectGetName:

rtems_object_get_name()
-----------------------

Gets the object name associated with the object identifier as a string.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    char *rtems_object_get_name( rtems_id id, size_t length, char *name );

.. rubric:: PARAMETERS:

``id``
    This parameter is the object identifier to get the name.

``length``
    This parameter is the buffer length in bytes.

``name``
    This parameter is the pointer to a buffer of the specified length.

.. rubric:: DESCRIPTION:

The object name is stored in the name buffer.  If the name buffer length is
greater than zero, then the stored object name will be ``NUL`` terminated. The
stored object name may be truncated to fit the length.  There is no indication
if a truncation occurred.  Every attempt is made to return name as a printable
string even if the object has the Classic API 32-bit integer style name.

.. rubric:: RETURN VALUES:

`NULL <https://en.cppreference.com/w/c/types/NULL>`_
    The ``length`` parameter was 0.

`NULL <https://en.cppreference.com/w/c/types/NULL>`_
    The ``name`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

`NULL <https://en.cppreference.com/w/c/types/NULL>`_
    There was no object information available for the object identifier.

`NULL <https://en.cppreference.com/w/c/types/NULL>`_
    There was no object associated with the object identifier.

Returns the ``name`` parameter value, if there is an object name associated
with the object identifier.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/set-name

.. raw:: latex

    \clearpage

.. index:: rtems_object_set_name()

.. _InterfaceRtemsObjectSetName:

rtems_object_set_name()
-----------------------

Sets the object name of the object associated with the object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_object_set_name( rtems_id id, const char *name );

.. rubric:: PARAMETERS:

``id``
    This parameter is the object identifier of the object to set the name.

``name``
    This parameter is the object name to set.

.. rubric:: DESCRIPTION:

This directive will set the object name based upon the user string.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``name`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no object information available for the object identifier.

:c:macro:`RTEMS_INVALID_ID`
    There was no object associated with the object identifier.

:c:macro:`RTEMS_NO_MEMORY`
    There was no memory available to duplicate the name.

.. rubric:: NOTES:

This directive can be used to set the name of objects which do not have a
naming scheme per their API.

If the object specified by ``id`` is of a class that has a string name, this
directive will free the existing name to the RTEMS Workspace and allocate
enough memory from the RTEMS Workspace to make a copy of the string located at
``name``.

If the object specified by ``id`` is of a class that has a 32-bit integer style
name, then the first four characters in ``name`` will be used to construct the
name.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/id-get-api

.. raw:: latex

    \clearpage

.. index:: rtems_object_id_get_api()

.. _InterfaceRtemsObjectIdGetApi:

rtems_object_id_get_api()
-------------------------

Gets the API component of the object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_id_get_api( rtems_id id );

.. rubric:: PARAMETERS:

``id``
    This parameter is the object identifier with the API component to get.

.. rubric:: RETURN VALUES:

Returns the API component of the object identifier.

.. rubric:: NOTES:

This directive does not validate the object identifier provided in ``id``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/id-get-class

.. raw:: latex

    \clearpage

.. index:: rtems_object_id_get_class()

.. _InterfaceRtemsObjectIdGetClass:

rtems_object_id_get_class()
---------------------------

Gets the class component of the object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_id_get_class( rtems_id id );

.. rubric:: PARAMETERS:

``id``
    This parameter is the object identifier with the class component to get.

.. rubric:: RETURN VALUES:

Returns the class component of the object identifier.

.. rubric:: NOTES:

This directive does not validate the object identifier provided in ``id``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/id-get-node

.. raw:: latex

    \clearpage

.. index:: rtems_object_id_get_node()

.. _InterfaceRtemsObjectIdGetNode:

rtems_object_id_get_node()
--------------------------

Gets the MPCI node component of the object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_id_get_node( rtems_id id );

.. rubric:: PARAMETERS:

``id``
    This parameter is the object identifier with the MPCI node component to
    get.

.. rubric:: RETURN VALUES:

Returns the MPCI node component of the object identifier.

.. rubric:: NOTES:

This directive does not validate the object identifier provided in ``id``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/id-get-index

.. raw:: latex

    \clearpage

.. index:: rtems_object_id_get_index()

.. _InterfaceRtemsObjectIdGetIndex:

rtems_object_id_get_index()
---------------------------

Gets the index component of the object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_id_get_index( rtems_id id );

.. rubric:: PARAMETERS:

``id``
    This parameter is the object identifier with the index component to get.

.. rubric:: RETURN VALUES:

Returns the index component of the object identifier.

.. rubric:: NOTES:

This directive does not validate the object identifier provided in ``id``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/id-api-minimum

.. raw:: latex

    \clearpage

.. index:: rtems_object_id_api_minimum()

.. _InterfaceRtemsObjectIdApiMinimum:

rtems_object_id_api_minimum()
-----------------------------

Gets the lowest valid value for the API component of an object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_id_api_minimum( void );

.. rubric:: RETURN VALUES:

Returns the lowest valid value for the API component of an object identifier.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/id-api-maximum

.. raw:: latex

    \clearpage

.. index:: rtems_object_id_api_maximum()

.. _InterfaceRtemsObjectIdApiMaximum:

rtems_object_id_api_maximum()
-----------------------------

Gets the highest valid value for the API component of an object identifier.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_id_api_maximum( void );

.. rubric:: RETURN VALUES:

Returns the highest valid value for the API component of an object identifier.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive is implemented by a macro and may be called from within C/C++
  constant expressions.  In addition, a function implementation of the
  directive exists for bindings to other programming languages.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/api-minimum-class

.. raw:: latex

    \clearpage

.. index:: rtems_object_api_minimum_class()

.. _InterfaceRtemsObjectApiMinimumClass:

rtems_object_api_minimum_class()
--------------------------------

Gets the lowest valid class value of the object API.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_api_minimum_class( int api );

.. rubric:: PARAMETERS:

``api``
    This parameter is the object API to get the lowest valid class value.

.. rubric:: RETURN VALUES:

``-1``
    The object API was invalid.

Returns the lowest valid class value of the object API.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/api-maximum-class

.. raw:: latex

    \clearpage

.. index:: rtems_object_api_maximum_class()

.. _InterfaceRtemsObjectApiMaximumClass:

rtems_object_api_maximum_class()
--------------------------------

Gets the highest valid class value of the object API.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    int rtems_object_api_maximum_class( int api );

.. rubric:: PARAMETERS:

``api``
    This parameter is the object API to get the highest valid class value.

.. rubric:: RETURN VALUES:

``0``
    The object API was invalid.

Returns the highest valid class value of the object API.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/get-api-name

.. raw:: latex

    \clearpage

.. index:: rtems_object_get_api_name()

.. _InterfaceRtemsObjectGetApiName:

rtems_object_get_api_name()
---------------------------

Gets a descriptive name of the object API.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    const char *rtems_object_get_api_name( int api );

.. rubric:: PARAMETERS:

``api``
    This parameter is the object API to get the name.

.. rubric:: RETURN VALUES:

"BAD API"
    The API was invalid.

Returns a descriptive name of the API, if the API was valid.

.. rubric:: NOTES:

The string returned is from constant space.  Do not modify or free it.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/get-api-class-name

.. raw:: latex

    \clearpage

.. index:: rtems_object_get_api_class_name()

.. _InterfaceRtemsObjectGetApiClassName:

rtems_object_get_api_class_name()
---------------------------------

Gets a descriptive name of the object class of the object API.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    const char *rtems_object_get_api_class_name( int the_api, int the_class );

.. rubric:: PARAMETERS:

``the_api``
    This parameter is the object API of the object class.

``the_class``
    This parameter is the object class of the object API to get the name.

.. rubric:: RETURN VALUES:

"BAD API"
    The API was invalid.

"BAD CLASS"
    The class of the API was invalid.

Returns a descriptive name of the class of the API, if the class of the API and
the API were valid.

.. rubric:: NOTES:

The string returned is from constant space.  Do not modify or free it.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/get-class-information

.. raw:: latex

    \clearpage

.. index:: rtems_object_get_class_information()

.. _InterfaceRtemsObjectGetClassInformation:

rtems_object_get_class_information()
------------------------------------

Gets the object class information of the object class of the object API.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_object_get_class_information(
      int                                 the_api,
      int                                 the_class,
      rtems_object_api_class_information *info
    );

.. rubric:: PARAMETERS:

``the_api``
    This parameter is the object API of the object class.

``the_class``
    This parameter is the object class of the object API to get the class
    information.

``info``
    This parameter is the pointer to an object class information variable.
    When the directive call is successful, the object class information of the
    class of the API will be stored in this variable.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``info`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_NUMBER`
    The class of the API or the API was invalid.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/get-local-node

.. raw:: latex

    \clearpage

.. index:: rtems_object_get_local_node()

.. _InterfaceRtemsObjectGetLocalNode:

rtems_object_get_local_node()
-----------------------------

Gets the local MPCI node number.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    uint16_t rtems_object_get_local_node( void );

.. rubric:: RETURN VALUES:

Returns the local MPCI node number.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/object/if/id-initial

.. raw:: latex

    \clearpage

.. index:: RTEMS_OBJECT_ID_INITIAL()

.. _InterfaceRTEMSOBJECTIDINITIAL:

RTEMS_OBJECT_ID_INITIAL()
-------------------------

Builds the object identifier with the lowest index from the API, class, and
MPCI node components.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define RTEMS_OBJECT_ID_INITIAL( api, class, node )

.. rubric:: PARAMETERS:

``api``
    This parameter is the API of the object identifier to build.

``class``
    This parameter is the class of the object identifier to build.

``node``
    This parameter is the MPCI node of the object identifier to build.

.. rubric:: RETURN VALUES:

Returns the object identifier with the lowest index built from the API, class,
and MPCI node components.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.