net: add rte prefix to ether defines
[dpdk.git] / drivers / net / enetc / base / enetc_hw.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2018-2019 NXP
3  */
4
5 #ifndef _ENETC_HW_H_
6 #define _ENETC_HW_H_
7 #include <rte_io.h>
8
9 #define BIT(x)          ((uint64_t)1 << ((x)))
10
11 /* ENETC device IDs */
12 #define ENETC_DEV_ID_VF         0xef00
13 #define ENETC_DEV_ID            0xe100
14
15 /* ENETC register block BAR */
16 #define ENETC_BAR_REGS                  0x0
17
18 /* SI regs, offset: 0h */
19 #define ENETC_SIMR                      0x0
20 #define ENETC_SIMR_EN                   BIT(31)
21
22 #define ENETC_SIPMAR0                   0x80
23 #define ENETC_SIPMAR1                   0x84
24
25 #define ENETC_SICAPR0                   0x900
26 #define ENETC_SICAPR1                   0x904
27
28 #define ENETC_SIMSITRV(n)               (0xB00 + (n) * 0x4)
29 #define ENETC_SIMSIRRV(n)               (0xB80 + (n) * 0x4)
30
31 #define ENETC_SICCAPR                   0x1200
32
33 /* enum for BD type */
34 enum enetc_bdr_type {TX, RX};
35
36 #define ENETC_BDR(type, n, off)         (0x8000 + (type) * 0x100 + (n) * 0x200 \
37                                                         + (off))
38 /* RX BDR reg offsets */
39 #define ENETC_RBMR              0x0 /* RX BDR mode register*/
40 #define ENETC_RBMR_EN           BIT(31)
41
42 #define ENETC_RBSR              0x4  /* Rx BDR status register*/
43 #define ENETC_RBBSR             0x8  /* Rx BDR buffer size register*/
44 #define ENETC_RBCIR             0xc  /* Rx BDR consumer index register*/
45 #define ENETC_RBBAR0            0x10 /* Rx BDR base address register 0 */
46 #define ENETC_RBBAR1            0x14 /* Rx BDR base address register 1*/
47 #define ENETC_RBPIR             0x18 /* Rx BDR producer index register*/
48 #define ENETC_RBLENR            0x20 /* Rx BDR length register*/
49 #define ENETC_RBIER             0xa0 /* Rx BDR interrupt enable register*/
50 #define ENETC_RBIER_RXTIE       BIT(0)
51 #define ENETC_RBIDR             0xa4 /* Rx BDR interrupt detect register*/
52 #define ENETC_RBICIR0           0xa8 /* Rx BDR inetrrupt coalescing register 0*/
53 #define ENETC_RBICIR0_ICEN      BIT(31)
54
55
56 #define ENETC_TBMR      0x0  /* Tx BDR mode register (TBMR) 32 RW */
57 #define ENETC_TBSR      0x4  /* x BDR status register (TBSR) 32 RO */
58 #define ENETC_TBBAR0    0x10 /* Tx BDR base address register 0 (TBBAR0) 32 RW */
59 #define ENETC_TBBAR1    0x14 /* Tx BDR base address register 1 (TBBAR1) 32 RW */
60 #define ENETC_TBCIR     0x18 /* Tx BDR consumer index register (TBCIR) 32 RW */
61 #define ENETC_TBCISR    0x1C /* Tx BDR consumer index shadow register 32 RW */
62 #define ENETC_TBIER     0xA0 /* Tx BDR interrupt enable register 32 RW */
63 #define ENETC_TBIDR     0xA4 /* Tx BDR interrupt detect register 32 RO */
64 #define ENETC_TBICR0    0xA8 /* Tx BDR interrupt coalescing register 0 32 RW */
65 #define ENETC_TBICR1    0xAC /* Tx BDR interrupt coalescing register 1 32 RW */
66 #define ENETC_TBLENR    0x20
67
68 #define ENETC_TBCISR_IDX_MASK           0xffff
69 #define ENETC_TBIER_TXFIE               BIT(1)
70
71 #define ENETC_RTBLENR_LEN(n)            ((n) & ~0x7)
72 #define ENETC_TBMR_EN                   BIT(31)
73
74 /* Port regs, offset: 1_0000h */
75 #define ENETC_PORT_BASE                 0x10000
76 #define ENETC_PMR                       0x00000
77 #define ENETC_PMR_EN                    (BIT(16) | BIT(17) | BIT(18))
78 #define ENETC_PSR                       0x00004 /* RO */
79 #define ENETC_PSIPMR                    0x00018
80 #define ENETC_PSIPMR_SET_UP(n)          (0x1 << (n)) /* n = SI index */
81 #define ENETC_PSIPMR_SET_MP(n)          (0x1 << ((n) + 16))
82 #define ENETC_PSIPMAR0(n)               (0x00100 + (n) * 0x20)
83 #define ENETC_PSIPMAR1(n)               (0x00104 + (n) * 0x20)
84 #define ENETC_PCAPR0                    0x00900
85 #define ENETC_PCAPR1                    0x00904
86 #define ENETC_PM0_IF_MODE               0x8300
87 #define ENETC_PM1_IF_MODE               0x9300
88 #define ENETC_PMO_IFM_RG                BIT(2)
89 #define ENETC_PM0_IFM_RLP               (BIT(5) | BIT(11))
90 #define ENETC_PM0_IFM_RGAUTO            (BIT(15) | ENETC_PMO_IFM_RG | BIT(1))
91 #define ENETC_PM0_IFM_XGMII             BIT(12)
92
93 #define ENETC_PV0CFGR(n)                (0x00920 + (n) * 0x10)
94 #define ENETC_PVCFGR_SET_TXBDR(val)     ((val) & 0xff)
95 #define ENETC_PVCFGR_SET_RXBDR(val)     (((val) & 0xff) << 16)
96
97 #define ENETC_PM0_CMD_CFG               0x08008
98 #define ENETC_PM0_TX_EN                 BIT(0)
99 #define ENETC_PM0_RX_EN                 BIT(1)
100 #define ENETC_PM0_CRC                   BIT(6)
101
102 #define ENETC_PAR_PORT_CFG              0x03050
103 #define L3_CKSUM                        BIT(0)
104 #define L4_CKSUM                        BIT(1)
105
106 #define ENETC_PM0_MAXFRM                0x08014
107 #define ENETC_SET_TX_MTU(val)           ((val) << 16)
108 #define ENETC_SET_MAXFRM(val)           ((val) & 0xffff)
109 #define ENETC_PTXMBAR                   0x0608
110 /* n = TC index [0..7] */
111 #define ENETC_PTCMSDUR(n)               (0x2020 + (n) * 4)
112
113 #define ENETC_PM0_STATUS                0x08304
114 #define ENETC_LINK_MODE                 0x0000000000080000ULL
115 #define ENETC_LINK_STATUS               0x0000000000010000ULL
116 #define ENETC_LINK_SPEED_MASK           0x0000000000060000ULL
117 #define ENETC_LINK_SPEED_10M            0x0ULL
118 #define ENETC_LINK_SPEED_100M           0x0000000000020000ULL
119 #define ENETC_LINK_SPEED_1G             0x0000000000040000ULL
120
121 /* Global regs, offset: 2_0000h */
122 #define ENETC_GLOBAL_BASE               0x20000
123 #define ENETC_G_EIPBRR0                 0x00bf8
124 #define ENETC_G_EIPBRR1                 0x00bfc
125
126 /* MAC Counters */
127 /* Config register to reset counters*/
128 #define ENETC_PM0_STAT_CONFIG           0x080E0
129 /* Receive frames counter without error */
130 #define ENETC_PM0_RFRM                  0x08120
131 /* Receive packets counter, good + bad */
132 #define ENETC_PM0_RPKT                  0x08160
133 /* Received octets, good + bad */
134 #define ENETC_PM0_REOCT                 0x08120
135 /* Transmit octets, good + bad */
136 #define ENETC_PM0_TEOCT                 0x08200
137 /* Transmit frames counter without error */
138 #define ENETC_PM0_TFRM                  0x08220
139 /* Transmit packets counter, good + bad */
140 #define ENETC_PM0_TPKT                  0x08260
141 /* Dropped not Truncated packets counter */
142 #define ENETC_PM0_RDRNTP                0x081C8
143 /* Dropped + trucated packets counter */
144 #define ENETC_PM0_RDRP                  0x08158
145 /* Receive packets error counter */
146 #define ENETC_PM0_RERR                  0x08138
147 /* Transmit packets error counter */
148 #define ENETC_PM0_TERR                  0x08238
149
150 /* Stats Reset Bit*/
151 #define ENETC_CLEAR_STATS               BIT(2)
152
153 #define ENETC_G_EPFBLPR(n)              (0xd00 + 4 * (n))
154 #define ENETC_G_EPFBLPR1_XGMII          0x80000000
155
156 /* general register accessors */
157 #define enetc_rd_reg(reg)       rte_read32((void *)(reg))
158 #define enetc_wr_reg(reg, val)  rte_write32((val), (void *)(reg))
159 #define enetc_rd(hw, off)       enetc_rd_reg((size_t)(hw)->reg + (off))
160 #define enetc_wr(hw, off, val)  enetc_wr_reg((size_t)(hw)->reg + (off), val)
161 /* port register accessors - PF only */
162 #define enetc_port_rd(hw, off)  enetc_rd_reg((size_t)(hw)->port + (off))
163 #define enetc_port_wr(hw, off, val) \
164                                 enetc_wr_reg((size_t)(hw)->port + (off), val)
165 /* global register accessors - PF only */
166 #define enetc_global_rd(hw, off) \
167                                 enetc_rd_reg((size_t)(hw)->global + (off))
168 #define enetc_global_wr(hw, off, val) \
169                                 enetc_wr_reg((size_t)(hw)->global + (off), val)
170 /* BDR register accessors, see ENETC_BDR() */
171 #define enetc_bdr_rd(hw, t, n, off) \
172                                 enetc_rd(hw, ENETC_BDR(t, n, off))
173 #define enetc_bdr_wr(hw, t, n, off, val) \
174                                 enetc_wr(hw, ENETC_BDR(t, n, off), val)
175
176 #define enetc_txbdr_rd(hw, n, off) enetc_bdr_rd(hw, TX, n, off)
177 #define enetc_rxbdr_rd(hw, n, off) enetc_bdr_rd(hw, RX, n, off)
178 #define enetc_txbdr_wr(hw, n, off, val) \
179                                 enetc_bdr_wr(hw, TX, n, off, val)
180 #define enetc_rxbdr_wr(hw, n, off, val) \
181                                 enetc_bdr_wr(hw, RX, n, off, val)
182
183 #define ENETC_TX_ADDR(txq, addr) ((void *)((txq)->enetc_txbdr + (addr)))
184
185 #define ENETC_TXBD_FLAGS_IE             BIT(13)
186 #define ENETC_TXBD_FLAGS_F              BIT(15)
187
188 /* ENETC Parsed values (Little Endian) */
189 #define ENETC_PARSE_ERROR               0x8000
190 #define ENETC_PKT_TYPE_ETHER            0x0060
191 #define ENETC_PKT_TYPE_IPV4             0x0000
192 #define ENETC_PKT_TYPE_IPV6             0x0020
193 #define ENETC_PKT_TYPE_IPV4_TCP \
194                         (0x0010 | ENETC_PKT_TYPE_IPV4)
195 #define ENETC_PKT_TYPE_IPV6_TCP \
196                         (0x0010 | ENETC_PKT_TYPE_IPV6)
197 #define ENETC_PKT_TYPE_IPV4_UDP \
198                         (0x0011 | ENETC_PKT_TYPE_IPV4)
199 #define ENETC_PKT_TYPE_IPV6_UDP \
200                         (0x0011 | ENETC_PKT_TYPE_IPV6)
201 #define ENETC_PKT_TYPE_IPV4_SCTP \
202                         (0x0013 | ENETC_PKT_TYPE_IPV4)
203 #define ENETC_PKT_TYPE_IPV6_SCTP \
204                         (0x0013 | ENETC_PKT_TYPE_IPV6)
205 #define ENETC_PKT_TYPE_IPV4_ICMP \
206                         (0x0003 | ENETC_PKT_TYPE_IPV4)
207 #define ENETC_PKT_TYPE_IPV6_ICMP \
208                         (0x0003 | ENETC_PKT_TYPE_IPV6)
209
210 /* PCI device info */
211 struct enetc_hw {
212         void *reg;      /* SI registers, used by all PCI functions */
213         void *port;     /* Port registers, PF only */
214         void *global;   /* IP global registers, PF only */
215 };
216
217 struct enetc_eth_mac_info {
218         uint8_t addr[RTE_ETHER_ADDR_LEN];
219         uint8_t perm_addr[RTE_ETHER_ADDR_LEN];
220         uint8_t get_link_status;
221 };
222
223 struct enetc_eth_hw {
224         struct rte_eth_dev *ndev;
225         struct enetc_hw hw;
226         uint16_t device_id;
227         uint16_t vendor_id;
228         uint8_t revision_id;
229         struct enetc_eth_mac_info mac;
230 };
231
232 /* Transmit Descriptor */
233 struct enetc_tx_desc {
234         uint64_t addr;
235         uint16_t frm_len;
236         uint16_t buf_len;
237         uint32_t flags_errors;
238 };
239
240 /* TX Buffer Descriptors (BD) */
241 struct enetc_tx_bd {
242         uint64_t addr;
243         uint16_t buf_len;
244         uint16_t frm_len;
245         uint16_t err_csum;
246         uint16_t flags;
247 };
248
249 /* RX buffer descriptor */
250 union enetc_rx_bd {
251         struct {
252                 uint64_t addr;
253                 uint8_t reserved[8];
254         } w;
255         struct {
256                 uint16_t inet_csum;
257                 uint16_t parse_summary;
258                 uint32_t rss_hash;
259                 uint16_t buf_len;
260                 uint16_t vlan_opt;
261                 union {
262                         struct {
263                                 uint16_t flags;
264                                 uint16_t error;
265                         };
266                         uint32_t lstatus;
267                 };
268         } r;
269 };
270
271 #endif