osfmk/arm/io_map.c

   1 /*
   2  * Copyright (c) 2007 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  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System Copyright (c) 1991,1990 Carnegie Mellon University
  33  * All Rights Reserved.
  34  *
  35  * Permission to use, copy, modify and distribute this software and its
  36  * documentation is hereby granted, provided that both the copyright notice
  37  * and this permission notice appear in all copies of the software,
  38  * derivative works or modified versions, and any portions thereof, and that
  39  * both notices appear in supporting documentation.
  40  *
  41  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION.
  42  * CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR ANY DAMAGES
  43  * WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  44  *
  45  * Carnegie Mellon requests users of this software to return to
  46  *
  47  * Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  48  * School of Computer Science Carnegie Mellon University Pittsburgh PA
  49  * 15213-3890
  50  *
  51  * any improvements or extensions that they make and grant Carnegie Mellon the
  52  * rights to redistribute these changes.
  53  */
  54 /*
  55  */
  56
  57 #include <mach/vm_param.h>
  58 #include <vm/vm_kern.h>
  59 #include <vm/vm_map.h>
  60 #include <arm/pmap.h>
  61 #include <arm/io_map_entries.h>
  62 #include <san/kasan.h>
  63
  64 extern vm_offset_t      virtual_space_start;     /* Next available kernel VA */
  65
  66 /*
  67  * Allocate and map memory for devices that may need to be mapped before
  68  * Mach VM is running.
  69  */
  70 vm_offset_t
  71 io_map(vm_map_offset_t phys_addr, vm_size_t size, unsigned int flags)
  72 {
  73         return io_map_with_prot(phys_addr, size, flags, VM_PROT_READ | VM_PROT_WRITE);
  74 }
  75
  76 /*
  77  * Allocate and map memory for devices that may need to be mapped before
  78  * Mach VM is running. Allows caller to specify mapping protection
  79  */
  80 vm_offset_t
  81 io_map_with_prot(vm_map_offset_t phys_addr, vm_size_t size, unsigned int flags, vm_prot_t prot)
  82 {
  83         vm_offset_t     start, start_offset;
  84
  85         start_offset = phys_addr & PAGE_MASK;
  86         size += start_offset;
  87         phys_addr -= start_offset;
  88
  89         if (kernel_map == VM_MAP_NULL) {
  90                 /*
  91                  * VM is not initialized.  Grab memory.
  92                  */
  93                 start = virtual_space_start;
  94                 virtual_space_start += round_page(size);
  95
  96                 assert(flags == VM_WIMG_WCOMB || flags == VM_WIMG_IO);
  97
  98                 if (flags == VM_WIMG_WCOMB) {
  99                         (void) pmap_map_bd_with_options(start, phys_addr, phys_addr + round_page(size),
 100                             prot, PMAP_MAP_BD_WCOMB);
 101                 } else {
 102                         (void) pmap_map_bd(start, phys_addr, phys_addr + round_page(size),
 103                             prot);
 104                 }
 105         } else {
 106                 (void) kmem_alloc_pageable(kernel_map, &start, round_page(size), VM_KERN_MEMORY_IOKIT);
 107                 (void) pmap_map(start, phys_addr, phys_addr + round_page(size),
 108                     prot, flags);
 109         }
 110 #if KASAN
 111         kasan_notify_address(start + start_offset, size);
 112 #endif
 113         return start + start_offset;
 114 }
 115
 116 /* just wrap this since io_map handles it */
 117
 118 vm_offset_t
 119 io_map_spec(vm_map_offset_t phys_addr, vm_size_t size, unsigned int flags)
 120 {
 121         return io_map(phys_addr, size, flags);
 122 }