1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22#ifndef FJES_HW_H_
23#define FJES_HW_H_
24
25#include <linux/netdevice.h>
26#include <linux/if_vlan.h>
27#include <linux/vmalloc.h>
28
29#include "fjes_regs.h"
30
31struct fjes_hw;
32
33#define EP_BUFFER_SUPPORT_VLAN_MAX 4
34#define EP_BUFFER_INFO_SIZE 4096
35
36#define FJES_DEBUG_PAGE_SIZE 4096
37#define FJES_DEBUG_BUFFER_SIZE (16 * FJES_DEBUG_PAGE_SIZE)
38
39#define FJES_DEVICE_RESET_TIMEOUT ((17 + 1) * 3 * 8)
40#define FJES_COMMAND_REQ_TIMEOUT ((5 + 1) * 3 * 8)
41#define FJES_COMMAND_REQ_BUFF_TIMEOUT (60 * 3)
42#define FJES_COMMAND_EPSTOP_WAIT_TIMEOUT (1)
43
44#define FJES_CMD_REQ_ERR_INFO_PARAM (0x0001)
45#define FJES_CMD_REQ_ERR_INFO_STATUS (0x0002)
46
47#define FJES_CMD_REQ_RES_CODE_NORMAL (0)
48#define FJES_CMD_REQ_RES_CODE_BUSY (1)
49
50#define FJES_ZONING_STATUS_DISABLE (0x00)
51#define FJES_ZONING_STATUS_ENABLE (0x01)
52#define FJES_ZONING_STATUS_INVALID (0xFF)
53
54#define FJES_ZONING_ZONE_TYPE_NONE (0xFF)
55
56#define FJES_TX_DELAY_SEND_NONE (0)
57#define FJES_TX_DELAY_SEND_PENDING (1)
58
59#define FJES_RX_STOP_REQ_NONE (0x0)
60#define FJES_RX_STOP_REQ_DONE (0x1)
61#define FJES_RX_STOP_REQ_REQUEST (0x2)
62#define FJES_RX_POLL_WORK (0x4)
63#define FJES_RX_MTU_CHANGING_DONE (0x8)
64
65#define EP_BUFFER_SIZE \
66 (((sizeof(union ep_buffer_info) + (128 * (64 * 1024))) \
67 / EP_BUFFER_INFO_SIZE) * EP_BUFFER_INFO_SIZE)
68
69#define EP_RING_NUM(buffer_size, frame_size) \
70 (u32)((buffer_size) / (frame_size))
71#define EP_RING_INDEX(_num, _max) (((_num) + (_max)) % (_max))
72#define EP_RING_INDEX_INC(_num, _max) \
73 ((_num) = EP_RING_INDEX((_num) + 1, (_max)))
74#define EP_RING_FULL(_head, _tail, _max) \
75 (0 == EP_RING_INDEX(((_tail) - (_head)), (_max)))
76#define EP_RING_EMPTY(_head, _tail, _max) \
77 (1 == EP_RING_INDEX(((_tail) - (_head)), (_max)))
78
79#define FJES_MTU_TO_BUFFER_SIZE(mtu) \
80 (ETH_HLEN + VLAN_HLEN + (mtu) + ETH_FCS_LEN)
81#define FJES_MTU_TO_FRAME_SIZE(mtu) \
82 (sizeof(struct esmem_frame) + FJES_MTU_TO_BUFFER_SIZE(mtu))
83#define FJES_MTU_DEFINE(size) \
84 ((size) - sizeof(struct esmem_frame) - \
85 (ETH_HLEN + VLAN_HLEN + ETH_FCS_LEN))
86
87#define FJES_DEV_COMMAND_INFO_REQ_LEN (4)
88#define FJES_DEV_COMMAND_INFO_RES_LEN(epnum) (8 + 2 * (epnum))
89#define FJES_DEV_COMMAND_SHARE_BUFFER_REQ_LEN(txb, rxb) \
90 (24 + (8 * ((txb) / EP_BUFFER_INFO_SIZE + (rxb) / EP_BUFFER_INFO_SIZE)))
91#define FJES_DEV_COMMAND_SHARE_BUFFER_RES_LEN (8)
92#define FJES_DEV_COMMAND_UNSHARE_BUFFER_REQ_LEN (8)
93#define FJES_DEV_COMMAND_UNSHARE_BUFFER_RES_LEN (8)
94
95#define FJES_DEV_REQ_BUF_SIZE(maxep) \
96 FJES_DEV_COMMAND_SHARE_BUFFER_REQ_LEN(EP_BUFFER_SIZE, EP_BUFFER_SIZE)
97#define FJES_DEV_RES_BUF_SIZE(maxep) \
98 FJES_DEV_COMMAND_INFO_RES_LEN(maxep)
99
100#define FJES_DEV_COMMAND_START_DBG_REQ_LEN(byte) \
101 (16 + (8 * (byte) / FJES_DEBUG_PAGE_SIZE))
102#define FJES_DEV_COMMAND_START_DBG_RES_LEN (8)
103#define FJES_DEV_COMMAND_STOP_DBG_REQ_LEN (4)
104#define FJES_DEV_COMMAND_STOP_DBG_RES_LEN (8)
105
106
107struct esmem_frame {
108 __le32 frame_size;
109 u8 frame_data[];
110};
111
112
113enum ep_partner_status {
114 EP_PARTNER_UNSHARE,
115 EP_PARTNER_SHARED,
116 EP_PARTNER_WAITING,
117 EP_PARTNER_COMPLETE,
118 EP_PARTNER_STATUS_MAX,
119};
120
121
122struct fjes_device_shared_info {
123 int epnum;
124 u8 ep_status[];
125};
126
127
128union fjes_device_command_req {
129 struct {
130 __le32 length;
131 } info;
132 struct {
133 __le32 length;
134 __le32 epid;
135 __le64 buffer[];
136 } share_buffer;
137 struct {
138 __le32 length;
139 __le32 epid;
140 } unshare_buffer;
141 struct {
142 __le32 length;
143 __le32 mode;
144 __le64 buffer_len;
145 __le64 buffer[];
146 } start_trace;
147 struct {
148 __le32 length;
149 } stop_trace;
150};
151
152
153union fjes_device_command_res {
154 struct {
155 __le32 length;
156 __le32 code;
157 struct {
158 u8 es_status;
159 u8 zone;
160 } info[];
161 } info;
162 struct {
163 __le32 length;
164 __le32 code;
165 } share_buffer;
166 struct {
167 __le32 length;
168 __le32 code;
169 } unshare_buffer;
170 struct {
171 __le32 length;
172 __le32 code;
173 } start_trace;
174 struct {
175 __le32 length;
176 __le32 code;
177 } stop_trace;
178};
179
180
181enum fjes_dev_command_request_type {
182 FJES_CMD_REQ_INFO = 0x0001,
183 FJES_CMD_REQ_SHARE_BUFFER = 0x0002,
184 FJES_CMD_REQ_UNSHARE_BUFFER = 0x0004,
185 FJES_CMD_REQ_START_DEBUG = 0x0100,
186 FJES_CMD_REQ_STOP_DEBUG = 0x0200,
187};
188
189
190struct fjes_device_command_param {
191 u32 req_len;
192 phys_addr_t req_start;
193 u32 res_len;
194 phys_addr_t res_start;
195 phys_addr_t share_start;
196};
197
198
199enum fjes_dev_command_response_e {
200 FJES_CMD_STATUS_UNKNOWN,
201 FJES_CMD_STATUS_NORMAL,
202 FJES_CMD_STATUS_TIMEOUT,
203 FJES_CMD_STATUS_ERROR_PARAM,
204 FJES_CMD_STATUS_ERROR_STATUS,
205};
206
207
208union ep_buffer_info {
209 u8 raw[EP_BUFFER_INFO_SIZE];
210
211 struct _ep_buffer_info_common_t {
212 u32 version;
213 } common;
214
215 struct _ep_buffer_info_v1_t {
216 u32 version;
217 u32 info_size;
218
219 u32 buffer_size;
220 u16 count_max;
221
222 u16 _rsv_1;
223
224 u32 frame_max;
225 u8 mac_addr[ETH_ALEN];
226
227 u16 _rsv_2;
228 u32 _rsv_3;
229
230 u16 tx_status;
231 u16 rx_status;
232
233 u32 head;
234 u32 tail;
235
236 u16 vlan_id[EP_BUFFER_SUPPORT_VLAN_MAX];
237
238 } v1i;
239
240};
241
242
243struct fjes_drv_ep_stats {
244 u64 com_regist_buf_exec;
245 u64 com_unregist_buf_exec;
246 u64 send_intr_rx;
247 u64 send_intr_unshare;
248 u64 send_intr_zoneupdate;
249 u64 recv_intr_rx;
250 u64 recv_intr_unshare;
251 u64 recv_intr_stop;
252 u64 recv_intr_zoneupdate;
253 u64 tx_buffer_full;
254 u64 tx_dropped_not_shared;
255 u64 tx_dropped_ver_mismatch;
256 u64 tx_dropped_buf_size_mismatch;
257 u64 tx_dropped_vlanid_mismatch;
258};
259
260
261struct ep_share_mem_info {
262 struct epbuf_handler {
263 void *buffer;
264 size_t size;
265 union ep_buffer_info *info;
266 u8 *ring;
267 } tx, rx;
268
269 struct rtnl_link_stats64 net_stats;
270 struct fjes_drv_ep_stats ep_stats;
271
272 u16 tx_status_work;
273
274 u8 es_status;
275 u8 zone;
276};
277
278struct es_device_trace {
279 u32 record_num;
280 u32 current_record;
281 u32 status_flag;
282 u32 _rsv;
283
284 struct {
285 u16 epid;
286 u16 dir_offset;
287 u32 data;
288 u64 tsc;
289 } record[];
290};
291
292struct fjes_hw_info {
293 struct fjes_device_shared_info *share;
294 union fjes_device_command_req *req_buf;
295 u64 req_buf_size;
296 union fjes_device_command_res *res_buf;
297 u64 res_buf_size;
298
299 int *my_epid;
300 int *max_epid;
301
302 struct es_device_trace *trace;
303 u64 trace_size;
304
305 struct mutex lock;
306
307 unsigned long buffer_share_bit;
308 unsigned long buffer_unshare_reserve_bit;
309};
310
311struct fjes_hw {
312 void *back;
313
314 unsigned long txrx_stop_req_bit;
315 unsigned long epstop_req_bit;
316 struct work_struct update_zone_task;
317 struct work_struct epstop_task;
318
319 int my_epid;
320 int max_epid;
321
322 struct ep_share_mem_info *ep_shm_info;
323
324 struct fjes_hw_resource {
325 u64 start;
326 u64 size;
327 int irq;
328 } hw_res;
329
330 u8 *base;
331
332 struct fjes_hw_info hw_info;
333
334 spinlock_t rx_status_lock;
335
336 u32 debug_mode;
337};
338
339int fjes_hw_init(struct fjes_hw *);
340void fjes_hw_exit(struct fjes_hw *);
341int fjes_hw_reset(struct fjes_hw *);
342int fjes_hw_request_info(struct fjes_hw *);
343int fjes_hw_register_buff_addr(struct fjes_hw *, int,
344 struct ep_share_mem_info *);
345int fjes_hw_unregister_buff_addr(struct fjes_hw *, int);
346void fjes_hw_init_command_registers(struct fjes_hw *,
347 struct fjes_device_command_param *);
348void fjes_hw_setup_epbuf(struct epbuf_handler *, u8 *, u32);
349int fjes_hw_raise_interrupt(struct fjes_hw *, int, enum REG_ICTL_MASK);
350void fjes_hw_set_irqmask(struct fjes_hw *, enum REG_ICTL_MASK, bool);
351u32 fjes_hw_capture_interrupt_status(struct fjes_hw *);
352void fjes_hw_raise_epstop(struct fjes_hw *);
353int fjes_hw_wait_epstop(struct fjes_hw *);
354enum ep_partner_status
355 fjes_hw_get_partner_ep_status(struct fjes_hw *, int);
356
357bool fjes_hw_epid_is_same_zone(struct fjes_hw *, int);
358int fjes_hw_epid_is_shared(struct fjes_device_shared_info *, int);
359bool fjes_hw_check_epbuf_version(struct epbuf_handler *, u32);
360bool fjes_hw_check_mtu(struct epbuf_handler *, u32);
361bool fjes_hw_check_vlan_id(struct epbuf_handler *, u16);
362bool fjes_hw_set_vlan_id(struct epbuf_handler *, u16);
363void fjes_hw_del_vlan_id(struct epbuf_handler *, u16);
364bool fjes_hw_epbuf_rx_is_empty(struct epbuf_handler *);
365void *fjes_hw_epbuf_rx_curpkt_get_addr(struct epbuf_handler *, size_t *);
366void fjes_hw_epbuf_rx_curpkt_drop(struct epbuf_handler *);
367int fjes_hw_epbuf_tx_pkt_send(struct epbuf_handler *, void *, size_t);
368
369int fjes_hw_start_debug(struct fjes_hw *);
370int fjes_hw_stop_debug(struct fjes_hw *);
371#endif
372
