1256694Snp/*- 2309378Sjhb * SPDX-License-Identifier: BSD-2-Clause 3256694Snp * 4256694Snp * Copyright (c) 2019 Andrew Turner 5256694Snp * Copyright (c) 2021 The FreeBSD Foundation 6256694Snp * 7256694Snp * This software was developed by SRI International and the University of 8256694Snp * Cambridge Computer Laboratory (Department of Computer Science and 9256694Snp * Technology) under DARPA contract HR0011-18-C-0016 ("ECATS"), as part of the 10256694Snp * DARPA SSITH research programme. 11256694Snp * 12256694Snp * Portions of this software were written by Mark Johnston under sponsorship by 13256694Snp * the FreeBSD Foundation. 14256694Snp * 15256694Snp * Redistribution and use in source and binary forms, with or without 16256694Snp * modification, are permitted provided that the following conditions 17256694Snp * are met: 18256694Snp * 1. Redistributions of source code must retain the above copyright 19256694Snp * notice, this list of conditions and the following disclaimer. 20256694Snp * 2. Redistributions in binary form must reproduce the above copyright 21256694Snp * notice, this list of conditions and the following disclaimer in the 22256694Snp * documentation and/or other materials provided with the distribution. 23256694Snp * 24256694Snp * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 25256694Snp * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26256694Snp * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27256694Snp * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 28256694Snp * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29256694Snp * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30256694Snp * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31256694Snp * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32256694Snp * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33256694Snp * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34256694Snp * SUCH DAMAGE. 35256694Snp */ 36256694Snp 37256694Snp#ifndef _SYS_BUS_SAN_H_ 38256694Snp#define _SYS_BUS_SAN_H_ 39256694Snp 40256694Snp#ifndef _MACHINE_BUS_H_ 41256694Snp#error do not include this header, use machine/bus.h 42256694Snp#endif 43256694Snp 44256694Snp#define BUS_SAN_MULTI(sp, rw, width, type) \ 45256694Snp void sp##_bus_space_##rw##_multi_##width(bus_space_tag_t, \ 46256694Snp bus_space_handle_t, bus_size_t, type *, bus_size_t); \ 47256694Snp void sp##_bus_space_##rw##_multi_stream_##width(bus_space_tag_t, \ 48309378Sjhb bus_space_handle_t, bus_size_t, type *, bus_size_t); \ 49256694Snp void sp##_bus_space_##rw##_region_##width(bus_space_tag_t, \ 50256694Snp bus_space_handle_t, bus_size_t, type *, bus_size_t); \ 51256694Snp void sp##_bus_space_##rw##_region_stream_##width(bus_space_tag_t, \ 52256694Snp bus_space_handle_t, bus_size_t, type *, bus_size_t) 53256694Snp 54256694Snp#define BUS_SAN_READ(sp, width, type) \ 55256694Snp type sp##_bus_space_read_##width(bus_space_tag_t, \ 56256694Snp bus_space_handle_t, bus_size_t); \ 57256694Snp type sp##_bus_space_read_stream_##width(bus_space_tag_t, \ 58256694Snp bus_space_handle_t, bus_size_t); \ 59256694Snp BUS_SAN_MULTI(sp, read, width, type) 60256694Snp 61256694Snp#define BUS_SAN_WRITE(sp, width, type) \ 62256694Snp void sp##_bus_space_write_##width(bus_space_tag_t, \ 63256694Snp bus_space_handle_t, bus_size_t, type); \ 64256694Snp void sp##_bus_space_write_stream_##width(bus_space_tag_t, \ 65256694Snp bus_space_handle_t, bus_size_t, type); \ 66256694Snp BUS_SAN_MULTI(sp, write, width, const type) 67256694Snp 68256694Snp#define BUS_SAN_SET(sp, width, type) \ 69256694Snp void sp##_bus_space_set_multi_##width(bus_space_tag_t, \ 70256694Snp bus_space_handle_t, bus_size_t, type, bus_size_t); \ 71256694Snp void sp##_bus_space_set_multi_stream_##width(bus_space_tag_t, \ 72256694Snp bus_space_handle_t, bus_size_t, type, bus_size_t); \ 73256694Snp void sp##_bus_space_set_region_##width(bus_space_tag_t, \ 74256694Snp bus_space_handle_t, bus_size_t, type, bus_size_t); \ 75256694Snp void sp##_bus_space_set_region_stream_##width(bus_space_tag_t, \ 76256694Snp bus_space_handle_t, bus_size_t, type, bus_size_t) 77256694Snp 78256694Snp#define BUS_SAN_COPY(sp, width, type) \ 79256694Snp void sp##_bus_space_copy_region_##width(bus_space_tag_t, \ 80256694Snp bus_space_handle_t, bus_size_t, bus_space_handle_t, \ 81256694Snp bus_size_t, bus_size_t); \ 82256694Snp void sp##_bus_space_copy_region_stream_##width(bus_space_tag_t, \ 83256694Snp bus_space_handle_t, bus_size_t, bus_space_handle_t, \ 84256694Snp bus_size_t, bus_size_t); 85256694Snp 86256694Snp#define BUS_SAN_PEEK(sp, width, type) \ 87256694Snp int sp##_bus_space_peek_##width(bus_space_tag_t, \ 88256694Snp bus_space_handle_t, bus_size_t, type *); 89256694Snp 90256694Snp#define BUS_SAN_POKE(sp, width, type) \ 91256694Snp int sp##_bus_space_poke_##width(bus_space_tag_t, \ 92256694Snp bus_space_handle_t, bus_size_t, type); 93256694Snp 94256694Snp#define _BUS_SAN_MISC(sp) \ 95256694Snp int sp##_bus_space_map(bus_space_tag_t, bus_addr_t, bus_size_t, \ 96256694Snp int, bus_space_handle_t *); \ 97256694Snp void sp##_bus_space_unmap(bus_space_tag_t, bus_space_handle_t, \ 98256694Snp bus_size_t); \ 99256694Snp int sp##_bus_space_subregion(bus_space_tag_t, bus_space_handle_t,\ 100256694Snp bus_size_t, bus_size_t, bus_space_handle_t *); \ 101256694Snp int sp##_bus_space_alloc(bus_space_tag_t, bus_addr_t, bus_addr_t,\ 102256694Snp bus_size_t, bus_size_t, bus_size_t, int, bus_addr_t *, \ 103256694Snp bus_space_handle_t *); \ 104256694Snp void sp##_bus_space_free(bus_space_tag_t, bus_space_handle_t, \ 105256694Snp bus_size_t); \ 106256694Snp void sp##_bus_space_barrier(bus_space_tag_t, bus_space_handle_t,\ 107256694Snp bus_size_t, bus_size_t, int); 108256694Snp 109256694Snp#define BUS_SAN_MISC(sp) \ 110256694Snp _BUS_SAN_MISC(sp) 111256694Snp 112256694Snp#define _BUS_SAN_FUNCS(sp, width, type) \ 113256694Snp BUS_SAN_READ(sp, width, type); \ 114256694Snp BUS_SAN_WRITE(sp, width, type); \ 115256694Snp BUS_SAN_SET(sp, width, type); \ 116256694Snp BUS_SAN_COPY(sp, width, type) \ 117256694Snp BUS_SAN_PEEK(sp, width, type); \ 118256694Snp BUS_SAN_POKE(sp, width, type) 119256694Snp 120256694Snp#define BUS_SAN_FUNCS(width, type) \ 121256694Snp _BUS_SAN_FUNCS(SAN_INTERCEPTOR_PREFIX, width, type) 122256694Snp 123256694SnpBUS_SAN_FUNCS(1, uint8_t); 124256694SnpBUS_SAN_FUNCS(2, uint16_t); 125256694SnpBUS_SAN_FUNCS(4, uint32_t); 126256694SnpBUS_SAN_FUNCS(8, uint64_t); 127256694SnpBUS_SAN_MISC(SAN_INTERCEPTOR_PREFIX); 128256694Snp 129256694Snp#ifndef SAN_RUNTIME 130256694Snp 131256694Snp#define BUS_SAN(func) \ 132256694Snp __CONCAT(SAN_INTERCEPTOR_PREFIX, __CONCAT(_bus_space_, func)) 133256694Snp 134256694Snp#define bus_space_map BUS_SAN(map) 135256694Snp#define bus_space_unmap BUS_SAN(unmap) 136256694Snp#define bus_space_subregion BUS_SAN(subregion) 137256694Snp#define bus_space_alloc BUS_SAN(alloc) 138256694Snp#define bus_space_free BUS_SAN(free) 139256694Snp#define bus_space_barrier BUS_SAN(barrier) 140256694Snp 141256694Snp#define bus_space_read_1 BUS_SAN(read_1) 142256694Snp#define bus_space_read_stream_1 BUS_SAN(read_stream_1) 143256694Snp#define bus_space_read_multi_1 BUS_SAN(read_multi_1) 144309378Sjhb#define bus_space_read_multi_stream_1 BUS_SAN(read_multi_stream_1) 145309378Sjhb#define bus_space_read_region_1 BUS_SAN(read_region_1) 146256694Snp#define bus_space_read_region_stream_1 BUS_SAN(read_region_stream_1) 147256694Snp#define bus_space_write_1 BUS_SAN(write_1) 148256694Snp#define bus_space_write_stream_1 BUS_SAN(write_stream_1) 149256694Snp#define bus_space_write_multi_1 BUS_SAN(write_multi_1) 150256694Snp#define bus_space_write_multi_stream_1 BUS_SAN(write_multi_stream_1) 151256694Snp#define bus_space_write_region_1 BUS_SAN(write_region_1) 152256694Snp#define bus_space_write_region_stream_1 BUS_SAN(write_region_stream_1) 153256694Snp#define bus_space_set_multi_1 BUS_SAN(set_multi_1) 154256694Snp#define bus_space_set_multi_stream_1 BUS_SAN(set_multi_stream_1) 155256694Snp#define bus_space_set_region_1 BUS_SAN(set_region_1) 156256694Snp#define bus_space_set_region_stream_1 BUS_SAN(set_region_stream_1) 157309378Sjhb#define bus_space_copy_multi_1 BUS_SAN(copy_multi_1) 158256694Snp#define bus_space_copy_multi_stream_1 BUS_SAN(copy_multi_stream_1) 159256694Snp#define bus_space_poke_1 BUS_SAN(poke_1) 160318799Snp#define bus_space_peek_1 BUS_SAN(peek_1) 161256694Snp 162256694Snp#define bus_space_read_2 BUS_SAN(read_2) 163256694Snp#define bus_space_read_stream_2 BUS_SAN(read_stream_2) 164318799Snp#define bus_space_read_multi_2 BUS_SAN(read_multi_2) 165256694Snp#define bus_space_read_multi_stream_2 BUS_SAN(read_multi_stream_2) 166256694Snp#define bus_space_read_region_2 BUS_SAN(read_region_2) 167256694Snp#define bus_space_read_region_stream_2 BUS_SAN(read_region_stream_2) 168256694Snp#define bus_space_write_2 BUS_SAN(write_2) 169256694Snp#define bus_space_write_stream_2 BUS_SAN(write_stream_2) 170318799Snp#define bus_space_write_multi_2 BUS_SAN(write_multi_2) 171256694Snp#define bus_space_write_multi_stream_2 BUS_SAN(write_multi_stream_2) 172256694Snp#define bus_space_write_region_2 BUS_SAN(write_region_2) 173256694Snp#define bus_space_write_region_stream_2 BUS_SAN(write_region_stream_2) 174256694Snp#define bus_space_set_multi_2 BUS_SAN(set_multi_2) 175256694Snp#define bus_space_set_multi_stream_2 BUS_SAN(set_multi_stream_2) 176318799Snp#define bus_space_set_region_2 BUS_SAN(set_region_2) 177256694Snp#define bus_space_set_region_stream_2 BUS_SAN(set_region_stream_2) 178256694Snp#define bus_space_copy_multi_2 BUS_SAN(copy_multi_2) 179256694Snp#define bus_space_copy_multi_stream_2 BUS_SAN(copy_multi_stream_2) 180256694Snp#define bus_space_poke_2 BUS_SAN(poke_2) 181318799Snp#define bus_space_peek_2 BUS_SAN(peek_2) 182256694Snp 183256694Snp#define bus_space_read_4 BUS_SAN(read_4) 184256694Snp#define bus_space_read_stream_4 BUS_SAN(read_stream_4) 185318799Snp#define bus_space_read_multi_4 BUS_SAN(read_multi_4) 186318799Snp#define bus_space_read_multi_stream_4 BUS_SAN(read_multi_stream_4) 187318799Snp#define bus_space_read_region_4 BUS_SAN(read_region_4) 188256694Snp#define bus_space_read_region_stream_4 BUS_SAN(read_region_stream_4) 189318799Snp#define bus_space_write_4 BUS_SAN(write_4) 190318799Snp#define bus_space_write_stream_4 BUS_SAN(write_stream_4) 191318799Snp#define bus_space_write_multi_4 BUS_SAN(write_multi_4) 192318799Snp#define bus_space_write_multi_stream_4 BUS_SAN(write_multi_stream_4) 193318799Snp#define bus_space_write_region_4 BUS_SAN(write_region_4) 194318799Snp#define bus_space_write_region_stream_4 BUS_SAN(write_region_stream_4) 195318799Snp#define bus_space_set_multi_4 BUS_SAN(set_multi_4) 196318799Snp#define bus_space_set_multi_stream_4 BUS_SAN(set_multi_stream_4) 197318799Snp#define bus_space_set_region_4 BUS_SAN(set_region_4) 198318799Snp#define bus_space_set_region_stream_4 BUS_SAN(set_region_stream_4) 199318799Snp#define bus_space_copy_multi_4 BUS_SAN(copy_multi_4) 200318799Snp#define bus_space_copy_multi_stream_4 BUS_SAN(copy_multi_stream_4) 201318799Snp#define bus_space_poke_4 BUS_SAN(poke_4) 202318799Snp#define bus_space_peek_4 BUS_SAN(peek_4) 203318799Snp 204318799Snp#define bus_space_read_8 BUS_SAN(read_8) 205318799Snp#define bus_space_read_stream_8 BUS_SAN(read_stream_8) 206318799Snp#define bus_space_read_multi_8 BUS_SAN(read_multi_8) 207318799Snp#define bus_space_read_multi_stream_8 BUS_SAN(read_multi_stream_8) 208318799Snp#define bus_space_read_region_8 BUS_SAN(read_region_8) 209318799Snp#define bus_space_read_region_stream_8 BUS_SAN(read_region_stream_8) 210318799Snp#define bus_space_write_8 BUS_SAN(write_8) 211318799Snp#define bus_space_write_stream_8 BUS_SAN(write_stream_8) 212318799Snp#define bus_space_write_multi_8 BUS_SAN(write_multi_8) 213318799Snp#define bus_space_write_multi_stream_8 BUS_SAN(write_multi_stream_8) 214318799Snp#define bus_space_write_region_8 BUS_SAN(write_region_8) 215318799Snp#define bus_space_write_region_stream_8 BUS_SAN(write_region_stream_8) 216318799Snp#define bus_space_set_multi_8 BUS_SAN(set_multi_8) 217318799Snp#define bus_space_set_multi_stream_8 BUS_SAN(set_multi_stream_8) 218318799Snp#define bus_space_set_region_8 BUS_SAN(set_region_8) 219318799Snp#define bus_space_set_region_stream_8 BUS_SAN(set_region_stream_8) 220318799Snp#define bus_space_copy_multi_8 BUS_SAN(copy_multi_8) 221256694Snp#define bus_space_copy_multi_stream_8 BUS_SAN(copy_multi_stream_8) 222318799Snp#define bus_space_poke_8 BUS_SAN(poke_8) 223318799Snp#define bus_space_peek_8 BUS_SAN(peek_8) 224256694Snp 225256694Snp#endif /* !SAN_RUNTIME */ 226256694Snp 227256694Snp#endif /* !_SYS_BUS_SAN_H_ */ 228256694Snp