iokit/DriverKit/IOMemoryMap.iig

   1 /*
   2  * Copyright (c) 2019-2019 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #if !__IIG
  30 #if KERNEL
  31 #include <IOKit/IOMemoryDescriptor.h>
  32 #endif
  33 #endif
  34
  35 #ifndef _IOKIT_UIOMEMORYMAP_H
  36 #define _IOKIT_UIOMEMORYMAP_H
  37
  38 #include <DriverKit/OSObject.iig>
  39
  40 struct IOMemoryMapPrivateState {
  41         uint64_t length;
  42         uint64_t offset;
  43         uint64_t options;
  44         uint64_t address;
  45 };
  46
  47 /*!
  48  * @class IOMemoryMap
  49  *
  50  * @abstract
  51  * IOMemoryMap describes a memory mapping created with IOMemoryDescriptor::CreateMapping()
  52  *
  53  * @discussion
  54  * To allocate memory for I/O or sharing, use IOBufferMemoryDescriptor::Create()
  55  * Methods in this class are used for memory that was supplied as a parameter.
  56  */
  57
  58 class KERNEL IOMemoryMap : public OSObject
  59 {
  60 public:
  61
  62         virtual bool
  63         init() override;
  64
  65         virtual void
  66         free() override;
  67
  68     /*!
  69      * @brief       Obtain the address of the memory mapping.
  70      * @return      Address.
  71      */
  72         uint64_t
  73         GetAddress() LOCALONLY;
  74
  75     /*!
  76      * @brief       Obtain the length of the memory mapping.
  77      * @return      Length.
  78      */
  79         uint64_t
  80         GetLength() LOCALONLY;
  81
  82     /*!
  83      * @brief       Obtain the offset of the memory mapping.
  84      * @return      Offset.
  85      */
  86         uint64_t
  87         GetOffset() LOCALONLY;
  88 };
  89
  90 class EXTENDS (IOMemoryMap) IOMemoryMapPrivate
  91 {
  92         virtual kern_return_t
  93         _CopyState(
  94                 IOMemoryMapPrivateState * state);
  95 };
  96
  97 #endif /* ! _IOKIT_UIOMEMORYMAP_H */