irq

Go to the documentation of this file.

// vi:set ft=cpp: -*- Mode: C++ -*-
/*
 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Alexander Warg <warg@os.inf.tu-dresden.de>
 *     economic rights: Technische Universität Dresden (Germany)
 *
 * This file is part of TUD:OS and distributed under the terms of the
 * GNU General Public License 2.
 * Please see the COPYING-GPL-2 file for details.
 *
 * As a special exception, you may use this file as part of a free software
 * library without restriction.  Specifically, if other files instantiate
 * templates or use macros or inline functions from this file, or you compile
 * this file and link it with other files to produce an executable, this
 * file does not by itself cause the resulting executable to be covered by
 * the GNU General Public License.  This exception does not however
 * invalidate any other reasons why the executable file might be covered by
 * the GNU General Public License.
 */
 
#pragma once
 
#include <l4/sys/icu.h>
#include <l4/sys/irq.h>
#include <l4/sys/capability>
#include <l4/sys/rcv_endpoint>
#include <l4/sys/cxx/ipc_iface>
#include <l4/sys/cxx/ipc_types>
 
namespace L4 {
 
class Irq_eoi : public Kobject_0t<Irq_eoi, L4::PROTO_EMPTY>
{
public:
  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
  {
    return l4_icu_control_u(cap(), irqnum, L4_ICU_CTL_UNMASK, label, to, utcb);
  }
};
 
struct Triggerable : Kobject_t<Triggerable, Irq_eoi, L4_PROTO_IRQ>
{
  l4_msgtag_t trigger(l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_irq_trigger_u(cap(), utcb); }
};
 
class Irq : public Kobject_2t<Irq, Triggerable, Rcv_endpoint, L4_PROTO_IRQ_SENDER>
{
public:
  using Triggerable::unmask;
 
  l4_msgtag_t detach(l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_irq_detach_u(cap(), utcb); }
 
 
  l4_msgtag_t receive(l4_timeout_t timeout = L4_IPC_NEVER,
                      l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_irq_receive_u(cap(), timeout, utcb); }
 
  l4_msgtag_t wait(l4_umword_t *label, l4_timeout_t timeout = L4_IPC_NEVER,
                   l4_utcb_t *utcb = l4_utcb()) noexcept
  { return unmask(-1, label, timeout, utcb); }
 
  l4_msgtag_t unmask(l4_utcb_t *utcb = l4_utcb()) noexcept
  { return unmask(-1, 0, L4_IPC_NEVER, utcb); }
};
 
struct Irq_mux : Kobject_t<Irq_mux, Triggerable, L4_PROTO_IRQ_MUX>
{
  l4_msgtag_t chain(Cap<Triggerable> const &slave,
                    l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_irq_mux_chain_u(cap(), slave.cap(), utcb); }
};
 
 
class Icu :
  public Kobject_t<Icu, Irq_eoi, L4_PROTO_IRQ,
                   Type_info::Demand_t<1> >
{
public:
  enum Mode
  {
    F_none         = L4_IRQ_F_NONE,
    F_level_high   = L4_IRQ_F_LEVEL_HIGH,
    F_level_low    = L4_IRQ_F_LEVEL_LOW,
    F_pos_edge     = L4_IRQ_F_POS_EDGE,
    F_neg_edge     = L4_IRQ_F_NEG_EDGE,
    F_both_edge    = L4_IRQ_F_BOTH_EDGE,
    F_mask         = L4_IRQ_F_MASK,
 
    F_set_wakeup   = L4_IRQ_F_SET_WAKEUP,
    F_clear_wakeup = L4_IRQ_F_CLEAR_WAKEUP,
  };
 
  enum Flags
  {
    F_msi = L4_ICU_FLAG_MSI
  };
 
  class Info : public l4_icu_info_t
  {
  public:
    bool supports_msi() const noexcept { return features & F_msi; }
  };
 
  l4_msgtag_t bind(unsigned irqnum, L4::Cap<Triggerable> irq,
                   l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_icu_bind_u(cap(), irqnum, irq.cap(), utcb); }
 
  L4_RPC_NF_OP(
    L4_ICU_OP_BIND,
    l4_msgtag_t, bind, (l4_umword_t irqnum, Ipc::Cap<Irq> irq)
  );
 
  l4_msgtag_t unbind(unsigned irqnum, L4::Cap<Triggerable> irq,
                     l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_icu_unbind_u(cap(), irqnum, irq.cap(), utcb); }
 
  L4_RPC_NF_OP(
    L4_ICU_OP_UNBIND,
    l4_msgtag_t, unbind, (l4_umword_t irqnum, Ipc::Cap<Irq> irq)
  );
 
  l4_msgtag_t info(l4_icu_info_t *info, l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_icu_info_u(cap(), info, utcb); }
 
  struct _Info { l4_umword_t features, nr_irqs, nr_msis; };
  L4_RPC_NF_OP(L4_ICU_OP_INFO, l4_msgtag_t, info, (_Info *info));
 
  L4_INLINE_RPC_OP(L4_ICU_OP_MSI_INFO,
      l4_msgtag_t, msi_info, (l4_umword_t irqnum, l4_uint64_t source,
                              l4_icu_msi_info_t *msi_info));
 
  l4_msgtag_t control(unsigned irqnum, unsigned op, l4_umword_t *label,
                      l4_timeout_t to, l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_icu_control_u(cap(), irqnum, op, label, to, utcb); }
 
  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
  { return l4_icu_mask_u(cap(), irqnum, label, to, utcb); }
 
  L4_RPC_NF_OP(
    L4_ICU_OP_MASK,
    l4_msgtag_t, mask, (l4_umword_t irqnum),
    L4::Ipc::Send_only
  );
 
 
  L4_RPC_NF_OP(
    L4_ICU_OP_UNMASK,
    l4_msgtag_t, unmask, (l4_umword_t irqnum),
    L4::Ipc::Send_only
  );
 
  l4_msgtag_t set_mode(unsigned irqnum, l4_umword_t mode,
                       l4_utcb_t *utcb = l4_utcb()) noexcept
  { return l4_icu_set_mode_u(cap(), irqnum, mode, utcb); }
 
  L4_RPC_NF_OP(
    L4_ICU_OP_SET_MODE,
    l4_msgtag_t, set_mode, (l4_umword_t irqnum, l4_umword_t mode)
  );
 
  typedef L4::Typeid::Rpcs_sys<
    bind_t, unbind_t, info_t, msi_info_t, unmask_t, mask_t, set_mode_t
  > Rpcs;
};
 
}