summaryrefslogtreecommitdiffstats
path: root/spec/rtems/mp/if/announce.yml
blob: b88911997f9c59389c2adf26246f0c6750837405 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Announces the arrival of a packet.
copyrights:
- 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
    body: null
    params: []
    return: void
  variants: []
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
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- 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: |
  This directive is typically called from an ${/glossary/isr:/term}.

  This directive does not generate activity on remote nodes.
params: []
return: null
type: interface