sys/dev/ioat/ioat_hw.h

   1 /*-
   2  * Copyright (C) 2012 Intel Corporation
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 __FBSDID("$FreeBSD$");
  28
  29 #ifndef __IOAT_HW_H__
  30 #define __IOAT_HW_H__
  31
  32 #define IOAT_MAX_CHANNELS               32
  33
  34 #define IOAT_CHANCNT_OFFSET             0x00
  35
  36 #define IOAT_XFERCAP_OFFSET             0x01
  37 /* Only bits [4:0] are valid. */
  38 #define IOAT_XFERCAP_VALID_MASK         0x1f
  39
  40 #define IOAT_GENCTRL_OFFSET             0x02
  41
  42 #define IOAT_INTRCTRL_OFFSET            0x03
  43 #define IOAT_INTRCTRL_MASTER_INT_EN     0x01
  44
  45 #define IOAT_ATTNSTATUS_OFFSET          0x04
  46
  47 #define IOAT_CBVER_OFFSET               0x08
  48
  49 #define IOAT_INTRDELAY_OFFSET           0x0C
  50 #define IOAT_INTRDELAY_SUPPORTED        (1 << 15)
  51 /* Reserved.                            (1 << 14) */
  52 /* [13:0] is the coalesce period, in microseconds. */
  53 #define IOAT_INTRDELAY_US_MASK          ((1 << 14) - 1)
  54
  55 #define IOAT_CS_STATUS_OFFSET           0x0E
  56
  57 #define IOAT_DMACAPABILITY_OFFSET       0x10
  58 #define IOAT_DMACAP_PB                  (1 << 0)
  59 #define IOAT_DMACAP_DCA                 (1 << 4)
  60 #define IOAT_DMACAP_BFILL               (1 << 6)
  61 #define IOAT_DMACAP_XOR                 (1 << 8)
  62 #define IOAT_DMACAP_PQ                  (1 << 9)
  63 #define IOAT_DMACAP_DMA_DIF             (1 << 10)
  64 #define IOAT_DMACAP_DWBES               (1 << 13)
  65 #define IOAT_DMACAP_RAID16SS            (1 << 17)
  66 #define IOAT_DMACAP_DMAMC               (1 << 18)
  67 #define IOAT_DMACAP_CTOS                (1 << 19)
  68
  69 #define IOAT_DMACAP_STR \
  70     "\20\24Completion_Timeout_Support\23DMA_with_Multicasting_Support" \
  71     "\22RAID_Super_descriptors\16Descriptor_Write_Back_Error_Support" \
  72     "\13DMA_with_DIF\12PQ\11XOR\07Block_Fill\05DCA\01Page_Break"
  73
  74 /* DMA Channel Registers */
  75 #define IOAT_CHANCTRL_OFFSET                    0x80
  76 #define IOAT_CHANCTRL_CHANNEL_PRIORITY_MASK     0xF000
  77 #define IOAT_CHANCTRL_COMPL_DCA_EN              0x0200
  78 #define IOAT_CHANCTRL_CHANNEL_IN_USE            0x0100
  79 #define IOAT_CHANCTRL_DESCRIPTOR_ADDR_SNOOP_CONTROL     0x0020
  80 #define IOAT_CHANCTRL_ERR_INT_EN                0x0010
  81 #define IOAT_CHANCTRL_ANY_ERR_ABORT_EN          0x0008
  82 #define IOAT_CHANCTRL_ERR_COMPLETION_EN         0x0004
  83 #define IOAT_CHANCTRL_INT_REARM                 0x0001
  84 #define IOAT_CHANCTRL_RUN                       (IOAT_CHANCTRL_INT_REARM |\
  85                                                  IOAT_CHANCTRL_ERR_COMPLETION_EN |\
  86                                                  IOAT_CHANCTRL_ANY_ERR_ABORT_EN |\
  87                                                  IOAT_CHANCTRL_ERR_INT_EN)
  88
  89 #define IOAT_CHANCMD_OFFSET             0x84
  90 #define IOAT_CHANCMD_RESET              0x20
  91 #define IOAT_CHANCMD_SUSPEND            0x04
  92
  93 #define IOAT_DMACOUNT_OFFSET            0x86
  94
  95 #define IOAT_CHANSTS_OFFSET_LOW         0x88
  96 #define IOAT_CHANSTS_OFFSET_HIGH        0x8C
  97 #define IOAT_CHANSTS_OFFSET             0x88
  98
  99 #define IOAT_CHANSTS_STATUS             0x7ULL
 100 #define IOAT_CHANSTS_ACTIVE             0x0
 101 #define IOAT_CHANSTS_IDLE               0x1
 102 #define IOAT_CHANSTS_SUSPENDED          0x2
 103 #define IOAT_CHANSTS_HALTED             0x3
 104 #define IOAT_CHANSTS_ARMED              0x4
 105
 106 #define IOAT_CHANSTS_UNAFFILIATED_ERROR 0x8ULL
 107 #define IOAT_CHANSTS_SOFT_ERROR         0x10ULL
 108
 109 #define IOAT_CHANSTS_COMPLETED_DESCRIPTOR_MASK  (~0x3FULL)
 110
 111 #define IOAT_CHAINADDR_OFFSET_LOW       0x90
 112 #define IOAT_CHAINADDR_OFFSET_HIGH      0x94
 113
 114 #define IOAT_CHANCMP_OFFSET_LOW         0x98
 115 #define IOAT_CHANCMP_OFFSET_HIGH        0x9C
 116
 117 #define IOAT_CHANERR_OFFSET             0xA8
 118
 119 #define IOAT_CHANERR_XSADDERR           (1 << 0)
 120 #define IOAT_CHANERR_XDADDERR           (1 << 1)
 121 #define IOAT_CHANERR_NDADDERR           (1 << 2)
 122 #define IOAT_CHANERR_DERR               (1 << 3)
 123 #define IOAT_CHANERR_CHADDERR           (1 << 4)
 124 #define IOAT_CHANERR_CCMDERR            (1 << 5)
 125 #define IOAT_CHANERR_CUNCORERR          (1 << 6)
 126 #define IOAT_CHANERR_DUNCORERR          (1 << 7)
 127 #define IOAT_CHANERR_RDERR              (1 << 8)
 128 #define IOAT_CHANERR_WDERR              (1 << 9)
 129 #define IOAT_CHANERR_DCERR              (1 << 10)
 130 #define IOAT_CHANERR_DXSERR             (1 << 11)
 131 #define IOAT_CHANERR_CMPADDERR          (1 << 12)
 132 #define IOAT_CHANERR_INTCFGERR          (1 << 13)
 133 #define IOAT_CHANERR_SEDERR             (1 << 14)
 134 #define IOAT_CHANERR_UNAFFERR           (1 << 15)
 135 #define IOAT_CHANERR_CXPERR             (1 << 16)
 136 /* Reserved.                            (1 << 17) */
 137 #define IOAT_CHANERR_DCNTERR            (1 << 18)
 138 #define IOAT_CHANERR_DIFFERR            (1 << 19)
 139 #define IOAT_CHANERR_GTVERR             (1 << 20)
 140 #define IOAT_CHANERR_ATVERR             (1 << 21)
 141 #define IOAT_CHANERR_RTVERR             (1 << 22)
 142 #define IOAT_CHANERR_BBERR              (1 << 23)
 143 #define IOAT_CHANERR_RDIFFERR           (1 << 24)
 144 #define IOAT_CHANERR_RGTVERR            (1 << 25)
 145 #define IOAT_CHANERR_RATVERR            (1 << 26)
 146 #define IOAT_CHANERR_RRTVERR            (1 << 27)
 147
 148 #define IOAT_CHANERR_STR \
 149     "\20\34RRTVERR\33RATVERR\32RGTVERR\31RDIFFERR\30BBERR\27RTVERR\26ATVERR" \
 150     "\25GTVERR\24DIFFERR\23DCNTERR\21CXPERR\20UNAFFERR\17SEDERR\16INTCFGERR" \
 151     "\15CMPADDERR\14DXSERR\13DCERR\12WDERR\11RDERR\10DUNCORERR\07CUNCORERR" \
 152     "\06CCMDERR\05CHADDERR\04DERR\03NDADDERR\02XDADDERR\01XSADDERR"
 153
 154
 155 #define IOAT_CFG_CHANERR_INT_OFFSET             0x180
 156 #define IOAT_CFG_CHANERRMASK_INT_OFFSET         0x184
 157
 158 #define IOAT_MIN_ORDER                  4
 159 #define IOAT_MAX_ORDER                  16
 160
 161 #endif /* __IOAT_HW_H__ */