mirror of
https://github.com/genodelabs/genode.git
synced 2024-12-22 15:02:25 +00:00
1336b0a751
The classes Genode::Mmio, Genode::Register_set, Genode::Attached_mmio, and Platform::Device::Mmio now receive a template parameter 'size_t SIZE'. In each type that derives from one of these classes, it is now statically checked that the range of each Genode::Register::Register- and Genode::Register_set::Register_array-deriving sub-type is within [0..SIZE). That said, SIZE is the minimum size of the memory region provided to the above mentioned Mmio classes in order to avoid page faults or memory corruption when accessing the registers and register arrays declared inside. Note, that the range end of a register array is not the end of the last item but the end of integer access that is used for accessing the last bit in the last item. The constructors of Genode::Mmio, Genode::Attached_mmio, and Platform::Device::Mmio now receive an argument 'Byte_range_ptr range' that is expected to be the range of the backing memory region. In each type that derives from on of these classes, it is now dynamically checked that 'range.num_bytes >= SIZE', thereby implementing the above mention protection against page faults and memory corruption. The rest of the commit adapts the code throughout the Genode Labs repositories regarding the changes. Note that for that code inside Core, the commits mostly uses a simplified approach by constructing MMIO objects with range [base..base+SIZE) and not with a mapping- or specification-related range size. This should be fixed in the future. Furthermore, there are types that derive from an MMIO class but don't declare any registers or register arrays (especially with Platform::Device::Mmio). In this case SIZE is set to 0. This way, the parameters must be actively corrected by someone who later wants to add registers or register arrays, plus the places can be easily found by grep'ing for Mmio<0>. Fix #4081
107 lines
2.3 KiB
C++
107 lines
2.3 KiB
C++
/*
|
|
* \brief Type-safe, fine-grained access to a continuous MMIO region
|
|
* \author Martin stein
|
|
* \date 2011-10-26
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2011-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__UTIL__MMIO_H_
|
|
#define _INCLUDE__UTIL__MMIO_H_
|
|
|
|
/* Genode includes */
|
|
#include <base/log.h>
|
|
#include <util/string.h>
|
|
#include <util/register_set.h>
|
|
|
|
namespace Genode {
|
|
|
|
class Mmio_plain_access;
|
|
template <size_t> class Mmio;
|
|
}
|
|
|
|
/**
|
|
* Plain access implementation for MMIO
|
|
*/
|
|
class Genode::Mmio_plain_access
|
|
{
|
|
friend Register_set_plain_access;
|
|
|
|
private:
|
|
|
|
Byte_range_ptr const _range;
|
|
|
|
/**
|
|
* Write 'ACCESS_T' typed 'value' to MMIO base + 'offset'
|
|
*/
|
|
template <typename ACCESS_T>
|
|
inline void _write(off_t const offset, ACCESS_T const value)
|
|
{
|
|
*(ACCESS_T volatile *)(_range.start + offset) = value;
|
|
}
|
|
|
|
/**
|
|
* Read 'ACCESS_T' typed from MMIO base + 'offset'
|
|
*/
|
|
template <typename ACCESS_T>
|
|
inline ACCESS_T _read(off_t const &offset) const
|
|
{
|
|
return *(ACCESS_T volatile *)(_range.start + offset);
|
|
}
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param base base address of targeted MMIO region
|
|
*/
|
|
Mmio_plain_access(Byte_range_ptr const &range) : _range(range.start, range.num_bytes) { }
|
|
|
|
Byte_range_ptr range_at(off_t offset) const
|
|
{
|
|
return {_range.start + offset, _range.num_bytes - offset};
|
|
}
|
|
|
|
Byte_range_ptr range() const { return range_at(0); }
|
|
|
|
addr_t base() const { return (addr_t)range().start; }
|
|
};
|
|
|
|
|
|
/**
|
|
* Type-safe, fine-grained access to a continuous MMIO region
|
|
*
|
|
* For further details refer to the documentation of the 'Register_set' class.
|
|
*/
|
|
template <Genode::size_t MMIO_SIZE>
|
|
struct Genode::Mmio : Mmio_plain_access, Register_set<Mmio_plain_access, MMIO_SIZE>
|
|
{
|
|
static constexpr size_t SIZE = MMIO_SIZE;
|
|
|
|
class Range_violation : Exception { };
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param range byte range of targeted MMIO region
|
|
*/
|
|
Mmio(Byte_range_ptr const &range)
|
|
:
|
|
Mmio_plain_access(range),
|
|
Register_set<Mmio_plain_access, SIZE>(*static_cast<Mmio_plain_access *>(this))
|
|
{
|
|
if (range.num_bytes < SIZE) {
|
|
error("MMIO range is unexpectedly too small");
|
|
throw Range_violation { };
|
|
}
|
|
}
|
|
};
|
|
|
|
#endif /* _INCLUDE__UTIL__MMIO_H_ */
|