1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 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 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef __IOAT_INTERNAL_H__ 35 #define __IOAT_INTERNAL_H__ 36 37 #include "spdk/stdinc.h" 38 39 #include "spdk/ioat.h" 40 #include "spdk/ioat_spec.h" 41 #include "spdk/queue.h" 42 #include "spdk/mmio.h" 43 44 /* Allocate 1 << 15 (32K) descriptors per channel by default. */ 45 #define IOAT_DEFAULT_ORDER 15 46 47 struct ioat_descriptor { 48 uint64_t phys_addr; 49 spdk_ioat_req_cb callback_fn; 50 void *callback_arg; 51 }; 52 53 /* One of these per allocated PCI device. */ 54 struct spdk_ioat_chan { 55 /* Opaque handle to upper layer */ 56 struct spdk_pci_device *device; 57 uint64_t max_xfer_size; 58 volatile struct spdk_ioat_registers *regs; 59 60 volatile uint64_t *comp_update; 61 62 uint32_t head; 63 uint32_t tail; 64 65 uint32_t ring_size_order; 66 uint64_t last_seen; 67 68 struct ioat_descriptor *ring; 69 union spdk_ioat_hw_desc *hw_ring; 70 uint32_t dma_capabilities; 71 72 /* tailq entry for attached_chans */ 73 TAILQ_ENTRY(spdk_ioat_chan) tailq; 74 }; 75 76 static inline uint32_t 77 is_ioat_active(uint64_t status) 78 { 79 return (status & SPDK_IOAT_CHANSTS_STATUS) == SPDK_IOAT_CHANSTS_ACTIVE; 80 } 81 82 static inline uint32_t 83 is_ioat_idle(uint64_t status) 84 { 85 return (status & SPDK_IOAT_CHANSTS_STATUS) == SPDK_IOAT_CHANSTS_IDLE; 86 } 87 88 static inline uint32_t 89 is_ioat_halted(uint64_t status) 90 { 91 return (status & SPDK_IOAT_CHANSTS_STATUS) == SPDK_IOAT_CHANSTS_HALTED; 92 } 93 94 static inline uint32_t 95 is_ioat_suspended(uint64_t status) 96 { 97 return (status & SPDK_IOAT_CHANSTS_STATUS) == SPDK_IOAT_CHANSTS_SUSPENDED; 98 } 99 100 #endif /* __IOAT_INTERNAL_H__ */ 101