pi_mutex.h

Go to the documentation of this file.

/*
 * Copyright (C) 2025-2026 Kernkonzept GmbH.
 * Author(s): Georg Kotheimer <georg.kotheimer@kernkonzept.com>
 *
 * License: see LICENSE.spdx (in this directory or the directories above)
 */
 
#pragma once
 
#include <l4/sys/types.h>
#include <l4/sys/utcb.h>


L4_INLINE l4_msgtag_t
l4_pi_mutex_lock(l4_cap_idx_t mutex, l4_timeout_t timeout) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_pi_mutex_lock_u(l4_cap_idx_t mutex, l4_timeout_t timeout,
                   l4_utcb_t *utcb) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_pi_mutex_unlock(l4_cap_idx_t mutex) L4_NOTHROW;

L4_INLINE l4_msgtag_t
l4_pi_mutex_unlock_u(l4_cap_idx_t mutex, l4_utcb_t *utcb) L4_NOTHROW;
 /* ends l4_pi_mutex_api group */
 

enum L4_pi_mutex_ops
{
  L4_PI_MUTEX_LOCK_OP      = 0UL, 
  L4_PI_MUTEX_UNLOCK_OP    = 1UL, 
};
 
/* IMPLEMENTATION -----------------------------------------------------------*/
 
#include <l4/sys/ipc.h>
 
L4_INLINE l4_msgtag_t
l4_pi_mutex_lock_u(l4_cap_idx_t mutex, l4_timeout_t timeout,
                   l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  v->mr[0] = L4_PI_MUTEX_LOCK_OP;
  return l4_ipc_call(mutex, utcb, l4_msgtag(L4_PROTO_PI_MUTEX, 1, 0, 0),
                     timeout);
}
 
L4_INLINE l4_msgtag_t
l4_pi_mutex_unlock_u(l4_cap_idx_t mutex, l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  v->mr[0] = L4_PI_MUTEX_UNLOCK_OP;
  return l4_ipc_call(mutex, utcb, l4_msgtag(L4_PROTO_PI_MUTEX, 1, 0, 0),
                     L4_IPC_NEVER);
}
 
 
L4_INLINE l4_msgtag_t
l4_pi_mutex_lock(l4_cap_idx_t mutex, l4_timeout_t timeout) L4_NOTHROW
{
  return l4_pi_mutex_lock_u(mutex, timeout, l4_utcb());
}
 
L4_INLINE l4_msgtag_t
l4_pi_mutex_unlock(l4_cap_idx_t mutex) L4_NOTHROW
{
  return l4_pi_mutex_unlock_u(mutex, l4_utcb());
}