/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright(c) 2004 - 2009 Intel Corporation. All rights reserved.
 */
#ifndef _IOAT_REGISTERS_H_
#define _IOAT_REGISTERS_H_

#define IOAT_PCI_DMACTRL_OFFSET                 0x48
#define IOAT_PCI_DMACTRL_DMA_EN                 0x00000001
#define IOAT_PCI_DMACTRL_MSI_EN                 0x00000002

#define IOAT_PCI_DEVICE_ID_OFFSET               0x02
#define IOAT_PCI_DMAUNCERRSTS_OFFSET            0x148
#define IOAT_PCI_CHANERR_INT_OFFSET             0x180
#define IOAT_PCI_CHANERRMASK_INT_OFFSET         0x184

/* MMIO Device Registers */
#define IOAT_CHANCNT_OFFSET                     0x00    /*  8-bit */

#define IOAT_XFERCAP_OFFSET                     0x01    /*  8-bit */
#define IOAT_XFERCAP_4KB                        12
#define IOAT_XFERCAP_8KB                        13
#define IOAT_XFERCAP_16KB                       14
#define IOAT_XFERCAP_32KB                       15
#define IOAT_XFERCAP_32GB                       0

#define IOAT_GENCTRL_OFFSET                     0x02    /*  8-bit */
#define IOAT_GENCTRL_DEBUG_EN                   0x01

#define IOAT_INTRCTRL_OFFSET                    0x03    /*  8-bit */
#define IOAT_INTRCTRL_MASTER_INT_EN             0x01    /* Master Interrupt Enable */
#define IOAT_INTRCTRL_INT_STATUS                0x02    /* ATTNSTATUS -or- Channel Int */
#define IOAT_INTRCTRL_INT                       0x04    /* INT_STATUS -and- MASTER_INT_EN */
#define IOAT_INTRCTRL_MSIX_VECTOR_CONTROL       0x08    /* Enable all MSI-X vectors */

#define IOAT_ATTNSTATUS_OFFSET                  0x04    /* Each bit is a channel */

#define IOAT_VER_OFFSET                         0x08    /*  8-bit */
#define IOAT_VER_MAJOR_MASK                     0xF0
#define IOAT_VER_MINOR_MASK                     0x0F
#define GET_IOAT_VER_MAJOR(x)                   (((x) & IOAT_VER_MAJOR_MASK) >> 4)
#define GET_IOAT_VER_MINOR(x)                   ((x) & IOAT_VER_MINOR_MASK)

#define IOAT_PERPORTOFFSET_OFFSET               0x0A    /* 16-bit */

#define IOAT_INTRDELAY_OFFSET                   0x0C    /* 16-bit */
#define IOAT_INTRDELAY_MASK                     0x3FFF  /* Interrupt Delay Time */
#define IOAT_INTRDELAY_COALESE_SUPPORT          0x8000  /* Interrupt Coalescing Supported */

#define IOAT_DEVICE_STATUS_OFFSET               0x0E    /* 16-bit */
#define IOAT_DEVICE_STATUS_DEGRADED_MODE        0x0001
#define IOAT_DEVICE_MMIO_RESTRICTED             0x0002
#define IOAT_DEVICE_MEMORY_BYPASS               0x0004
#define IOAT_DEVICE_ADDRESS_REMAPPING           0x0008

#define IOAT_DMA_CAP_OFFSET                     0x10    /* 32-bit */
#define IOAT_CAP_PAGE_BREAK                     0x00000001
#define IOAT_CAP_CRC                            0x00000002
#define IOAT_CAP_SKIP_MARKER                    0x00000004
#define IOAT_CAP_DCA                            0x00000010
#define IOAT_CAP_CRC_MOVE                       0x00000020
#define IOAT_CAP_FILL_BLOCK                     0x00000040
#define IOAT_CAP_APIC                           0x00000080
#define IOAT_CAP_XOR                            0x00000100
#define IOAT_CAP_PQ                             0x00000200
#define IOAT_CAP_DWBES                          0x00002000
#define IOAT_CAP_RAID16SS                       0x00020000
#define IOAT_CAP_DPS                            0x00800000

