genode/repos/os/src/drivers/gpu/intel/context_descriptor.h
Norman Feske eba9c15746 Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:

* A class with virtual functions can no longer publicly inherit base
  classed without a vtable. The inherited object may either be moved
  to a member variable, or inherited privately. The latter would be
  used for classes that inherit 'List::Element' or 'Avl_node'. In order
  to enable the 'List' and 'Avl_tree' to access the meta data, the
  'List' must become a friend.

* Instead of adding a virtual destructor to abstract base classes,
  we inherit the new 'Interface' class, which contains a virtual
  destructor. This way, single-line abstract base classes can stay
  as compact as they are now. The 'Interface' utility resides in
  base/include/util/interface.h.

* With the new warnings enabled, all member variables must be explicitly
  initialized. Basic types may be initialized with '='. All other types
  are initialized with braces '{ ... }' or as class initializers. If
  basic types and non-basic types appear in a row, it is nice to only
  use the brace syntax (also for basic types) and align the braces.

* If a class contains pointers as members, it must now also provide a
  copy constructor and assignment operator. In the most cases, one
  would make them private, effectively disallowing the objects to be
  copied. Unfortunately, this warning cannot be fixed be inheriting
  our existing 'Noncopyable' class (the compiler fails to detect that
  the inheriting class cannot be copied and still gives the error).
  For now, we have to manually add declarations for both the copy
  constructor and assignment operator as private class members. Those
  declarations should be prepended with a comment like this:

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

  In the future, we should revisit these places and try to replace
  the pointers with references. In the presence of at least one
  reference member, the compiler would no longer implicitly generate
  a copy constructor. So we could remove the manual declaration.

Issue #465
2018-01-17 12:14:35 +01:00

118 lines
2.8 KiB
C++

/*
* \brief Broadwell context descriptor
* \author Josef Soentgen
* \date 2017-03-15
*/
/*
* Copyright (C) 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 _CONTEXT_DESCRIPTOR_H_
#define _CONTEXT_DESCRIPTOR_H_
/* Genode includes */
#include <util/register.h>
/* local includes */
#include <types.h>
namespace Igd {
class Context_descriptor;
}
/*
* IHD-OS-BDW-Vol 2d-11.15 p. 107
*/
class Igd::Context_descriptor : Genode::Register<64>
{
public:
/*
* Context ID covers 63:32 where we currently only
* care about the lowest 20 bits.
*
* 63:55 group ID
* 54 MBZ
* 53 MBZ
* 20:0 globally unique SW controlled ID
*/
struct Context_id : Bitfield<32, 20> { };
struct Logical_ring_context_address : Bitfield<12, 20> { };
struct Privilege_access : Bitfield< 8, 1> { };
struct Fault_handling : Bitfield< 6, 2>
{
enum { FAULT_AND_HANG = 0b00, };
};
struct Addressing_mode : Bitfield< 3, 2>
{
enum {
ADVANCED_WO_AD = 0b00,
LEGACY_WO_64 = 0b01,
ADVANCED_WITH_AD = 0b10,
LEGACY_WITH_64 = 0b11,
};
};
struct Force_restore : Bitfield< 2, 1> { };
struct Force_pd_restore : Bitfield< 1, 1> { };
struct Valid : Bitfield< 0, 1> { };
private:
uint64_t _value = 0;
public:
/**
* Constructor
*
* \param id context id
* \param lrca graphics memory address of the context
*/
Context_descriptor(uint32_t id,
addr_t lrca)
{
/* shift lrca value accordingly */
typename Context_descriptor::access_t const addr = Context_descriptor::Logical_ring_context_address::get(lrca);
Logical_ring_context_address::set(_value, addr);
Privilege_access::set(_value, 1);
/* must be set to FAULT_AND_HANG according to PRM when legacy mode is used */
Fault_handling::set(_value, Fault_handling::FAULT_AND_HANG);
Addressing_mode::set(_value, Addressing_mode::LEGACY_WITH_64);
Context_id::set(_value, id);
Force_restore::set(_value, 1);
Force_pd_restore::set(_value, 1);
Valid::set(_value, 1);
}
/**
* Constructor
*/
Context_descriptor() : _value(0) { }
uint32_t low() const { return (uint32_t)(_value & 0xffffffff); }
uint32_t high() const { return (uint32_t)(_value >> 32); }
bool valid() const { return Valid::get(_value) == 1; }
uint64_t value() const { return _value; }
/*********************
** Debug interface **
*********************/
void dump()
{
using namespace Genode;
log("Context_descriptor: ", Hex(_value, Hex::PREFIX, Hex::PAD));
}
};
#endif /* _CONTEXT_DESCRIPTOR_H_ */