.. SPDX-License-Identifier: (MIT OR GPL-2.0-or-later)
..
   Copyright (C) 2022 Jeff Webb <jeff.webb@codecraftsmen.org>
   
   This software and the associated documentation files are dual-licensed and
   are made available under the terms of the MIT License or under the terms
   of the GNU General Public License as published by the Free Software
   Foundation; either version 2 of the License, or (at your option) any later
   version.  You may select (at your option) either of the licenses listed
   above.  See the LICENSE.MIT and LICENSE.GPL-2.0 files in the top-level
   directory of this distribution for copyright information and license
   terms.
   
.. highlight:: C++

=============
Memory Region
=============

**C++ memory region declarations.**

Memory regions are commonly used to expose device registers to user-space
applications for reading and writing.  The following entities are defined in
the ``cuddl`` namespace.

.. doxygenenum:: cuddl::MemRegionFlag

.. doxygentypedef:: cuddl::MemRegionFlags

.. doxygenenum:: cuddl::MemRegionClaimFlag

.. doxygentypedef:: cuddl::MemRegionClaimFlags

.. doxygenenum:: cuddl::MemRegionMapFlag

.. doxygentypedef:: cuddl::MemRegionMapFlags

.. doxygenclass:: cuddl::MemRegionInfo
   :undoc-members:
   :members:

.. doxygenclass:: cuddl::MemRegion
   :undoc-members:
   :members: