/*
 * \brief  Memory-mapped I/O session interface
 * \author Christian Helmuth
 * \date   2006-08-01
 */

/*
 * Copyright (C) 2006-2017 Genode Labs GmbH
 *
 * This file is part of the Genode OS framework, which is distributed
 * under the terms of the GNU Affero General Public License version 3.
 */

#ifndef _INCLUDE__IO_MEM_SESSION__IO_MEM_SESSION_H_
#define _INCLUDE__IO_MEM_SESSION__IO_MEM_SESSION_H_

#include <dataspace/capability.h>
#include <session/session.h>

namespace Genode {

	struct Io_mem_dataspace;
	struct Io_mem_session;

	typedef Capability<Io_mem_dataspace> Io_mem_dataspace_capability;
}


struct Genode::Io_mem_dataspace : Dataspace { };


struct Genode::Io_mem_session : Session
{
	/**
	 * \noapi
	 */
	static const char *service_name() { return "IO_MEM"; }

	/*
	 * An I/O-memory session consumes a dataspace capability for the
	 * session-object allocation, its session capability, and a dataspace
	 * capability for the handed-out memory-mapped I/O dataspace.
	 */
	enum { CAP_QUOTA = 3 };

	virtual ~Io_mem_session() { }

	/**
	 * Request dataspace containing the IO_MEM session data
	 *
	 * \return  capability to IO_MEM dataspace
	 *          (may be invalid)
	 */
	virtual Io_mem_dataspace_capability dataspace() = 0;


	/*********************
	 ** RPC declaration **
	 *********************/

	GENODE_RPC(Rpc_dataspace, Io_mem_dataspace_capability, dataspace);
	GENODE_RPC_INTERFACE(Rpc_dataspace);
};

#endif /* _INCLUDE__IO_MEM_SESSION__IO_MEM_SESSION_H_ */
