genode/repos/base-foc/src/core/include/platform.h

/*
 * \brief  Fiasco.OC platform
 * \author Christian Helmuth
 * \author Norman Feske
 * \author Stefan Kalkowski
 * \date   2007-09-10
 */

/*
 * Copyright (C) 2007-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 _CORE__INCLUDE__PLATFORM_H_
#define _CORE__INCLUDE__PLATFORM_H_

/* Genode includes */
#include <base/synced_allocator.h>
#include <base/allocator_avl.h>

/* Core includes */
#include <pager.h>
#include <cap_id_alloc.h>
#include <platform_generic.h>
#include <platform_thread.h>
#include <platform_pd.h>
#include <assertion.h>

namespace Fiasco {
	struct l4_kernel_info_t;
}

namespace Genode {

	class Xml_generator;

	class Platform : public Platform_generic
	{
		private:

			/*
			 * Noncopyable
			 */
			Platform(Platform const &);
			Platform &operator = (Platform const &);

			/**
			 * Pager object representing the pager of core namely sigma0
			 */
			struct Sigma0 : public Pager_object
			{
				/**
				 * Constructor
				 */
				Sigma0(Cap_index*);

				int pager(Ipc_pager &) override { /* never called */ return -1; }
			};

			/*
			 * Shortcut for the type of allocator instances for physical resources
			 */
			typedef Synced_range_allocator<Allocator_avl> Phys_allocator;

			Platform_pd     *_core_pd = nullptr; /* core protection domain object */
			Phys_allocator   _ram_alloc;         /* RAM allocator */
			Phys_allocator   _io_mem_alloc;      /* MMIO allocator */
			Phys_allocator   _io_port_alloc;     /* I/O port allocator */
			Phys_allocator   _irq_alloc;         /* IRQ allocator */
			Phys_allocator   _region_alloc;      /* virtual memory allocator for core */
			Cap_id_allocator _cap_id_alloc;      /* capability id allocator */
			Rom_fs           _rom_fs { };        /* ROM file system */
			Rom_module       _kip_rom;           /* ROM module for Fiasco KIP */
			Sigma0           _sigma0;

			addr_t           _vm_start = 0;      /* begin of virtual memory */
			size_t           _vm_size  = 0;      /* size of virtual memory */

			/**
			 * Setup base resources
			 *
			 * - Map and provide KIP as ROM module
			 * - Initializes region allocator
			 */
			void _setup_basics();

			/**
			 * Setup RAM, IO_MEM, and region allocators
			 */
			void _setup_mem_alloc();

			/**
			 * Setup I/O port space allocator
			 */
			void _setup_io_port_alloc();

			/**
			 * Setup content of platform_info ROM
			 */
			void _setup_platform_info(Xml_generator &,
			                          Fiasco::l4_kernel_info_t &);

			/**
			 * Setup IRQ allocator
			 */
			void _setup_irq_alloc();

			/**
			 * Parse multi-boot information and update ROM database
			 */
			void _init_rom_modules();

			/**
			 * Setup pager for core-internal threads
			 */
			void _setup_core_pager();

			addr_t _rom_module_phys(addr_t virt) { return virt; }

		public:

			enum { VCPU_VIRT_EXT_START = 0x1000, VCPU_VIRT_EXT_END = 0x10000 };

			/**
			 * Core pager thread that handles core-internal page-faults
			 */
			struct Core_pager : public Platform_thread, public Pager_object
			{
				/**
				 * Constructor
				 */
				Core_pager(Platform_pd &core_pd, Sigma0 &);

				int pager(Ipc_pager &) override { /* never called */ return -1; }
			};

			/**
			 * Return singleton instance of core pager object
			 */
			Core_pager &core_pager();

			/**
			 * Set interrupt trigger/polarity (e.g., level or edge, high or low)
			 */
			static void setup_irq_mode(unsigned irq_number, unsigned trigger, 
			                           unsigned polarity);

			/**
			 * Constructor
			 */
			Platform();

			/**
			 * Accessor for core pd object
			 */
			Platform_pd &core_pd()
			{
				if (_core_pd)
					return *_core_pd;

				ASSERT_NEVER_CALLED;
			}


			/********************************
			 ** Generic platform interface **
			 ********************************/

			Range_allocator  &core_mem_alloc()       override { return _ram_alloc;     }
			Range_allocator  &ram_alloc()            override { return _ram_alloc;     }
			Range_allocator  &io_mem_alloc()         override { return _io_mem_alloc;  }
			Range_allocator  &io_port_alloc()        override { return _io_port_alloc; }
			Range_allocator  &irq_alloc()            override { return _irq_alloc;     }
			Range_allocator  &region_alloc()         override { return _region_alloc;  }
			addr_t            vm_start()       const override { return _vm_start;       }
			size_t            vm_size()        const override { return _vm_size;        }
			Rom_fs           &rom_fs()               override { return _rom_fs;        }
			Affinity::Space   affinity_space() const override;

			size_t max_caps() const override { return cap_idx_alloc().max_caps(); }

			Cap_id_allocator &cap_id_alloc() { return _cap_id_alloc; }

			void wait_for_exit() override;
	};
}

#endif /* _CORE__INCLUDE__PLATFORM_H_ */