diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-21 19:39:17 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-21 19:45:38 +0200 |
| commit | 182294bbef75f1d89536a0fda10a2ff7bdc990dc (patch) | |
| tree | 777fe4238fb8e85f3001743fd66ab34d900580b6 /spec/rtems/mp/if/announce.yml | |
| parent | spec: Update /rtems/init/* and /rtems/fatal/* docs (diff) | |
| download | rtems-central-182294bbef75f1d89536a0fda10a2ff7bdc990dc.tar.bz2 | |
spec: Update /rtems/mp/* documentation
Diffstat (limited to 'spec/rtems/mp/if/announce.yml')
| -rw-r--r-- | spec/rtems/mp/if/announce.yml | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/spec/rtems/mp/if/announce.yml b/spec/rtems/mp/if/announce.yml index 17db51dd..dfe88e9f 100644 --- a/spec/rtems/mp/if/announce.yml +++ b/spec/rtems/mp/if/announce.yml @@ -1,7 +1,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Announces the arrival of a packet. copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) definition: default: attributes: null @@ -9,7 +11,10 @@ definition: params: [] return: void variants: [] -description: '%' +description: | + This directive informs RTEMS that a multiprocessing communications packet has + arrived from another node. This directive is called by the user-provided + MPCI, and is only used in multiprocessing configurations. enabled-by: true index-entries: [] interface-type: function @@ -18,8 +23,19 @@ links: uid: header - role: interface-ingroup uid: group +- role: constraint + uid: /constraint/directive-ctx-isr +- role: constraint + uid: /constraint/directive-ctx-devinit +- role: constraint + uid: /constraint/directive-ctx-task +- role: constraint + uid: /constraint/unblock-may-preempt name: rtems_multiprocessing_announce -notes: null +notes: | + This directive is typically called from an ${/glossary/isr:/term}. + + This directive does not generate activity on remote nodes. params: [] return: return: null |