L4Re Operating System Framework
Interface and Usage Documentation
Loading...
Searching...
No Matches
irq
Go to the documentation of this file.
1// vi:set ft=cpp: -*- Mode: C++ -*-
6/*
7 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
8 * Alexander Warg <warg@os.inf.tu-dresden.de>
9 * economic rights: Technische Universität Dresden (Germany)
10 *
11 * License: see LICENSE.spdx (in this directory or the directories above)
12 */
13
14#pragma once
15
16#include <l4/sys/icu.h>
17#include <l4/sys/irq.h>
18#include <l4/sys/capability>
19#include <l4/sys/rcv_endpoint>
20#include <l4/sys/cxx/ipc_iface>
21#include <l4/sys/cxx/ipc_types>
22
23namespace L4 {
24
37class Irq_eoi : public Kobject_0t<Irq_eoi, L4::PROTO_EMPTY>
38{
39public:
64 l4_msgtag_t unmask(unsigned irqnum, l4_umword_t *label = 0,
66 l4_utcb_t *utcb = l4_utcb()) noexcept
67 {
68 return l4_icu_control_u(cap(), irqnum, L4_ICU_CTL_UNMASK, label, to, utcb);
69 }
70};
71
79struct Triggerable : Kobject_t<Triggerable, Irq_eoi, L4_PROTO_IRQ>
80{
92 { return l4_irq_trigger_u(cap(), utcb); }
93};
94
120class Irq : public Kobject_2t<Irq, Triggerable, Rcv_endpoint, L4_PROTO_IRQ_SENDER>
121{
122public:
124
157 l4_utcb_t *utcb = l4_utcb()) noexcept
158 { return l4_irq_bind_vcpu_u(cap(), thread.cap(), cfg, utcb); }
159
174 { return l4_irq_detach_u(cap(), utcb); }
175
176
189 l4_utcb_t *utcb = l4_utcb()) noexcept
190 { return l4_irq_receive_u(cap(), timeout, utcb); }
191
202 l4_utcb_t *utcb = l4_utcb()) noexcept
203 { return unmask(-1, label, timeout, utcb); }
204
219 { return unmask(-1, 0, L4_IPC_NEVER, utcb); }
220};
221
246class Icu :
247 public Kobject_t<Icu, Irq_eoi, L4_PROTO_IRQ,
248 Type_info::Demand_t<1> >
249{
250public:
251 enum Mode
252 {
253 F_none = L4_IRQ_F_NONE,
254 F_level_high = L4_IRQ_F_LEVEL_HIGH,
255 F_level_low = L4_IRQ_F_LEVEL_LOW,
256 F_pos_edge = L4_IRQ_F_POS_EDGE,
257 F_neg_edge = L4_IRQ_F_NEG_EDGE,
258 F_both_edge = L4_IRQ_F_BOTH_EDGE,
259 F_mask = L4_IRQ_F_MASK,
260
261 F_set_wakeup = L4_IRQ_F_SET_WAKEUP,
262 F_clear_wakeup = L4_IRQ_F_CLEAR_WAKEUP,
263 };
264
265 enum Flags
266 {
267 F_msi = L4_ICU_FLAG_MSI
268 };
269
273 class Info : public l4_icu_info_t
274 {
275 public:
277 bool supports_msi() const noexcept { return features & F_msi; }
278 };
279
306 l4_utcb_t *utcb = l4_utcb()) noexcept
307 { return l4_icu_bind_u(cap(), irqnum, irq.cap(), utcb); }
308
312 );
313
324 l4_utcb_t *utcb = l4_utcb()) noexcept
325 { return l4_icu_unbind_u(cap(), irqnum, irq.cap(), utcb); }
326
330 );
331
341 { return l4_icu_info_u(cap(), info, utcb); }
342
343 struct _Info { l4_umword_t features, nr_irqs, nr_msis; };
345
361
365 l4_msgtag_t control(unsigned irqnum, unsigned op, l4_umword_t *label,
366 l4_timeout_t to, l4_utcb_t *utcb = l4_utcb()) noexcept
367 { return l4_icu_control_u(cap(), irqnum, op, label, to, utcb); }
368
388 l4_msgtag_t mask(unsigned irqnum,
389 l4_umword_t *label = 0,
391 l4_utcb_t *utcb = l4_utcb()) noexcept
392 { return l4_icu_mask_u(cap(), irqnum, label, to, utcb); }
393
396 l4_msgtag_t, mask, (l4_umword_t irqnum),
398 );
399
400
403 l4_msgtag_t, unmask, (l4_umword_t irqnum),
405 );
406
416 l4_msgtag_t set_mode(unsigned irqnum, l4_umword_t mode,
417 l4_utcb_t *utcb = l4_utcb()) noexcept
418 { return l4_icu_set_mode_u(cap(), irqnum, mode, utcb); }
419
423 );
424
425 typedef L4::Typeid::Rpcs_sys<
426 bind_t, unbind_t, info_t, msi_info_t, unmask_t, mask_t, set_mode_t
427 > Rpcs;
428};
429
430}
L4::Cap related definitions.
l4_cap_idx_t cap() const noexcept
Return capability selector.
Definition capability.h:49
C++ interface for capabilities.
Definition capability.h:219
This class encapsulates information about an ICU.
Definition irq:274
bool supports_msi() const noexcept
True, if the ICU has support for MSIs.
Definition irq:277
C++ Icu interface, see Interrupt controller for the C interface.
Definition irq:249
l4_msgtag_t msi_info(l4_umword_t irqnum, l4_uint64_t source, l4_icu_msi_info_t *msi_info)
Get MSI info about IRQ.
l4_msgtag_t info(l4_icu_info_t *info, l4_utcb_t *utcb=l4_utcb()) noexcept
Get information about the ICU features.
Definition irq:340
l4_msgtag_t set_mode(unsigned irqnum, l4_umword_t mode, l4_utcb_t *utcb=l4_utcb()) noexcept
Set interrupt mode.
Definition irq:416
l4_msgtag_t unbind(unsigned irqnum, L4::Cap< Triggerable > irq, l4_utcb_t *utcb=l4_utcb()) noexcept
Remove binding of an interrupt line from the interrupt controller object.
Definition irq:323
l4_msgtag_t mask(unsigned irqnum, l4_umword_t *label=0, l4_timeout_t to=L4_IPC_NEVER, l4_utcb_t *utcb=l4_utcb()) noexcept
Mask an IRQ line.
Definition irq:388
l4_msgtag_t bind(unsigned irqnum, L4::Cap< Triggerable > irq, l4_utcb_t *utcb=l4_utcb()) noexcept
Bind an interrupt line of an interrupt controller to an interrupt object.
Definition irq:305
Capability type for RPC interfaces (see L4::Cap<T>).
Definition ipc_types:699
Interface for sending an unmask message to an object.
Definition irq:38
l4_msgtag_t unmask(unsigned irqnum, l4_umword_t *label=0, l4_timeout_t to=L4_IPC_NEVER, l4_utcb_t *utcb=l4_utcb()) noexcept
Unmask the given interrupt line.
Definition irq:64
C++ Irq interface, see IRQs for the C interface.
Definition irq:121
l4_msgtag_t detach(l4_utcb_t *utcb=l4_utcb()) noexcept
Detach from this interrupt.
Definition irq:173
l4_msgtag_t wait(l4_umword_t *label, l4_timeout_t timeout=L4_IPC_NEVER, l4_utcb_t *utcb=l4_utcb()) noexcept
Unmask IRQ and (open) wait for any message.
Definition irq:201
l4_msgtag_t unmask(l4_utcb_t *utcb=l4_utcb()) noexcept
Unmask this IRQ.
Definition irq:218
l4_msgtag_t receive(l4_timeout_t timeout=L4_IPC_NEVER, l4_utcb_t *utcb=l4_utcb()) noexcept
Unmask and wait for this IRQ.
Definition irq:188
l4_msgtag_t bind_vcpu(L4::Cap< Thread > const &thread, l4_umword_t cfg, l4_utcb_t *utcb=l4_utcb()) noexcept
Bind a thread to this Irq for vCPU interrupt forwarding.
Definition irq:156
Helper class to create an L4Re interface class that is derived from two base classes (see L4::Kobject...
Definition __typeinfo.h:828
Helper class to create an L4Re interface class that is derived from a single base class.
Definition __typeinfo.h:750
unsigned long l4_umword_t
Unsigned machine word.
Definition l4int.h:40
unsigned long long l4_uint64_t
Unsigned 64bit value.
Definition l4int.h:31
l4_msgtag_t l4_icu_bind_u(l4_cap_idx_t icu, unsigned irqnum, l4_cap_idx_t irq, l4_utcb_t *utcb) L4_NOTHROW
Bind an interrupt line of an interrupt controller to an interrupt object.
Definition icu.h:394
l4_msgtag_t l4_icu_info_u(l4_cap_idx_t icu, l4_icu_info_t *info, l4_utcb_t *utcb) L4_NOTHROW
Get information about the ICU features.
Definition icu.h:418
l4_msgtag_t l4_icu_set_mode_u(l4_cap_idx_t icu, unsigned irqnum, l4_umword_t mode, l4_utcb_t *utcb) L4_NOTHROW
Set interrupt mode.
Definition icu.h:455
l4_msgtag_t l4_icu_mask_u(l4_cap_idx_t icu, unsigned irqnum, l4_umword_t *label, l4_timeout_t to, l4_utcb_t *utcb) L4_NOTHROW
Mask an IRQ line.
Definition icu.h:481
l4_msgtag_t l4_icu_unbind_u(l4_cap_idx_t icu, unsigned irqnum, l4_cap_idx_t irq, l4_utcb_t *utcb) L4_NOTHROW
Remove binding of an interrupt line from the interrupt controller object.
Definition icu.h:406
@ L4_ICU_FLAG_MSI
Flag to denote that the IRQ is actually an MSI.
Definition icu.h:61
l4_msgtag_t l4_irq_trigger_u(l4_cap_idx_t irq, l4_utcb_t *utcb) L4_NOTHROW
Trigger the object.
Definition irq.h:259
l4_msgtag_t l4_irq_bind_vcpu_u(l4_cap_idx_t irq, l4_cap_idx_t thread, l4_umword_t cfg, l4_utcb_t *utcb) L4_NOTHROW
Bind a thread to this Irq for vCPU interrupt forwarding.
Definition irq.h:246
l4_msgtag_t l4_irq_receive_u(l4_cap_idx_t irq, l4_timeout_t timeout, l4_utcb_t *utcb) L4_NOTHROW
Unmask and wait for this IRQ.
Definition irq.h:266
l4_msgtag_t l4_irq_detach_u(l4_cap_idx_t irq, l4_utcb_t *utcb) L4_NOTHROW
Detach from this interrupt.
Definition irq.h:238
@ L4_IRQ_F_MASK
Mask.
Definition icu.h:84
@ L4_IRQ_F_NEG_EDGE
Negative edge trigger.
Definition icu.h:82
@ L4_IRQ_F_CLEAR_WAKEUP
Do not use irq as wakeup source.
Definition icu.h:88
@ L4_IRQ_F_SET_WAKEUP
Wakeup source?
Definition icu.h:87
@ L4_IRQ_F_LEVEL_HIGH
Level high trigger.
Definition icu.h:79
@ L4_IRQ_F_BOTH_EDGE
Both edges trigger.
Definition icu.h:83
@ L4_IRQ_F_POS_EDGE
Positive edge trigger.
Definition icu.h:81
@ L4_IRQ_F_NONE
Flow types.
Definition icu.h:72
@ L4_IRQ_F_LEVEL_LOW
Level low trigger.
Definition icu.h:80
@ L4_ICU_OP_MASK
Mask opcode.
Definition icu.h:138
@ L4_ICU_OP_SET_MODE
Set-mode opcode.
Definition icu.h:145
@ L4_ICU_OP_UNMASK
Unmask opcode.
Definition icu.h:131
@ L4_ICU_OP_INFO
Info opcode.
Definition icu.h:117
@ L4_ICU_OP_MSI_INFO
Msi-info opcode.
Definition icu.h:124
@ L4_ICU_OP_UNBIND
Unbind opcode.
Definition icu.h:110
@ L4_ICU_OP_BIND
Bind opcode.
Definition icu.h:103
#define L4_IPC_NEVER
never timeout
Definition __timeout.h:76
struct l4_utcb_t l4_utcb_t
Opaque type for the UTCB.
Definition utcb.h:56
l4_utcb_t * l4_utcb(void) L4_NOTHROW L4_PURE
Get the UTCB address.
Definition utcb.h:346
Interrupt controller.
Interface Definition Language.
#define L4_RPC_NF_OP(op, res, name, args...)
Define an RPC call type with specific opcode (the type only, no callable).
Definition ipc_iface:519
#define L4_INLINE_RPC_OP(op, res, name, args, attr...)
Define an inline RPC call with specific opcode (type and callable).
Definition ipc_iface:491
C Irq interface.
L4 low-level kernel interface.
The C++ Receive endpoint interface.
RPC attribute for a send-only RPC.
Definition ipc_iface:282
Interface that allows an object to be triggered by some source.
Definition irq:80
l4_msgtag_t trigger(l4_utcb_t *utcb=l4_utcb()) noexcept
Trigger the object.
Definition irq:91
List of RPCs typically used for kernel interfaces.
Definition __typeinfo.h:465
Info structure for an ICU.
Definition icu.h:163
unsigned features
Feature flags.
Definition icu.h:169
Info to use for a specific MSI.
Definition icu.h:184
Message tag data structure.
Definition types.h:153
Timeout pair.
Definition __timeout.h:53