mirror of
https://github.com/genodelabs/genode.git
synced 2024-12-19 21:57:55 +00:00
292 lines
8.2 KiB
C++
292 lines
8.2 KiB
C++
/*
|
|
* \brief Interface between kernel and userland
|
|
* \author Martin stein
|
|
* \date 2011-11-30
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2011-2013 Genode Labs GmbH
|
|
*
|
|
* This file is part of the Genode OS framework, which is distributed
|
|
* under the terms of the GNU General Public License version 2.
|
|
*/
|
|
|
|
#ifndef _INCLUDE__KERNEL__INTERFACE_H_
|
|
#define _INCLUDE__KERNEL__INTERFACE_H_
|
|
|
|
/* base-hw includes */
|
|
#include <kernel/interface_support.h>
|
|
|
|
namespace Kernel
|
|
{
|
|
using addr_t = Genode::addr_t;
|
|
using size_t = Genode::size_t;
|
|
using capid_t = Genode::uint16_t;
|
|
|
|
constexpr capid_t cap_id_invalid() { return 0; }
|
|
|
|
/**
|
|
* Kernel names of the kernel calls
|
|
*/
|
|
constexpr Call_arg call_id_pause_current_thread() { return 0; }
|
|
constexpr Call_arg call_id_resume_local_thread() { return 1; }
|
|
constexpr Call_arg call_id_yield_thread() { return 2; }
|
|
constexpr Call_arg call_id_send_request_msg() { return 3; }
|
|
constexpr Call_arg call_id_send_reply_msg() { return 4; }
|
|
constexpr Call_arg call_id_await_request_msg() { return 5; }
|
|
constexpr Call_arg call_id_kill_signal_context() { return 6; }
|
|
constexpr Call_arg call_id_submit_signal() { return 7; }
|
|
constexpr Call_arg call_id_await_signal() { return 8; }
|
|
constexpr Call_arg call_id_ack_signal() { return 9; }
|
|
constexpr Call_arg call_id_print_char() { return 10; }
|
|
constexpr Call_arg call_id_update_data_region() { return 11; }
|
|
constexpr Call_arg call_id_update_instr_region() { return 12; }
|
|
constexpr Call_arg call_id_ack_cap() { return 13; }
|
|
constexpr Call_arg call_id_delete_cap() { return 14; }
|
|
|
|
|
|
/*****************************************************************
|
|
** Kernel call with 1 to 6 arguments **
|
|
** **
|
|
** These functions must not be inline to ensure that objects, **
|
|
** wich are referenced by arguments, are tagged as "used" even **
|
|
** though only the pointer gets handled in here. **
|
|
*****************************************************************/
|
|
|
|
Call_ret call(Call_arg arg_0);
|
|
|
|
Call_ret call(Call_arg arg_0,
|
|
Call_arg arg_1);
|
|
|
|
Call_ret call(Call_arg arg_0,
|
|
Call_arg arg_1,
|
|
Call_arg arg_2);
|
|
|
|
Call_ret call(Call_arg arg_0,
|
|
Call_arg arg_1,
|
|
Call_arg arg_2,
|
|
Call_arg arg_3);
|
|
|
|
Call_ret call(Call_arg arg_0,
|
|
Call_arg arg_1,
|
|
Call_arg arg_2,
|
|
Call_arg arg_3,
|
|
Call_arg arg_4);
|
|
|
|
Call_ret call(Call_arg arg_0,
|
|
Call_arg arg_1,
|
|
Call_arg arg_2,
|
|
Call_arg arg_3,
|
|
Call_arg arg_4,
|
|
Call_arg arg_5);
|
|
|
|
|
|
/**
|
|
* Pause execution of calling thread
|
|
*/
|
|
inline void pause_current_thread()
|
|
{
|
|
call(call_id_pause_current_thread());
|
|
}
|
|
|
|
|
|
/**
|
|
* Cancel blocking of a thread of the current domain if possible
|
|
*
|
|
* \param thread_id capability id of the targeted thread
|
|
*
|
|
* \return wether thread was in a cancelable blocking beforehand
|
|
*/
|
|
inline bool resume_local_thread(capid_t const thread_id)
|
|
{
|
|
return call(call_id_resume_local_thread(), thread_id);
|
|
}
|
|
|
|
|
|
/**
|
|
* Let the current thread give up its remaining timeslice
|
|
*
|
|
* \param thread_id capability id of the benefited thread
|
|
*
|
|
* If thread_id is valid the call will resume the targeted thread
|
|
* additionally.
|
|
*/
|
|
inline void yield_thread(capid_t const thread_id)
|
|
{
|
|
call(call_id_yield_thread(), thread_id);
|
|
}
|
|
|
|
/**
|
|
* Globally apply writes to a data region in the current domain
|
|
*
|
|
* \param base base of the region within the current domain
|
|
* \param size size of the region
|
|
*/
|
|
inline void update_data_region(addr_t const base, size_t const size)
|
|
{
|
|
call(call_id_update_data_region(), (Call_arg)base, (Call_arg)size);
|
|
}
|
|
|
|
/**
|
|
* Globally apply writes to an instruction region in the current domain
|
|
*
|
|
* \param base base of the region within the current domain
|
|
* \param size size of the region
|
|
*/
|
|
inline void update_instr_region(addr_t const base, size_t const size)
|
|
{
|
|
call(call_id_update_instr_region(), (Call_arg)base, (Call_arg)size);
|
|
}
|
|
|
|
/**
|
|
* Send request message and await receipt of corresponding reply message
|
|
*
|
|
* \param thread_id capability id of targeted thread
|
|
*
|
|
* \retval 0 succeeded
|
|
* \retval -1 failed
|
|
* \retval -2 failed due to out-of-memory for capability reception
|
|
*
|
|
* If the call returns successful, the received message is located at the
|
|
* base of the callers userland thread-context.
|
|
*/
|
|
inline int send_request_msg(capid_t const thread_id, unsigned rcv_caps)
|
|
{
|
|
return call(call_id_send_request_msg(), thread_id, rcv_caps);
|
|
}
|
|
|
|
|
|
/**
|
|
* Await receipt of request message
|
|
*
|
|
* \param rcv_caps number of capabilities willing to accept
|
|
*
|
|
* \retval 0 succeeded
|
|
* \retval -1 canceled
|
|
* \retval -2 failed due to out-of-memory for capability reception
|
|
*
|
|
* If the call returns successful, the received message is located at the
|
|
* base of the callers userland thread-context.
|
|
*/
|
|
inline int await_request_msg(unsigned rcv_caps)
|
|
{
|
|
return call(call_id_await_request_msg(), rcv_caps);
|
|
}
|
|
|
|
|
|
/**
|
|
* Reply to lastly received request message
|
|
*
|
|
* \param rcv_caps number of capabilities to accept when awaiting again
|
|
* \param await_request_msg wether the call shall await a request message
|
|
*
|
|
* \retval 0 await_request_msg == 0 or request-message receipt succeeded
|
|
* \retval -1 await_request_msg == 1 and request-message receipt failed
|
|
*
|
|
* If the call returns successful and await_request_msg == 1, the received
|
|
* message is located at the base of the callers userland thread-context.
|
|
*/
|
|
inline int send_reply_msg(unsigned rcv_caps, bool const await_request_msg)
|
|
{
|
|
return call(call_id_send_reply_msg(), rcv_caps, await_request_msg);
|
|
}
|
|
|
|
|
|
/**
|
|
* Print a char c to the kernels serial ouput
|
|
*
|
|
* If c is set to 0 the kernel prints a table of all threads and their
|
|
* current activities to the serial output.
|
|
*/
|
|
inline void print_char(char const c)
|
|
{
|
|
call(call_id_print_char(), c);
|
|
}
|
|
|
|
|
|
/**
|
|
* Await any context of a receiver and optionally ack a context before
|
|
*
|
|
* \param receiver_id capability id of the targeted signal receiver
|
|
*
|
|
* \retval 0 suceeded
|
|
* \retval -1 failed
|
|
*
|
|
* If this call returns 0, an instance of 'Signal::Data' is located at the
|
|
* base of the callers UTCB. Every occurence of a signal is provided
|
|
* through this function until it gets delivered through this function or
|
|
* context respectively receiver get destructed. If multiple threads
|
|
* listen at the same receiver, and/or multiple contexts of the receiver
|
|
* trigger simultanously, there is no assertion about wich thread
|
|
* receives, and from wich context. A context that delivered once doesn't
|
|
* deliver again unless its last delivery has been acknowledged via
|
|
* ack_signal.
|
|
*/
|
|
inline int await_signal(capid_t const receiver_id)
|
|
{
|
|
return call(call_id_await_signal(), receiver_id);
|
|
}
|
|
|
|
|
|
/**
|
|
* Trigger a specific signal context
|
|
*
|
|
* \param context capability id of the targeted signal context
|
|
* \param num how often the context shall be triggered by this call
|
|
*
|
|
* \retval 0 suceeded
|
|
* \retval -1 failed
|
|
*/
|
|
inline int submit_signal(capid_t const context, unsigned const num)
|
|
{
|
|
return call(call_id_submit_signal(), context, num);
|
|
}
|
|
|
|
|
|
/**
|
|
* Acknowledge the processing of the last delivery of a signal context
|
|
*
|
|
* \param context capability id of the targeted signal context
|
|
*/
|
|
inline void ack_signal(capid_t const context)
|
|
{
|
|
call(call_id_ack_signal(), context);
|
|
}
|
|
|
|
|
|
/**
|
|
* Halt processing of a signal context synchronously
|
|
*
|
|
* \param context capability id of the targeted signal context
|
|
*
|
|
* \retval 0 suceeded
|
|
* \retval -1 failed
|
|
*/
|
|
inline int kill_signal_context(capid_t const context)
|
|
{
|
|
return call(call_id_kill_signal_context(), context);
|
|
}
|
|
|
|
/**
|
|
* Acknowledge reception of a capability
|
|
*
|
|
* \param cap capability id to acknowledge
|
|
*/
|
|
inline void ack_cap(capid_t const cap)
|
|
{
|
|
call(call_id_ack_cap(), cap);
|
|
}
|
|
|
|
/**
|
|
* Delete a capability id
|
|
*
|
|
* \param cap capability id to delete
|
|
*/
|
|
inline void delete_cap(capid_t const cap)
|
|
{
|
|
call(call_id_delete_cap(), cap);
|
|
}
|
|
}
|
|
|
|
#endif /* _INCLUDE__KERNEL__INTERFACE_H_ */
|