#define IOAT_PREFETCH_LIMIT_OFFSET              0x4C    /* CHWPREFLMT */

#define IOAT_CHANNEL_MMIO_SIZE                  0x80    /* Each Channel MMIO space is this size */

/* DMA Channel Registers */
#define IOAT_CHANCTRL_OFFSET                    0x00    /* 16-bit Channel Control Register */
#define IOAT_CHANCTRL_CHANNEL_PRIORITY_MASK     0xF000
#define IOAT3_CHANCTRL_COMPL_DCA_EN             0x0200
#define IOAT_CHANCTRL_CHANNEL_IN_USE            0x0100
#define IOAT_CHANCTRL_DESCRIPTOR_ADDR_SNOOP_CONTROL     0x0020
#define IOAT_CHANCTRL_ERR_INT_EN                0x0010
#define IOAT_CHANCTRL_ANY_ERR_ABORT_EN          0x0008
#define IOAT_CHANCTRL_ERR_COMPLETION_EN         0x0004
#define IOAT_CHANCTRL_INT_REARM                 0x0001
#define IOAT_CHANCTRL_RUN                       (IOAT_CHANCTRL_INT_REARM |\
                                                 IOAT_CHANCTRL_ERR_INT_EN |\
                                                 IOAT_CHANCTRL_ERR_COMPLETION_EN |\
                                                 IOAT_CHANCTRL_ANY_ERR_ABORT_EN)

#define IOAT_DMA_COMP_OFFSET                    0x02    /* 16-bit DMA channel compatibility */
#define IOAT_DMA_COMP_V1                        0x0001  /* Compatibility with DMA version 1 */
#define IOAT_DMA_COMP_V2                        0x0002  /* Compatibility with DMA version 2 */

#define IOAT_CHANSTS_OFFSET             0x08    /* 64-bit Channel Status Register */
#define IOAT_CHANSTS_COMPLETED_DESCRIPTOR_ADDR  (~0x3fULL)
#define IOAT_CHANSTS_SOFT_ERR                   0x10ULL
#define IOAT_CHANSTS_UNAFFILIATED_ERR           0x8ULL
#define IOAT_CHANSTS_STATUS     0x7ULL
#define IOAT_CHANSTS_ACTIVE     0x0
#define IOAT_CHANSTS_DONE       0x1
#define IOAT_CHANSTS_SUSPENDED  0x2
#define IOAT_CHANSTS_HALTED     0x3



#define IOAT_CHAN_DMACOUNT_OFFSET       0x06    /* 16-bit DMA Count register */

#define IOAT_DCACTRL_OFFSET         0x30   /* 32 bit Direct Cache Access Control Register */
#define IOAT_DCACTRL_CMPL_WRITE_ENABLE 0x10000
#define IOAT_DCACTRL_TARGET_CPU_MASK   0xFFFF /* APIC ID */

/* CB DCA Memory Space Registers */
#define IOAT_DCAOFFSET_OFFSET       0x14
/* CB_BAR + IOAT_DCAOFFSET value */
#define IOAT_DCA_VER_OFFSET         0x00
#define IOAT_DCA_VER_MAJOR_MASK     0xF0
#define IOAT_DCA_VER_MINOR_MASK     0x0F

#define IOAT_DCA_COMP_OFFSET        0x02
#define IOAT_DCA_COMP_V1            0x1

#define IOAT_FSB_CAPABILITY_OFFSET  0x04
#define IOAT_FSB_CAPABILITY_PREFETCH    0x1

#define IOAT_PCI_CAPABILITY_OFFSET  0x06
#define IOAT_PCI_CAPABILITY_MEMWR   0x1

#define IOAT_FSB_CAP_ENABLE_OFFSET  0x08
#define IOAT_FSB_CAP_ENABLE_PREFETCH    0x1

#define IOAT_PCI_CAP_ENABLE_OFFSET  0x0A
#define IOAT_PCI_CAP_ENABLE_MEMWR   0x1

