1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2013-2016 Freescale Semiconductor Inc.
4 * Copyright 2016-2017 NXP
7 #ifndef _FSL_DPNI_CMD_H
8 #define _FSL_DPNI_CMD_H
11 #define DPNI_VER_MAJOR 7
12 #define DPNI_VER_MINOR 8
14 #define DPNI_CMD_BASE_VERSION 1
15 #define DPNI_CMD_VERSION_2 2
16 #define DPNI_CMD_VERSION_3 3
17 #define DPNI_CMD_ID_OFFSET 4
19 #define DPNI_CMD(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_BASE_VERSION)
20 #define DPNI_CMD_V2(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_2)
21 #define DPNI_CMD_V3(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_3)
24 #define DPNI_CMDID_OPEN DPNI_CMD(0x801)
25 #define DPNI_CMDID_CLOSE DPNI_CMD(0x800)
26 #define DPNI_CMDID_CREATE DPNI_CMD_V2(0x901)
27 #define DPNI_CMDID_DESTROY DPNI_CMD(0x981)
28 #define DPNI_CMDID_GET_API_VERSION DPNI_CMD(0xa01)
30 #define DPNI_CMDID_ENABLE DPNI_CMD(0x002)
31 #define DPNI_CMDID_DISABLE DPNI_CMD(0x003)
32 #define DPNI_CMDID_GET_ATTR DPNI_CMD_V2(0x004)
33 #define DPNI_CMDID_RESET DPNI_CMD(0x005)
34 #define DPNI_CMDID_IS_ENABLED DPNI_CMD(0x006)
36 #define DPNI_CMDID_SET_IRQ_ENABLE DPNI_CMD(0x012)
37 #define DPNI_CMDID_GET_IRQ_ENABLE DPNI_CMD(0x013)
38 #define DPNI_CMDID_SET_IRQ_MASK DPNI_CMD(0x014)
39 #define DPNI_CMDID_GET_IRQ_MASK DPNI_CMD(0x015)
40 #define DPNI_CMDID_GET_IRQ_STATUS DPNI_CMD(0x016)
41 #define DPNI_CMDID_CLEAR_IRQ_STATUS DPNI_CMD(0x017)
43 #define DPNI_CMDID_SET_POOLS DPNI_CMD_V2(0x200)
44 #define DPNI_CMDID_SET_ERRORS_BEHAVIOR DPNI_CMD(0x20B)
46 #define DPNI_CMDID_GET_QDID DPNI_CMD(0x210)
47 #define DPNI_CMDID_GET_SP_INFO DPNI_CMD(0x211)
48 #define DPNI_CMDID_GET_TX_DATA_OFFSET DPNI_CMD(0x212)
49 #define DPNI_CMDID_GET_LINK_STATE DPNI_CMD_V2(0x215)
50 #define DPNI_CMDID_SET_MAX_FRAME_LENGTH DPNI_CMD(0x216)
51 #define DPNI_CMDID_GET_MAX_FRAME_LENGTH DPNI_CMD(0x217)
52 #define DPNI_CMDID_SET_LINK_CFG DPNI_CMD_V2(0x21A)
53 #define DPNI_CMDID_SET_TX_SHAPING DPNI_CMD_V2(0x21B)
55 #define DPNI_CMDID_SET_MCAST_PROMISC DPNI_CMD(0x220)
56 #define DPNI_CMDID_GET_MCAST_PROMISC DPNI_CMD(0x221)
57 #define DPNI_CMDID_SET_UNICAST_PROMISC DPNI_CMD(0x222)
58 #define DPNI_CMDID_GET_UNICAST_PROMISC DPNI_CMD(0x223)
59 #define DPNI_CMDID_SET_PRIM_MAC DPNI_CMD(0x224)
60 #define DPNI_CMDID_GET_PRIM_MAC DPNI_CMD(0x225)
61 #define DPNI_CMDID_ADD_MAC_ADDR DPNI_CMD(0x226)
62 #define DPNI_CMDID_REMOVE_MAC_ADDR DPNI_CMD(0x227)
63 #define DPNI_CMDID_CLR_MAC_FILTERS DPNI_CMD(0x228)
65 #define DPNI_CMDID_ENABLE_VLAN_FILTER DPNI_CMD(0x230)
66 #define DPNI_CMDID_ADD_VLAN_ID DPNI_CMD(0x231)
67 #define DPNI_CMDID_REMOVE_VLAN_ID DPNI_CMD(0x232)
68 #define DPNI_CMDID_CLR_VLAN_FILTERS DPNI_CMD(0x233)
70 #define DPNI_CMDID_SET_RX_TC_DIST DPNI_CMD_V3(0x235)
72 #define DPNI_CMDID_SET_QOS_TBL DPNI_CMD_V2(0x240)
73 #define DPNI_CMDID_ADD_QOS_ENT DPNI_CMD(0x241)
74 #define DPNI_CMDID_REMOVE_QOS_ENT DPNI_CMD(0x242)
75 #define DPNI_CMDID_CLR_QOS_TBL DPNI_CMD(0x243)
76 #define DPNI_CMDID_ADD_FS_ENT DPNI_CMD(0x244)
77 #define DPNI_CMDID_REMOVE_FS_ENT DPNI_CMD(0x245)
78 #define DPNI_CMDID_CLR_FS_ENT DPNI_CMD(0x246)
80 #define DPNI_CMDID_GET_STATISTICS DPNI_CMD_V2(0x25D)
81 #define DPNI_CMDID_RESET_STATISTICS DPNI_CMD(0x25E)
82 #define DPNI_CMDID_GET_QUEUE DPNI_CMD(0x25F)
83 #define DPNI_CMDID_SET_QUEUE DPNI_CMD(0x260)
84 #define DPNI_CMDID_GET_TAILDROP DPNI_CMD_V2(0x261)
85 #define DPNI_CMDID_SET_TAILDROP DPNI_CMD_V2(0x262)
87 #define DPNI_CMDID_GET_PORT_MAC_ADDR DPNI_CMD(0x263)
89 #define DPNI_CMDID_GET_BUFFER_LAYOUT DPNI_CMD_V2(0x264)
90 #define DPNI_CMDID_SET_BUFFER_LAYOUT DPNI_CMD_V2(0x265)
92 #define DPNI_CMDID_SET_CONGESTION_NOTIFICATION DPNI_CMD(0x267)
93 #define DPNI_CMDID_GET_CONGESTION_NOTIFICATION DPNI_CMD(0x268)
94 #define DPNI_CMDID_SET_EARLY_DROP DPNI_CMD_V2(0x269)
95 #define DPNI_CMDID_GET_EARLY_DROP DPNI_CMD_V2(0x26A)
96 #define DPNI_CMDID_GET_OFFLOAD DPNI_CMD(0x26B)
97 #define DPNI_CMDID_SET_OFFLOAD DPNI_CMD(0x26C)
98 #define DPNI_CMDID_SET_TX_CONFIRMATION_MODE DPNI_CMD(0x266)
99 #define DPNI_CMDID_GET_TX_CONFIRMATION_MODE DPNI_CMD(0x26D)
100 #define DPNI_CMDID_SET_OPR DPNI_CMD(0x26e)
101 #define DPNI_CMDID_GET_OPR DPNI_CMD(0x26f)
102 #define DPNI_CMDID_SET_RX_FS_DIST DPNI_CMD(0x273)
103 #define DPNI_CMDID_SET_RX_HASH_DIST DPNI_CMD(0x274)
104 #define DPNI_CMDID_ADD_CUSTOM_TPID DPNI_CMD(0x275)
105 #define DPNI_CMDID_REMOVE_CUSTOM_TPID DPNI_CMD(0x276)
106 #define DPNI_CMDID_GET_CUSTOM_TPID DPNI_CMD(0x277)
108 /* Macros for accessing command fields smaller than 1byte */
109 #define DPNI_MASK(field) \
110 GENMASK(DPNI_##field##_SHIFT + DPNI_##field##_SIZE - 1, \
111 DPNI_##field##_SHIFT)
112 #define dpni_set_field(var, field, val) \
113 ((var) |= (((val) << DPNI_##field##_SHIFT) & DPNI_MASK(field)))
114 #define dpni_get_field(var, field) \
115 (((var) & DPNI_MASK(field)) >> DPNI_##field##_SHIFT)
117 #pragma pack(push, 1)
118 struct dpni_cmd_open {
122 struct dpni_cmd_create {
126 uint8_t mac_filter_entries;
128 uint8_t vlan_filter_entries;
136 struct dpni_cmd_destroy {
140 #define DPNI_BACKUP_POOL(val, order) (((val) & 0x1) << (order))
142 struct dpni_cmd_pool {
144 uint8_t priority_mask;
148 struct dpni_cmd_set_pools {
150 uint8_t backup_pool_mask;
152 struct dpni_cmd_pool pool[8];
153 uint16_t buffer_size[8];
156 /* The enable indication is always the least significant bit */
157 #define DPNI_ENABLE_SHIFT 0
158 #define DPNI_ENABLE_SIZE 1
160 struct dpni_rsp_is_enabled {
164 struct dpni_cmd_set_irq_enable {
170 struct dpni_cmd_get_irq_enable {
175 struct dpni_rsp_get_irq_enable {
179 struct dpni_cmd_set_irq_mask {
184 struct dpni_cmd_get_irq_mask {
189 struct dpni_rsp_get_irq_mask {
193 struct dpni_cmd_get_irq_status {
198 struct dpni_rsp_get_irq_status {
202 struct dpni_cmd_clear_irq_status {
207 struct dpni_rsp_get_attr {
208 /* response word 0 */
212 uint8_t mac_filter_entries;
214 /* response word 1 */
215 uint8_t vlan_filter_entries;
221 /* response word 2 */
222 uint8_t qos_key_size;
224 uint16_t wriop_version;
227 #define DPNI_ERROR_ACTION_SHIFT 0
228 #define DPNI_ERROR_ACTION_SIZE 4
229 #define DPNI_FRAME_ANN_SHIFT 4
230 #define DPNI_FRAME_ANN_SIZE 1
232 struct dpni_cmd_set_errors_behavior {
234 /* from least significant bit: error_action:4, set_frame_annotation:1 */
238 /* There are 3 separate commands for configuring Rx, Tx and Tx confirmation
239 * buffer layouts, but they all share the same parameters.
240 * If one of the functions changes, below structure needs to be split.
243 #define DPNI_PASS_TS_SHIFT 0
244 #define DPNI_PASS_TS_SIZE 1
245 #define DPNI_PASS_PR_SHIFT 1
246 #define DPNI_PASS_PR_SIZE 1
247 #define DPNI_PASS_FS_SHIFT 2
248 #define DPNI_PASS_FS_SIZE 1
249 #define DPNI_PASS_SWO_SHIFT 3
250 #define DPNI_PASS_SWO_SIZE 1
252 struct dpni_cmd_get_buffer_layout {
256 struct dpni_rsp_get_buffer_layout {
257 /* response word 0 */
259 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
262 /* response word 1 */
263 uint16_t private_data_size;
269 struct dpni_cmd_set_buffer_layout {
274 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
278 uint16_t private_data_size;
284 struct dpni_cmd_set_offload {
286 uint8_t dpni_offload;
290 struct dpni_cmd_get_offload {
292 uint8_t dpni_offload;
295 struct dpni_rsp_get_offload {
300 struct dpni_cmd_get_qdid {
304 struct dpni_rsp_get_qdid {
308 struct dpni_rsp_get_sp_info {
312 struct dpni_rsp_get_tx_data_offset {
313 uint16_t data_offset;
316 struct dpni_cmd_get_statistics {
321 struct dpni_rsp_get_statistics {
325 struct dpni_cmd_set_link_cfg {
330 uint64_t advertising;
333 #define DPNI_LINK_STATE_SHIFT 0
334 #define DPNI_LINK_STATE_SIZE 1
335 #define DPNI_STATE_VALID_SHIFT 1
336 #define DPNI_STATE_VALID_SIZE 1
338 struct dpni_rsp_get_link_state {
347 uint64_t advertising;
350 struct dpni_cmd_set_max_frame_length {
351 uint16_t max_frame_length;
354 struct dpni_rsp_get_max_frame_length {
355 uint16_t max_frame_length;
358 struct dpni_cmd_set_multicast_promisc {
362 struct dpni_rsp_get_multicast_promisc {
366 struct dpni_cmd_set_unicast_promisc {
370 struct dpni_rsp_get_unicast_promisc {
374 struct dpni_cmd_set_primary_mac_addr {
379 struct dpni_rsp_get_primary_mac_addr {
384 struct dpni_rsp_get_port_mac_addr {
389 struct dpni_cmd_add_mac_addr {
394 struct dpni_cmd_remove_mac_addr {
399 #define DPNI_UNICAST_FILTERS_SHIFT 0
400 #define DPNI_UNICAST_FILTERS_SIZE 1
401 #define DPNI_MULTICAST_FILTERS_SHIFT 1
402 #define DPNI_MULTICAST_FILTERS_SIZE 1
404 struct dpni_cmd_clear_mac_filters {
405 /* from LSB: unicast:1, multicast:1 */
409 struct dpni_cmd_enable_vlan_filter {
414 struct dpni_cmd_vlan_id {
419 #define DPNI_SEPARATE_GRP_SHIFT 0
420 #define DPNI_SEPARATE_GRP_SIZE 1
421 #define DPNI_MODE_1_SHIFT 0
422 #define DPNI_MODE_1_SIZE 4
423 #define DPNI_MODE_2_SHIFT 4
424 #define DPNI_MODE_2_SIZE 4
426 struct dpni_cmd_set_tx_priorities {
428 uint8_t prio_group_A;
429 uint8_t prio_group_B;
434 uint16_t delta_bandwidth[8];
437 #define DPNI_DIST_MODE_SHIFT 0
438 #define DPNI_DIST_MODE_SIZE 4
439 #define DPNI_MISS_ACTION_SHIFT 4
440 #define DPNI_MISS_ACTION_SIZE 4
441 #define DPNI_KEEP_HASH_KEY_SHIFT 7
442 #define DPNI_KEEP_HASH_KEY_SIZE 1
443 #define DPNI_KEEP_ENTRIES_SHIFT 6
444 #define DPNI_KEEP_ENTRIES_SIZE 1
446 struct dpni_cmd_set_rx_tc_dist {
449 /* from LSB: dist_mode:4, miss_action:4 */
453 uint8_t keep_hash_key;
454 uint16_t default_flow_id;
456 uint64_t key_cfg_iova;
459 struct dpni_cmd_get_queue {
465 #define DPNI_DEST_TYPE_SHIFT 0
466 #define DPNI_DEST_TYPE_SIZE 4
467 #define DPNI_STASH_CTRL_SHIFT 6
468 #define DPNI_STASH_CTRL_SIZE 1
469 #define DPNI_HOLD_ACTIVE_SHIFT 7
470 #define DPNI_HOLD_ACTIVE_SIZE 1
472 struct dpni_rsp_get_queue {
473 /* response word 0 */
475 /* response word 1 */
479 /* From LSB: dest_type:4, pad:2, flc_stash_ctrl:1, hold_active:1 */
481 /* response word 2 */
483 /* response word 3 */
484 uint64_t user_context;
485 /* response word 4 */
490 struct dpni_cmd_set_queue {
505 uint64_t user_context;
508 #define DPNI_DISCARD_ON_MISS_SHIFT 0
509 #define DPNI_DISCARD_ON_MISS_SIZE 1
510 #define DPNI_KEEP_QOS_ENTRIES_SHIFT 1
511 #define DPNI_KEEP_QOS_ENTRIES_SIZE 1
513 struct dpni_cmd_set_qos_table {
517 uint8_t discard_on_miss;
519 uint64_t key_cfg_iova;
522 struct dpni_cmd_add_qos_entry {
532 struct dpni_cmd_remove_qos_entry {
540 struct dpni_cmd_add_fs_entry {
551 struct dpni_cmd_remove_fs_entry {
560 struct dpni_cmd_clear_fs_entries {
565 #define DPNI_DROP_ENABLE_SHIFT 0
566 #define DPNI_DROP_ENABLE_SIZE 1
567 #define DPNI_DROP_UNITS_SHIFT 2
568 #define DPNI_DROP_UNITS_SIZE 2
570 struct dpni_early_drop {
571 /* from LSB: enable:1 units:2 */
575 uint8_t green_drop_probability;
577 uint64_t green_max_threshold;
578 uint64_t green_min_threshold;
580 uint8_t yellow_drop_probability;
582 uint64_t yellow_max_threshold;
583 uint64_t yellow_min_threshold;
585 uint8_t red_drop_probability;
587 uint64_t red_max_threshold;
588 uint64_t red_min_threshold;
591 struct dpni_cmd_early_drop {
595 uint64_t early_drop_iova;
598 struct dpni_rsp_get_api_version {
603 struct dpni_cmd_get_taildrop {
604 uint8_t congestion_point;
610 struct dpni_rsp_get_taildrop {
614 /* from LSB: enable:1 oal_lo:7 */
615 uint8_t enable_oal_lo;
616 /* from LSB: oal_hi:5 */
623 #define DPNI_OAL_LO_SHIFT 1
624 #define DPNI_OAL_LO_SIZE 7
625 #define DPNI_OAL_HI_SHIFT 0
626 #define DPNI_OAL_HI_SIZE 5
628 struct dpni_cmd_set_taildrop {
630 uint8_t congestion_point;
636 /* from LSB: enable:1 oal_lo:7 */
637 uint8_t enable_oal_lo;
638 /* from LSB: oal_hi:5 */
645 struct dpni_tx_confirmation_mode {
647 uint8_t confirmation_mode;
650 #define DPNI_DEST_TYPE_SHIFT 0
651 #define DPNI_DEST_TYPE_SIZE 4
652 #define DPNI_CONG_UNITS_SHIFT 4
653 #define DPNI_CONG_UNITS_SIZE 2
655 struct dpni_cmd_set_congestion_notification {
660 uint16_t notification_mode;
661 uint8_t dest_priority;
662 /* from LSB: dest_type: 4 units:2 */
664 uint64_t message_iova;
665 uint64_t message_ctx;
666 uint32_t threshold_entry;
667 uint32_t threshold_exit;
670 struct dpni_cmd_get_congestion_notification {
675 struct dpni_rsp_get_congestion_notification {
678 uint16_t notification_mode;
679 uint8_t dest_priority;
680 /* from LSB: dest_type: 4 units:2 */
682 uint64_t message_iova;
683 uint64_t message_ctx;
684 uint32_t threshold_entry;
685 uint32_t threshold_exit;
688 struct dpni_cmd_set_opr {
701 struct dpni_cmd_get_opr {
707 #define DPNI_RIP_SHIFT 0
708 #define DPNI_RIP_SIZE 1
709 #define DPNI_OPR_ENABLE_SHIFT 1
710 #define DPNI_OPR_ENABLE_SIZE 1
711 #define DPNI_TSEQ_NLIS_SHIFT 0
712 #define DPNI_TSEQ_NLIS_SIZE 1
713 #define DPNI_HSEQ_NLIS_SHIFT 0
714 #define DPNI_HSEQ_NLIS_SIZE 1
716 struct dpni_rsp_get_opr {
718 /* from LSB: rip:1 enable:1 */
747 struct dpni_cmd_add_custom_tpid {
752 struct dpni_cmd_remove_custom_tpid {
757 struct dpni_rsp_get_custom_tpid {
762 #define DPNI_RX_FS_DIST_ENABLE_SHIFT 0
763 #define DPNI_RX_FS_DIST_ENABLE_SIZE 1
764 struct dpni_cmd_set_rx_fs_dist {
768 uint16_t miss_flow_id;
770 uint64_t key_cfg_iova;
773 #define DPNI_RX_HASH_DIST_ENABLE_SHIFT 0
774 #define DPNI_RX_HASH_DIST_ENABLE_SIZE 1
775 struct dpni_cmd_set_rx_hash_dist {
780 uint64_t key_cfg_iova;
784 #endif /* _FSL_DPNI_CMD_H */