platform_control.h

Go to the documentation of this file.

 
/*
 * (c) 2014 Alexander Warg <alexander.warg@kernkonzept.com>
 *
 * 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/types.h>
#include <l4/sys/utcb.h>
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_suspend(l4_cap_idx_t pfc,
                               l4_umword_t extras) L4_NOTHROW;
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_suspend_u(l4_cap_idx_t pfc,
                                 l4_umword_t extras,
                                 l4_utcb_t *utcb) L4_NOTHROW;
 
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_shutdown(l4_cap_idx_t pfc,
                                l4_umword_t reboot) L4_NOTHROW;
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_shutdown_u(l4_cap_idx_t pfc,
                                  l4_umword_t reboot,
                                  l4_utcb_t *utcb) L4_NOTHROW;
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_allow_shutdown(l4_cap_idx_t pfc,
                                   l4_umword_t phys_id,
                                   l4_umword_t enable) L4_NOTHROW;
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_allow_shutdown_u(l4_cap_idx_t pfc,
                                     l4_umword_t phys_id,
                                     l4_umword_t enable,
                                     l4_utcb_t *utcb) L4_NOTHROW;
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_enable(l4_cap_idx_t pfc,
                           l4_umword_t phys_id) L4_NOTHROW;
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_enable_u(l4_cap_idx_t pfc,
                             l4_umword_t phys_id,
                             l4_utcb_t *utcb) L4_NOTHROW;
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_disable(l4_cap_idx_t pfc,
                            l4_umword_t phys_id) L4_NOTHROW;
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_disable_u(l4_cap_idx_t pfc,
                              l4_umword_t phys_id,
                              l4_utcb_t *utcb) L4_NOTHROW;
 
 
 
enum L4_platform_ctl_ops
{
  L4_PLATFORM_CTL_SYS_SUSPEND_OP        = 0UL, 
  L4_PLATFORM_CTL_SYS_SHUTDOWN_OP       = 1UL, 
  L4_PLATFORM_CTL_CPU_ALLOW_SHUTDOWN_OP = 2UL, 
  L4_PLATFORM_CTL_CPU_ENABLE_OP         = 3UL, 
  L4_PLATFORM_CTL_CPU_DISABLE_OP        = 4UL, 
  L4_PLATFORM_CTL_SET_TASK_ASID_OP      = 0x10UL, 
};
 
enum L4_platform_ctl_proto
{
  L4_PROTO_PLATFORM_CTL = 0
};
 
/* IMPLEMENTATION -----------------------------------------------------------*/
 
#include <l4/sys/ipc.h>
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_suspend_u(l4_cap_idx_t pfc,
                                 l4_umword_t extras,
                                 l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  v->mr[0] = L4_PLATFORM_CTL_SYS_SUSPEND_OP;
  v->mr[1] = extras;
  return l4_ipc_call(pfc, utcb, l4_msgtag(L4_PROTO_PLATFORM_CTL, 2, 0, 0),
                                          L4_IPC_NEVER);
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_shutdown_u(l4_cap_idx_t pfc,
                                  l4_umword_t reboot,
                                  l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  v->mr[0] = L4_PLATFORM_CTL_SYS_SHUTDOWN_OP;
  v->mr[1] = reboot;
  return l4_ipc_call(pfc, utcb, l4_msgtag(L4_PROTO_PLATFORM_CTL, 2, 0, 0),
                                          L4_IPC_NEVER);
}
 
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_suspend(l4_cap_idx_t pfc,
                               l4_umword_t extras) L4_NOTHROW
{
  return l4_platform_ctl_system_suspend_u(pfc, extras, l4_utcb());
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_system_shutdown(l4_cap_idx_t pfc,
                                l4_umword_t reboot) L4_NOTHROW
{
  return l4_platform_ctl_system_shutdown_u(pfc, reboot, l4_utcb());
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_allow_shutdown_u(l4_cap_idx_t pfc,
                                     l4_umword_t phys_id,
                                     l4_umword_t enable,
                                     l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  v->mr[0] = L4_PLATFORM_CTL_CPU_ALLOW_SHUTDOWN_OP;
  v->mr[1] = phys_id;
  v->mr[2] = enable;
  return l4_ipc_call(pfc, utcb, l4_msgtag(L4_PROTO_PLATFORM_CTL, 3, 0, 0),
                                          L4_IPC_NEVER);
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_allow_shutdown(l4_cap_idx_t pfc,
                                   l4_umword_t phys_id,
                                   l4_umword_t enable) L4_NOTHROW
{
  return l4_platform_ctl_cpu_allow_shutdown_u(pfc, phys_id, enable, l4_utcb());
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_enable_u(l4_cap_idx_t pfc,
                             l4_umword_t phys_id,
                             l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  v->mr[0] = L4_PLATFORM_CTL_CPU_ENABLE_OP;
  v->mr[1] = phys_id;
  return l4_ipc_call(pfc, utcb, l4_msgtag(L4_PROTO_PLATFORM_CTL, 2, 0, 0),
                                          L4_IPC_NEVER);
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_disable_u(l4_cap_idx_t pfc,
                              l4_umword_t phys_id,
                              l4_utcb_t *utcb) L4_NOTHROW
{
  l4_msg_regs_t *v = l4_utcb_mr_u(utcb);
  v->mr[0] = L4_PLATFORM_CTL_CPU_DISABLE_OP;
  v->mr[1] = phys_id;
  return l4_ipc_call(pfc, utcb, l4_msgtag(L4_PROTO_PLATFORM_CTL, 2, 0, 0),
                                          L4_IPC_NEVER);
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_enable(l4_cap_idx_t pfc,
                           l4_umword_t phys_id) L4_NOTHROW
{
  return l4_platform_ctl_cpu_enable_u(pfc, phys_id, l4_utcb());
}
 
L4_INLINE l4_msgtag_t
l4_platform_ctl_cpu_disable(l4_cap_idx_t pfc,
                            l4_umword_t phys_id) L4_NOTHROW
{
  return l4_platform_ctl_cpu_disable_u(pfc, phys_id, l4_utcb());
}