1 // Copyright 2018 The Fuchsia Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #pragma once
6 
7 #include <ddk/io-buffer.h>
8 #include <ddk/mmio-buffer.h>
9 #include <ddk/protocol/platform/device.h>
10 #include <zircon/compiler.h>
11 #include <zircon/types.h>
12 
13 __BEGIN_CDECLS;
14 
15 
pdev_map_mmio2(const pdev_protocol_t * pdev,uint32_t index,uint32_t cache_policy,void ** out_vaddr,size_t * out_size,zx_paddr_t * out_paddr,zx_handle_t * out_handle)16 static inline zx_status_t pdev_map_mmio2(const pdev_protocol_t* pdev, uint32_t index,
17                                         uint32_t cache_policy, void** out_vaddr, size_t* out_size,
18                                         zx_paddr_t* out_paddr, zx_handle_t* out_handle) {
19     return pdev->ops->map_mmio(pdev->ctx, index, cache_policy, out_vaddr, out_size, out_paddr,
20                                out_handle);
21 }
22 
23 // Returns an interrupt handle. "index" is relative to the list of IRQs for the device.
pdev_map_interrupt(const pdev_protocol_t * pdev,uint32_t index,zx_handle_t * out_handle)24 static inline zx_status_t pdev_map_interrupt(const pdev_protocol_t* pdev, uint32_t index,
25                                              zx_handle_t* out_handle) {
26     return pdev->ops->get_interrupt(pdev->ctx, index, 0, out_handle);
27 }
28 
29 // MMIO mapping helper.
pdev_map_mmio_buffer(const pdev_protocol_t * pdev,uint32_t index,uint32_t cache_policy,io_buffer_t * buffer)30 static inline zx_status_t pdev_map_mmio_buffer(const pdev_protocol_t* pdev,
31                                                uint32_t index, uint32_t cache_policy,
32                                                io_buffer_t* buffer) {
33     void* vaddr;
34     size_t size;
35     zx_paddr_t paddr;
36     zx_handle_t vmo_handle;
37 
38     zx_status_t status = pdev_map_mmio2(pdev, index, cache_policy, &vaddr, &size, &paddr,
39                                         &vmo_handle);
40     if (status != ZX_OK) {
41         return status;
42     }
43     zx_off_t offset = (uintptr_t)vaddr & (PAGE_SIZE - 1);
44     vaddr = (void *)((uintptr_t)vaddr - offset);
45     status = io_buffer_init_mmio(buffer, vmo_handle, vaddr, offset, size);
46     if (status == ZX_OK) {
47         buffer->phys = paddr;
48     }
49     zx_handle_close(vmo_handle);
50     return status;
51 }
52 
pdev_map_mmio_buffer2(const pdev_protocol_t * pdev,uint32_t index,uint32_t cache_policy,mmio_buffer_t * buffer)53 static inline zx_status_t pdev_map_mmio_buffer2(const pdev_protocol_t* pdev,
54                                                uint32_t index, uint32_t cache_policy,
55                                                mmio_buffer_t* buffer) {
56     pdev_mmio_t mmio;
57 
58     zx_status_t status = pdev_get_mmio(pdev, index, &mmio);
59     if (status != ZX_OK) {
60         return status;
61     }
62     return mmio_buffer_init(buffer, mmio.offset, mmio.size, mmio.vmo, cache_policy);
63 }
64 
65 __END_CDECLS;
66