genode/repos/os/include/spec/x86/platform_session/platform_session.h

110 lines
2.9 KiB
C++

/*
* \brief Platform session interface
* \author Norman Feske
* \date 2008-01-28
*/
/*
* Copyright (C) 2008-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.
*/
#pragma once
/* base */
#include <session/session.h>
#include <ram_session/ram_session.h>
/* os */
#include <platform_device/platform_device.h>
#include <platform_device/capability.h>
namespace Platform { struct Session; }
struct Platform::Session : Genode::Session
{
/*********************
** Exception types **
*********************/
class Fatal : public Genode::Out_of_ram { };
/**
* \noapi
*/
static const char *service_name() { return "Platform"; }
enum { CAP_QUOTA = 2 };
virtual ~Session() { }
/**
* Find first accessible device
*/
virtual Device_capability first_device(unsigned, unsigned) = 0;
/**
* Find next accessible device
*
* \param prev_device previous device
*
* The 'prev_device' argument is used to iterate through all
* devices.
*/
virtual Device_capability next_device(Device_capability prev_device,
unsigned, unsigned) = 0;
/**
* Free server-internal data structures representing the device
*
* Use this method to relax the heap partition of your PCI session.
*/
virtual void release_device(Device_capability device) = 0;
typedef Genode::Rpc_in_buffer<8> String;
/**
* Provide non-PCI device known by unique name.
*/
virtual Device_capability device(String const &string) = 0;
/**
* Allocate memory suitable for DMA.
*/
virtual Genode::Ram_dataspace_capability alloc_dma_buffer(Genode::size_t) = 0;
/**
* Free previously allocated DMA memory
*/
virtual void free_dma_buffer(Genode::Ram_dataspace_capability) = 0;
/*********************
** RPC declaration **
*********************/
GENODE_RPC_THROW(Rpc_first_device, Device_capability, first_device,
GENODE_TYPE_LIST(Out_of_ram, Out_of_caps),
unsigned, unsigned);
GENODE_RPC_THROW(Rpc_next_device, Device_capability, next_device,
GENODE_TYPE_LIST(Out_of_ram, Out_of_caps),
Device_capability, unsigned, unsigned);
GENODE_RPC(Rpc_release_device, void, release_device, Device_capability);
GENODE_RPC_THROW(Rpc_alloc_dma_buffer, Genode::Ram_dataspace_capability,
alloc_dma_buffer,
GENODE_TYPE_LIST(Out_of_ram, Out_of_caps, Fatal),
Genode::size_t);
GENODE_RPC(Rpc_free_dma_buffer, void, free_dma_buffer,
Genode::Ram_dataspace_capability);
GENODE_RPC_THROW(Rpc_device, Device_capability, device,
GENODE_TYPE_LIST(Out_of_ram, Out_of_caps),
String const &);
GENODE_RPC_INTERFACE(Rpc_first_device, Rpc_next_device,
Rpc_release_device, Rpc_alloc_dma_buffer,
Rpc_free_dma_buffer, Rpc_device);
};