1 /*        $NetBSD: iommuvar.h,v 1.26 2023/12/01 06:47:59 thorpej Exp $          */
2 
3 /*
4  * Copyright (c) 1999 Matthew R. Green
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _SPARC64_DEV_IOMMUVAR_H_
30 #define _SPARC64_DEV_IOMMUVAR_H_
31 
32 #include <sys/vmem.h>
33 
34 /*
35  * Streaming buffer control
36  *
37  * It's easy to deal w/sysio since it has a single streaming buffer, and
38  * flushes are done on 8-byte boundaries.  But psycho is a pain since it
39  * has two streaming buffers and the streaming buffer flush dumps 64 bytes
40  * of data.
41  */
42 struct strbuf_ctl {
43           struct iommu_state  *sb_is;             /* Pointer to our iommu */
44           bus_space_handle_t  sb_sb;              /* Handle for our regs */
45           paddr_t                       sb_flushpa;         /* to flush streaming buffers */
46           volatile int64_t    *sb_flush;
47 };
48 
49 /*
50  * per-IOMMU state
51  */
52 struct iommu_state {
53           paddr_t                       is_ptsb;  /* TSB physical address */
54           int64_t                       *is_tsb;  /* TSB virtual address */
55           int                           is_tsbsize;         /* 0 = 8K, ... */
56           u_int                         is_dvmabase;
57           u_int                         is_dvmaend;
58           int64_t                       is_cr;              /* IOMMU control register value */
59           vmem_t                        *is_dvmamap;        /* DVMA map for this instance */
60           int                           is_flags;
61 #define IOMMU_FLUSH_CACHE     0x00000001
62 #define IOMMU_TSBSIZE_IN_PTSB 0x00000002          /* PCIe */
63 #define IOMMU_SYNC_BEFORE_UNMAP         0x00000004
64 
65           struct strbuf_ctl   *is_sb[2];          /* Streaming buffers if any */
66 
67           /* copies of our parents state, to allow us to be self contained */
68           bus_space_tag_t               is_bustag;          /* our bus tag */
69           bus_space_handle_t  is_iommu; /* IOMMU registers */
70           uint64_t            is_devhandle;   /* for sun4v hypervisor calls */
71 };
72 
73 /* interfaces for PCI/SBUS code */
74 void      iommu_init(char *, struct iommu_state *, int, uint32_t);
75 void      iommu_reset(struct iommu_state *);
76 paddr_t iommu_extract(struct iommu_state *, vaddr_t);
77 
78 int       iommu_dvmamap_load(bus_dma_tag_t, bus_dmamap_t, void *, bus_size_t,
79                     struct proc *, int);
80 void      iommu_dvmamap_unload(bus_dma_tag_t, bus_dmamap_t);
81 int       iommu_dvmamap_load_raw(bus_dma_tag_t, bus_dmamap_t,
82                     bus_dma_segment_t *, int, bus_size_t, int);
83 void      iommu_dvmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t, bus_size_t,
84                     int);
85 int       iommu_dvmamem_alloc(bus_dma_tag_t, bus_size_t, bus_size_t, bus_size_t,
86                     bus_dma_segment_t *, int, int *, int);
87 void      iommu_dvmamem_free(bus_dma_tag_t, bus_dma_segment_t *, int);
88 int       iommu_dvmamem_map(bus_dma_tag_t, bus_dma_segment_t *, int, size_t,
89                     void **, int);
90 void      iommu_dvmamem_unmap(bus_dma_tag_t, void *, size_t);
91 
92 #endif /* _SPARC64_DEV_IOMMUVAR_H_ */
93