docs/components/sdei.rst

45 events can be explicitly dispatched in response to other exceptions, for
64 -  The event number: this must be a positive 32-bit integer.
69    - If it's not applicable to an event, this shall be left as ``0``.
71    - If the event is dynamic, this should be specified as ``SDEI_DYN_IRQ``.
75 To define event 0, the macro ``SDEI_DEFINE_EVENT_0()`` should be used. This
78 To define an event that's meant to be explicitly dispatched (i.e., not as a
80 should be used. It accepts two parameters:
87 Once the event descriptor arrays are defined, they should be exported to the
90 ``REGISTER_SDEI_MAP()`` macro must be used in the same file where the arrays are
97    - There must be exactly one descriptor in the private array, and none in the
100    - The event should be defined using ``SDEI_DEFINE_EVENT_0()``.
102    - Must be bound to a Secure SGI on the platform.
104 -  Explicit events should only be used in the private array.
106 -  Statically bound shared and private interrupts must be bound to shared and
110 -  Both arrays should be one-dimensional. The ``REGISTER_SDEI_MAP()`` macro
113 -  Both arrays must be sorted in the increasing order of event number.
117 their semantics, have to be communicated out of band; for example, through
125 Event flags describe the properties of the event. They are bit maps that can be
129 -  ``SDEI_MAPF_DYNAMIC``: Marks the event as dynamic. Dynamic events can be
134    These events cannot be re-bound at runtime.
187    The interrupts must be configured to target EL3. This means that they should
188    be configured as *Group 0*.  Additionally, on GICv2 systems, the build option
189    ``GICV2_G0_FOR_EL3`` must be set to ``1``.
198 will only allow SDEI calls to be made from:
236 bound or dynamic events can't be explicitly dispatched (see the section below).
250 All of the following requirements must be met for the API to return ``0`` and
251 event to be dispatched:
253 -  SDEI events must be unmasked on the PE. I.e. the client must have called
256 -  Event 0 can't be dispatched.
258 -  The event must be declared using the ``SDEI_EXPLICIT_EVENT()`` macro
261 -  The event must be private to the PE.
265 -  A dispatch for the same event must not be outstanding. I.e. it hasn't already
266    been dispatched and is yet to be completed.
272       must be outstanding on the PE.
274    -  If it's of a Critical priority, no Critical priority dispatch must be
277 Further, the caller should be aware of the following assumptions made by the
283 -  The requested dispatch will be permitted by the Exception Handling Framework.
288 -  The caller must be prepared for the SDEI dispatcher to restore the Non-secure
294 -  The caller must be prepared for this API to return failure and handle
366 some security considerations which needs to be taken care of in both client and EL3
375 client can request an invalid interrupt to be bound. This may potentially
386 may be unusable. To mitigate against this, the Non-secure client must have