#define IOAT_APICID_TAG_MAP_OFFSET  0x0C
#define IOAT_APICID_TAG_MAP_TAG0    0x0000000F
#define IOAT_APICID_TAG_MAP_TAG0_SHIFT 0
#define IOAT_APICID_TAG_MAP_TAG1    0x000000F0
#define IOAT_APICID_TAG_MAP_TAG1_SHIFT 4
#define IOAT_APICID_TAG_MAP_TAG2    0x00000F00
#define IOAT_APICID_TAG_MAP_TAG2_SHIFT 8
#define IOAT_APICID_TAG_MAP_TAG3    0x0000F000
#define IOAT_APICID_TAG_MAP_TAG3_SHIFT 12
#define IOAT_APICID_TAG_MAP_TAG4    0x000F0000
#define IOAT_APICID_TAG_MAP_TAG4_SHIFT 16
#define IOAT_APICID_TAG_CB2_VALID   0x8080808080

#define IOAT_DCA_GREQID_OFFSET      0x10
#define IOAT_DCA_GREQID_SIZE        0x04
#define IOAT_DCA_GREQID_MASK        0xFFFF
#define IOAT_DCA_GREQID_IGNOREFUN   0x10000000
#define IOAT_DCA_GREQID_VALID       0x20000000
#define IOAT_DCA_GREQID_LASTID      0x80000000

#define IOAT3_CSI_CAPABILITY_OFFSET 0x08
#define IOAT3_CSI_CAPABILITY_PREFETCH    0x1

#define IOAT3_PCI_CAPABILITY_OFFSET 0x0A
#define IOAT3_PCI_CAPABILITY_MEMWR  0x1

#define IOAT3_CSI_CONTROL_OFFSET    0x0C
#define IOAT3_CSI_CONTROL_PREFETCH  0x1

#define IOAT3_PCI_CONTROL_OFFSET    0x0E
#define IOAT3_PCI_CONTROL_MEMWR     0x1

#define IOAT3_APICID_TAG_MAP_OFFSET 0x10
#define IOAT3_APICID_TAG_MAP_OFFSET_LOW  0x10
#define IOAT3_APICID_TAG_MAP_OFFSET_HIGH 0x14

#define IOAT3_DCA_GREQID_OFFSET     0x02

#define IOAT1_CHAINADDR_OFFSET          0x0C    /* 64-bit Descriptor Chain Address Register */
#define IOAT2_CHAINADDR_OFFSET          0x10    /* 64-bit Descriptor Chain Address Register */
#define IOAT_CHAINADDR_OFFSET(ver)              ((ver) < IOAT_VER_2_0 \
                                                ? IOAT1_CHAINADDR_OFFSET : IOAT2_CHAINADDR_OFFSET)
#define IOAT1_CHAINADDR_OFFSET_LOW      0x0C
#define IOAT2_CHAINADDR_OFFSET_LOW      0x10
#define IOAT_CHAINADDR_OFFSET_LOW(ver)          ((ver) < IOAT_VER_2_0 \
                                                ? IOAT1_CHAINADDR_OFFSET_LOW : IOAT2_CHAINADDR_OFFSET_LOW)
#define IOAT1_CHAINADDR_OFFSET_HIGH     0x10
#define IOAT2_CHAINADDR_OFFSET_HIGH     0x14
#define IOAT_CHAINADDR_OFFSET_HIGH(ver)         ((ver) < IOAT_VER_2_0 \
                                                ? IOAT1_CHAINADDR_OFFSET_HIGH : IOAT2_CHAINADDR_OFFSET_HIGH)

#define IOAT1_CHANCMD_OFFSET            0x14    /*  8-bit DMA Channel Command Register */
#define IOAT2_CHANCMD_OFFSET            0x04    /*  8-bit DMA Channel Command Register */
#define IOAT_CHANCMD_OFFSET(ver)                ((ver) < IOAT_VER_2_0 \
                                                ? IOAT1_CHANCMD_OFFSET : IOAT2_CHANCMD_OFFSET)
#define IOAT_CHANCMD_RESET                      0x20
#define IOAT_CHANCMD_RESUME                     0x10
#define IOAT_CHANCMD_ABORT                      0x08
#define IOAT_CHANCMD_SUSPEND                    0x04
#define IOAT_CHANCMD_APPEND                     0x02
#define IOAT_CHANCMD_START                      0x01

