L4Re Operating System Framework
Interface and Usage Documentation
Loading...
Searching...
No Matches
consts.h
Go to the documentation of this file.
1
6/*
7 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
8 * Alexander Warg <warg@os.inf.tu-dresden.de>,
9 * Björn Döbel <doebel@os.inf.tu-dresden.de>,
10 * Torsten Frenzel <frenzel@os.inf.tu-dresden.de>
11 * economic rights: Technische Universität Dresden (Germany)
12 *
13 * License: see LICENSE.spdx (in this directory or the directories above)
14 */
15#ifndef __L4_SYS__INCLUDE__CONSTS_H__
16#define __L4_SYS__INCLUDE__CONSTS_H__
17
18#include <l4/sys/arch/consts.h>
19#include <l4/sys/compiler.h>
20#include <l4/sys/l4int.h>
21
53
58#define L4_SYSF_NONE 0x00
59
71#define L4_SYSF_SEND 0x01
72
82#define L4_SYSF_RECV 0x02
83
93#define L4_SYSF_OPEN_WAIT 0x04
94
102#define L4_SYSF_REPLY 0x08
103
110#define L4_SYSF_CALL (L4_SYSF_SEND | L4_SYSF_RECV)
111
118#define L4_SYSF_WAIT (L4_SYSF_OPEN_WAIT | L4_SYSF_RECV)
119
126#define L4_SYSF_SEND_AND_WAIT (L4_SYSF_OPEN_WAIT | L4_SYSF_CALL)
127
134#define L4_SYSF_REPLY_AND_WAIT (L4_SYSF_WAIT | L4_SYSF_SEND | L4_SYSF_REPLY)
135
137
138
143#define L4_CAP_SHIFT 12UL
149#define L4_CAP_SIZE (1UL << L4_CAP_SHIFT)
154#define L4_CAP_OFFSET (1UL << L4_CAP_SHIFT)
160#define L4_CAP_MASK (~0UL << (L4_CAP_SHIFT - 1))
165#define L4_INVALID_CAP (~0UL << (L4_CAP_SHIFT - 1))
166
173#define L4_INVALID_CAP_BIT (1UL << (L4_CAP_SHIFT - 1))
174
175enum l4_sched_consts_t
176{
177 L4_SCHED_MIN_PRIO = 1,
178 L4_SCHED_MAX_PRIO = 255,
179};
180
187{
200 L4_FP_ALL_SPACES = 0x80000000UL,
201
214 L4_FP_DELETE_OBJ = 0xc0000000UL,
215
223};
224
315
321{
325 L4_BDR_OFFSET_MASK = (1UL << 20) - 1,
326};
327
397
408#define L4_PAGESIZE (1UL << L4_PAGESHIFT)
409
417#define L4_PAGEMASK (~(L4_PAGESIZE - 1))
418
426#define L4_LOG2_PAGESIZE L4_PAGESHIFT
427
435#define L4_SUPERPAGESIZE (1UL << L4_SUPERPAGESHIFT)
436
444#define L4_SUPERPAGEMASK (~(L4_SUPERPAGESIZE - 1))
445
452#define L4_LOG2_SUPERPAGESIZE L4_SUPERPAGESHIFT
453
467
475L4_INLINE l4_addr_t l4_trunc_size(l4_addr_t address, unsigned char bits) L4_NOTHROW;
477{ return address & (~0UL << bits); }
478
492
500L4_INLINE l4_addr_t l4_round_size(l4_addr_t value, unsigned char bits) L4_NOTHROW;
502{ return (value + (1UL << bits) - 1) & (~0UL << bits); }
503
512L4_INLINE unsigned l4_bytes_to_mwords(unsigned size) L4_NOTHROW;
514{ return (size + sizeof(l4_umword_t) - 1) / sizeof(l4_umword_t); }
515
524
529#define L4_INVALID_PTR ((void *)L4_INVALID_ADDR)
530
531#ifndef NULL
532#ifndef __cplusplus
533# define NULL ((void *)0)
537#elif __cplusplus >= 201103L
538# define NULL nullptr
539#else
540# define NULL 0
541#endif
542#endif
543
544#endif /* ! __L4_SYS__INCLUDE__CONSTS_H__ */
L4 compiler related defines.
unsigned long l4_umword_t
Unsigned machine word.
Definition l4int.h:40
unsigned long l4_addr_t
Address type.
Definition l4int.h:34
l4_default_caps_t
Default capabilities setup for the initial tasks.
Definition consts.h:342
#define L4_CAP_SHIFT
Capability index shift; see l4_cap_idx_t.
Definition consts.h:143
@ L4_BASE_IOMMU_CAP
Capability index for the IO-MMU cap.
Definition consts.h:375
@ L4_BASE_THREAD_CAP
Capability index for the first thread.
Definition consts.h:348
@ L4_BASE_DEBUGGER_CAP
Capability index for the debugger cap.
Definition consts.h:383
@ L4_BASE_PAGER_CAP
Capability index for the pager gate.
Definition consts.h:356
@ L4_BASE_FACTORY_CAP
Capability index for the factory.
Definition consts.h:346
@ L4_BASE_CAPS_LAST
Last capability index used for base capabilities.
Definition consts.h:395
@ L4_BASE_SCHEDULER_CAP
Capability index for the scheduler cap.
Definition consts.h:368
@ L4_BASE_TASK_CAP
Capability index for the current task.
Definition consts.h:344
@ L4_BASE_ARM_SMCCC_CAP
Capability index for the ARM SMCCC cap.
Definition consts.h:390
@ L4_BASE_LOG_CAP
Capability index for the log object.
Definition consts.h:364
@ L4_BASE_ICU_CAP
Capability index for the base icu object.
Definition consts.h:366
unsigned l4_bytes_to_mwords(unsigned size) L4_NOTHROW
Determine how many machine words (l4_umword_t) are required to store a buffer of 'size' bytes.
Definition consts.h:513
l4_addr_consts_t
Address related constants.
Definition consts.h:520
l4_addr_t l4_trunc_page(l4_addr_t address) L4_NOTHROW
Round an address down to the next lower page boundary.
Definition consts.h:465
l4_addr_t l4_trunc_size(l4_addr_t address, unsigned char bits) L4_NOTHROW
Round an address down to the next lower flexpage with size bits.
Definition consts.h:476
l4_addr_t l4_round_page(l4_addr_t address) L4_NOTHROW
Round address up to the next page.
Definition consts.h:490
#define L4_PAGESIZE
Minimal page size (in bytes).
Definition consts.h:408
#define L4_PAGEMASK
Mask for the page number.
Definition consts.h:417
l4_addr_t l4_round_size(l4_addr_t value, unsigned char bits) L4_NOTHROW
Round value up to the next alignment with bits size.
Definition consts.h:501
@ L4_INVALID_ADDR
Invalid address.
Definition consts.h:522
l4_msg_item_consts_t
Constants for message items.
Definition consts.h:230
@ L4_MAP_ITEM_GRANT
Flag as grant instead of map operation.
Definition consts.h:262
@ L4_RCV_ITEM_FORWARD_MAPPINGS
This flag specifies if received capabilities shall be mapped to a particular task instead of the invo...
Definition consts.h:277
@ L4_ITEM_MAP
Identify a message item as map item.
Definition consts.h:231
@ L4_RCV_ITEM_LOCAL_ID
The receiver requests to receive a local ID instead of a mapping whenever possible.
Definition consts.h:313
@ L4_ITEM_CONT
Denote that the following item shall be put into the same receive item as this one.
Definition consts.h:237
@ L4_MAP_ITEM_MAP
Flag as usual map operation.
Definition consts.h:264
@ L4_RCV_ITEM_SINGLE_CAP
Mark the receive buffer to be a small receive item that describes a buffer for a single object capabi...
Definition consts.h:292
l4_unmap_flags_t
Flags for the unmap operation.
Definition consts.h:187
@ L4_FP_DELETE_OBJ
Flag that indicates that an unmap operation on object capabilities shall try to delete the correspond...
Definition consts.h:214
@ L4_FP_ALL_SPACES
Flag to tell the unmap operation to revoke permissions from all child mappings including the mapping ...
Definition consts.h:200
@ L4_FP_OTHER_SPACES
Counterpart to L4_FP_ALL_SPACES; revoke permissions from child mappings only.
Definition consts.h:222
l4_buffer_desc_consts_t
Constants for buffer descriptors.
Definition consts.h:321
@ L4_BDR_IO_SHIFT
Bit offset for the IO-buffer index.
Definition consts.h:323
@ L4_BDR_MEM_SHIFT
Bit offset for the memory-buffer index.
Definition consts.h:322
@ L4_BDR_OBJ_SHIFT
Bit offset for the capability-buffer index.
Definition consts.h:324
#define L4_NOTHROW
Mark a function declaration and definition as never throwing an exception.
Definition compiler.h:167
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:51
Fixed sized integer types, generic version.