#define IOAT_CHANCMP_OFFSET                     0x18    /* 64-bit Channel Completion Address Register */
#define IOAT_CHANCMP_OFFSET_LOW                 0x18
#define IOAT_CHANCMP_OFFSET_HIGH                0x1C

#define IOAT_CDAR_OFFSET                        0x20    /* 64-bit Current Descriptor Address Register */
#define IOAT_CDAR_OFFSET_LOW                    0x20
#define IOAT_CDAR_OFFSET_HIGH                   0x24

#define IOAT_CHANERR_OFFSET                     0x28    /* 32-bit Channel Error Register */
#define IOAT_CHANERR_SRC_ADDR_ERR       0x0001
#define IOAT_CHANERR_DEST_ADDR_ERR      0x0002
#define IOAT_CHANERR_NEXT_ADDR_ERR      0x0004
#define IOAT_CHANERR_NEXT_DESC_ALIGN_ERR        0x0008
#define IOAT_CHANERR_CHAIN_ADDR_VALUE_ERR       0x0010
#define IOAT_CHANERR_CHANCMD_ERR                0x0020
#define IOAT_CHANERR_CHIPSET_UNCORRECTABLE_DATA_INTEGRITY_ERR   0x0040
#define IOAT_CHANERR_DMA_UNCORRECTABLE_DATA_INTEGRITY_ERR       0x0080
#define IOAT_CHANERR_READ_DATA_ERR              0x0100
#define IOAT_CHANERR_WRITE_DATA_ERR             0x0200
#define IOAT_CHANERR_CONTROL_ERR        0x0400
#define IOAT_CHANERR_LENGTH_ERR 0x0800
#define IOAT_CHANERR_COMPLETION_ADDR_ERR        0x1000
#define IOAT_CHANERR_INT_CONFIGURATION_ERR      0x2000
#define IOAT_CHANERR_SOFT_ERR                   0x4000
#define IOAT_CHANERR_UNAFFILIATED_ERR           0x8000
#define IOAT_CHANERR_XOR_P_OR_CRC_ERR           0x10000
#define IOAT_CHANERR_XOR_Q_ERR                  0x20000
#define IOAT_CHANERR_DESCRIPTOR_COUNT_ERR       0x40000

#define IOAT_CHANERR_HANDLE_MASK (IOAT_CHANERR_XOR_P_OR_CRC_ERR | IOAT_CHANERR_XOR_Q_ERR)
#define IOAT_CHANERR_RECOVER_MASK (IOAT_CHANERR_READ_DATA_ERR | \
                                   IOAT_CHANERR_WRITE_DATA_ERR)

#define IOAT_CHANERR_MASK_OFFSET                0x2C    /* 32-bit Channel Error Register */

#define IOAT_CHAN_DRSCTL_OFFSET                 0xB6
#define IOAT_CHAN_DRSZ_4KB                      0x0000
#define IOAT_CHAN_DRSZ_8KB                      0x0001
#define IOAT_CHAN_DRSZ_2MB                      0x0009
#define IOAT_CHAN_DRS_EN                        0x0100
#define IOAT_CHAN_DRS_AUTOWRAP                  0x0200

#define IOAT_CHAN_LTR_SWSEL_OFFSET              0xBC
#define IOAT_CHAN_LTR_SWSEL_ACTIVE              0x0
#define IOAT_CHAN_LTR_SWSEL_IDLE                0x1

#define IOAT_CHAN_LTR_ACTIVE_OFFSET             0xC0
#define IOAT_CHAN_LTR_ACTIVE_SNVAL              0x0000  /* 0 us */
#define IOAT_CHAN_LTR_ACTIVE_SNLATSCALE         0x0800  /* 1us scale */
#define IOAT_CHAN_LTR_ACTIVE_SNREQMNT           0x8000  /* snoop req enable */

#define IOAT_CHAN_LTR_IDLE_OFFSET               0xC4
#define IOAT_CHAN_LTR_IDLE_SNVAL                0x0258  /* 600 us */
#define IOAT_CHAN_LTR_IDLE_SNLATSCALE           0x0800  /* 1us scale */
#define IOAT_CHAN_LTR_IDLE_SNREQMNT             0x8000  /* snoop req enable */

#endif /* _IOAT_REGISTERS_H_ */