1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2013-2016 Freescale Semiconductor Inc.
4 * Copyright 2016-2022 NXP
7 #ifndef _FSL_DPNI_CMD_H
8 #define _FSL_DPNI_CMD_H
11 #define DPNI_VER_MAJOR 8
12 #define DPNI_VER_MINOR 2
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_VERSION_4 4
18 #define DPNI_CMD_VERSION_5 5
19 #define DPNI_CMD_VERSION_6 6
20 #define DPNI_CMD_VERSION_7 7
21 #define DPNI_CMD_ID_OFFSET 4
23 #define DPNI_CMD(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_BASE_VERSION)
24 #define DPNI_CMD_V2(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_2)
25 #define DPNI_CMD_V3(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_3)
26 #define DPNI_CMD_V4(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_4)
27 #define DPNI_CMD_V5(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_5)
28 #define DPNI_CMD_V6(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_6)
29 #define DPNI_CMD_V7(id) (((id) << DPNI_CMD_ID_OFFSET) | DPNI_CMD_VERSION_7)
32 #define DPNI_CMDID_OPEN DPNI_CMD(0x801)
33 #define DPNI_CMDID_CLOSE DPNI_CMD(0x800)
34 #define DPNI_CMDID_CREATE DPNI_CMD_V7(0x901)
35 #define DPNI_CMDID_DESTROY DPNI_CMD(0x981)
36 #define DPNI_CMDID_GET_API_VERSION DPNI_CMD(0xa01)
38 #define DPNI_CMDID_ENABLE DPNI_CMD(0x002)
39 #define DPNI_CMDID_DISABLE DPNI_CMD(0x003)
40 #define DPNI_CMDID_GET_ATTR DPNI_CMD_V6(0x004)
41 #define DPNI_CMDID_RESET DPNI_CMD(0x005)
42 #define DPNI_CMDID_IS_ENABLED DPNI_CMD(0x006)
44 #define DPNI_CMDID_SET_IRQ_ENABLE DPNI_CMD(0x012)
45 #define DPNI_CMDID_GET_IRQ_ENABLE DPNI_CMD(0x013)
46 #define DPNI_CMDID_SET_IRQ_MASK DPNI_CMD(0x014)
47 #define DPNI_CMDID_GET_IRQ_MASK DPNI_CMD(0x015)
48 #define DPNI_CMDID_GET_IRQ_STATUS DPNI_CMD(0x016)
49 #define DPNI_CMDID_CLEAR_IRQ_STATUS DPNI_CMD(0x017)
51 #define DPNI_CMDID_SET_POOLS DPNI_CMD_V3(0x200)
52 #define DPNI_CMDID_SET_ERRORS_BEHAVIOR DPNI_CMD(0x20B)
54 #define DPNI_CMDID_GET_QDID DPNI_CMD(0x210)
55 #define DPNI_CMDID_GET_SP_INFO DPNI_CMD(0x211)
56 #define DPNI_CMDID_GET_TX_DATA_OFFSET DPNI_CMD(0x212)
57 #define DPNI_CMDID_GET_LINK_STATE DPNI_CMD_V2(0x215)
58 #define DPNI_CMDID_SET_MAX_FRAME_LENGTH DPNI_CMD(0x216)
59 #define DPNI_CMDID_GET_MAX_FRAME_LENGTH DPNI_CMD(0x217)
60 #define DPNI_CMDID_SET_LINK_CFG DPNI_CMD_V2(0x21A)
61 #define DPNI_CMDID_SET_TX_SHAPING DPNI_CMD_V3(0x21B)
63 #define DPNI_CMDID_SET_MCAST_PROMISC DPNI_CMD(0x220)
64 #define DPNI_CMDID_GET_MCAST_PROMISC DPNI_CMD(0x221)
65 #define DPNI_CMDID_SET_UNICAST_PROMISC DPNI_CMD(0x222)
66 #define DPNI_CMDID_GET_UNICAST_PROMISC DPNI_CMD(0x223)
67 #define DPNI_CMDID_SET_PRIM_MAC DPNI_CMD(0x224)
68 #define DPNI_CMDID_GET_PRIM_MAC DPNI_CMD(0x225)
69 #define DPNI_CMDID_ADD_MAC_ADDR DPNI_CMD_V2(0x226)
70 #define DPNI_CMDID_REMOVE_MAC_ADDR DPNI_CMD(0x227)
71 #define DPNI_CMDID_CLR_MAC_FILTERS DPNI_CMD(0x228)
73 #define DPNI_CMDID_ENABLE_VLAN_FILTER DPNI_CMD(0x230)
74 #define DPNI_CMDID_ADD_VLAN_ID DPNI_CMD_V2(0x231)
75 #define DPNI_CMDID_REMOVE_VLAN_ID DPNI_CMD(0x232)
76 #define DPNI_CMDID_CLR_VLAN_FILTERS DPNI_CMD(0x233)
78 #define DPNI_CMDID_SET_RX_TC_DIST DPNI_CMD_V4(0x235)
80 #define DPNI_CMDID_SET_RX_TC_POLICING DPNI_CMD(0x23E)
82 #define DPNI_CMDID_SET_QOS_TBL DPNI_CMD_V2(0x240)
83 #define DPNI_CMDID_ADD_QOS_ENT DPNI_CMD_V2(0x241)
84 #define DPNI_CMDID_REMOVE_QOS_ENT DPNI_CMD(0x242)
85 #define DPNI_CMDID_CLR_QOS_TBL DPNI_CMD(0x243)
86 #define DPNI_CMDID_ADD_FS_ENT DPNI_CMD_V2(0x244)
87 #define DPNI_CMDID_REMOVE_FS_ENT DPNI_CMD(0x245)
88 #define DPNI_CMDID_CLR_FS_ENT DPNI_CMD(0x246)
90 #define DPNI_CMDID_SET_TX_PRIORITIES DPNI_CMD_V3(0x250)
91 #define DPNI_CMDID_GET_RX_TC_POLICING DPNI_CMD(0x251)
93 #define DPNI_CMDID_GET_STATISTICS DPNI_CMD_V4(0x25D)
94 #define DPNI_CMDID_RESET_STATISTICS DPNI_CMD(0x25E)
95 #define DPNI_CMDID_GET_QUEUE DPNI_CMD_V3(0x25F)
96 #define DPNI_CMDID_SET_QUEUE DPNI_CMD_V3(0x260)
97 #define DPNI_CMDID_GET_TAILDROP DPNI_CMD_V2(0x261)
98 #define DPNI_CMDID_SET_TAILDROP DPNI_CMD_V3(0x262)
100 #define DPNI_CMDID_GET_PORT_MAC_ADDR DPNI_CMD(0x263)
102 #define DPNI_CMDID_GET_BUFFER_LAYOUT DPNI_CMD_V2(0x264)
103 #define DPNI_CMDID_SET_BUFFER_LAYOUT DPNI_CMD_V2(0x265)
105 #define DPNI_CMDID_SET_CONGESTION_NOTIFICATION DPNI_CMD_V3(0x267)
106 #define DPNI_CMDID_GET_CONGESTION_NOTIFICATION DPNI_CMD_V3(0x268)
107 #define DPNI_CMDID_SET_EARLY_DROP DPNI_CMD_V3(0x269)
108 #define DPNI_CMDID_GET_EARLY_DROP DPNI_CMD_V3(0x26A)
109 #define DPNI_CMDID_GET_OFFLOAD DPNI_CMD_V2(0x26B)
110 #define DPNI_CMDID_SET_OFFLOAD DPNI_CMD_V2(0x26C)
111 #define DPNI_CMDID_SET_TX_CONFIRMATION_MODE DPNI_CMD(0x266)
112 #define DPNI_CMDID_GET_TX_CONFIRMATION_MODE DPNI_CMD(0x26D)
113 #define DPNI_CMDID_SET_OPR DPNI_CMD_V2(0x26e)
114 #define DPNI_CMDID_GET_OPR DPNI_CMD_V2(0x26f)
115 #define DPNI_CMDID_LOAD_SW_SEQUENCE DPNI_CMD(0x270)
116 #define DPNI_CMDID_ENABLE_SW_SEQUENCE DPNI_CMD(0x271)
117 #define DPNI_CMDID_GET_SW_SEQUENCE_LAYOUT DPNI_CMD(0x272)
118 #define DPNI_CMDID_SET_RX_FS_DIST DPNI_CMD_V2(0x273)
119 #define DPNI_CMDID_SET_RX_HASH_DIST DPNI_CMD_V2(0x274)
120 #define DPNI_CMDID_ADD_CUSTOM_TPID DPNI_CMD(0x275)
121 #define DPNI_CMDID_REMOVE_CUSTOM_TPID DPNI_CMD(0x276)
122 #define DPNI_CMDID_GET_CUSTOM_TPID DPNI_CMD(0x277)
123 #define DPNI_CMDID_GET_LINK_CFG DPNI_CMD(0x278)
124 #define DPNI_CMDID_SET_PORT_CFG DPNI_CMD(0x27B)
126 /* Macros for accessing command fields smaller than 1byte */
127 #define DPNI_MASK(field) \
128 GENMASK(DPNI_##field##_SHIFT + DPNI_##field##_SIZE - 1, \
129 DPNI_##field##_SHIFT)
130 #define dpni_set_field(var, field, val) \
131 ((var) |= (((val) << DPNI_##field##_SHIFT) & DPNI_MASK(field)))
132 #define dpni_get_field(var, field) \
133 (((var) & DPNI_MASK(field)) >> DPNI_##field##_SHIFT)
135 #pragma pack(push, 1)
136 struct dpni_cmd_open {
140 struct dpni_cmd_create {
144 uint8_t mac_filter_entries;
145 uint8_t num_channels;
146 uint8_t vlan_filter_entries;
155 uint8_t dist_key_size;
158 struct dpni_cmd_destroy {
162 #define DPNI_BACKUP_POOL(val, order) (((val) & 0x1) << (order))
164 struct dpni_cmd_pool {
166 uint8_t priority_mask;
170 struct dpni_cmd_set_pools {
172 uint8_t backup_pool_mask;
174 uint8_t pool_options;
175 struct dpni_cmd_pool pool[8];
176 uint16_t buffer_size[8];
179 /* The enable indication is always the least significant bit */
180 #define DPNI_ENABLE_SHIFT 0
181 #define DPNI_ENABLE_SIZE 1
183 struct dpni_rsp_is_enabled {
187 struct dpni_cmd_set_irq_enable {
193 struct dpni_cmd_get_irq_enable {
198 struct dpni_rsp_get_irq_enable {
202 struct dpni_cmd_set_irq_mask {
207 struct dpni_cmd_get_irq_mask {
212 struct dpni_rsp_get_irq_mask {
216 struct dpni_cmd_get_irq_status {
221 struct dpni_rsp_get_irq_status {
225 struct dpni_cmd_clear_irq_status {
230 struct dpni_rsp_get_attr {
231 /* response word 0 */
235 uint8_t mac_filter_entries;
237 /* response word 1 */
238 uint8_t vlan_filter_entries;
239 uint8_t num_channels;
244 /* response word 2 */
245 uint8_t qos_key_size;
247 uint16_t wriop_version;
251 #define DPNI_ERROR_ACTION_SHIFT 0
252 #define DPNI_ERROR_ACTION_SIZE 4
253 #define DPNI_FRAME_ANN_SHIFT 4
254 #define DPNI_FRAME_ANN_SIZE 1
256 struct dpni_cmd_set_errors_behavior {
258 /* from least significant bit: error_action:4, set_frame_annotation:1 */
262 /* There are 3 separate commands for configuring Rx, Tx and Tx confirmation
263 * buffer layouts, but they all share the same parameters.
264 * If one of the functions changes, below structure needs to be split.
267 #define DPNI_PASS_TS_SHIFT 0
268 #define DPNI_PASS_TS_SIZE 1
269 #define DPNI_PASS_PR_SHIFT 1
270 #define DPNI_PASS_PR_SIZE 1
271 #define DPNI_PASS_FS_SHIFT 2
272 #define DPNI_PASS_FS_SIZE 1
273 #define DPNI_PASS_SWO_SHIFT 3
274 #define DPNI_PASS_SWO_SIZE 1
276 struct dpni_cmd_get_buffer_layout {
280 struct dpni_rsp_get_buffer_layout {
281 /* response word 0 */
283 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
286 /* response word 1 */
287 uint16_t private_data_size;
293 struct dpni_cmd_set_buffer_layout {
298 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
302 uint16_t private_data_size;
308 struct dpni_cmd_set_offload {
310 uint8_t dpni_offload;
314 struct dpni_cmd_get_offload {
316 uint8_t dpni_offload;
319 struct dpni_rsp_get_offload {
324 struct dpni_cmd_get_qdid {
328 struct dpni_rsp_get_qdid {
332 struct dpni_rsp_get_sp_info {
336 struct dpni_rsp_get_tx_data_offset {
337 uint16_t data_offset;
340 struct dpni_cmd_get_statistics {
345 struct dpni_rsp_get_statistics {
349 struct dpni_cmd_set_link_cfg {
354 uint64_t advertising;
357 #define DPNI_LINK_STATE_SHIFT 0
358 #define DPNI_LINK_STATE_SIZE 1
359 #define DPNI_STATE_VALID_SHIFT 1
360 #define DPNI_STATE_VALID_SIZE 1
362 struct dpni_rsp_get_link_state {
371 uint64_t advertising;
374 #define DPNI_COUPLED_SHIFT 0
375 #define DPNI_COUPLED_SIZE 1
376 #define DPNI_LNI_SHAPER_SHIFT 1
377 #define DPNI_LNI_SHAPER_SIZE 1
379 struct dpni_cmd_set_tx_shaping {
380 uint16_t tx_cr_max_burst_size;
381 uint16_t tx_er_max_burst_size;
383 uint32_t tx_cr_rate_limit;
384 uint32_t tx_er_rate_limit;
385 /* from LSB: coupled:1, lni_shaper: 1*/
391 struct dpni_cmd_set_max_frame_length {
392 uint16_t max_frame_length;
395 struct dpni_rsp_get_max_frame_length {
396 uint16_t max_frame_length;
399 struct dpni_cmd_set_multicast_promisc {
403 struct dpni_rsp_get_multicast_promisc {
407 struct dpni_cmd_set_unicast_promisc {
411 struct dpni_rsp_get_unicast_promisc {
415 struct dpni_cmd_set_primary_mac_addr {
420 struct dpni_rsp_get_primary_mac_addr {
425 struct dpni_rsp_get_port_mac_addr {
430 struct dpni_cmd_add_mac_addr {
438 struct dpni_cmd_remove_mac_addr {
443 #define DPNI_UNICAST_FILTERS_SHIFT 0
444 #define DPNI_UNICAST_FILTERS_SIZE 1
445 #define DPNI_MULTICAST_FILTERS_SHIFT 1
446 #define DPNI_MULTICAST_FILTERS_SIZE 1
448 struct dpni_cmd_clear_mac_filters {
449 /* from LSB: unicast:1, multicast:1 */
453 struct dpni_cmd_enable_vlan_filter {
458 struct dpni_cmd_vlan_id {
466 #define DPNI_SEPARATE_GRP_SHIFT 0
467 #define DPNI_SEPARATE_GRP_SIZE 1
468 #define DPNI_MODE_1_SHIFT 0
469 #define DPNI_MODE_1_SIZE 4
470 #define DPNI_MODE_2_SHIFT 4
471 #define DPNI_MODE_2_SIZE 4
473 struct dpni_cmd_set_tx_priorities {
475 uint8_t prio_group_A;
476 uint8_t prio_group_B;
482 uint16_t delta_bandwidth[8];
485 #define DPNI_DIST_MODE_SHIFT 0
486 #define DPNI_DIST_MODE_SIZE 4
487 #define DPNI_MISS_ACTION_SHIFT 4
488 #define DPNI_MISS_ACTION_SIZE 4
489 #define DPNI_KEEP_HASH_KEY_SHIFT 7
490 #define DPNI_KEEP_HASH_KEY_SIZE 1
491 #define DPNI_KEEP_ENTRIES_SHIFT 6
492 #define DPNI_KEEP_ENTRIES_SIZE 1
494 struct dpni_cmd_set_rx_tc_dist {
497 /* from LSB: dist_mode:4, miss_action:4 */
501 uint8_t keep_hash_key;
502 uint16_t default_flow_id;
504 uint64_t key_cfg_iova;
507 struct dpni_cmd_get_queue {
514 #define DPNI_DEST_TYPE_SHIFT 0
515 #define DPNI_DEST_TYPE_SIZE 4
516 #define DPNI_CGID_VALID_SHIFT 5
517 #define DPNI_CGID_VALID_SIZE 1
518 #define DPNI_STASH_CTRL_SHIFT 6
519 #define DPNI_STASH_CTRL_SIZE 1
520 #define DPNI_HOLD_ACTIVE_SHIFT 7
521 #define DPNI_HOLD_ACTIVE_SIZE 1
523 struct dpni_rsp_get_queue {
524 /* response word 0 */
526 /* response word 1 */
531 * dest_type:4, pad:1, cgid_valid:1, flc_stash_ctrl:1, hold_active:1
534 /* response word 2 */
536 /* response word 3 */
537 uint64_t user_context;
538 /* response word 4 */
546 struct dpni_cmd_set_queue {
561 uint64_t user_context;
567 #define DPNI_DISCARD_ON_MISS_SHIFT 0
568 #define DPNI_DISCARD_ON_MISS_SIZE 1
569 #define DPNI_KEEP_QOS_ENTRIES_SHIFT 1
570 #define DPNI_KEEP_QOS_ENTRIES_SIZE 1
572 struct dpni_cmd_set_qos_table {
576 uint8_t discard_on_miss;
578 uint64_t key_cfg_iova;
581 #define DPNI_QOS_OPT_SET_TC_ONLY 0x0
582 #define DPNI_QOS_OPT_SET_FLOW_ID 0x1
584 struct dpni_cmd_add_qos_entry {
595 struct dpni_cmd_remove_qos_entry {
603 struct dpni_cmd_add_fs_entry {
612 uint16_t redir_token;
615 struct dpni_cmd_remove_fs_entry {
624 struct dpni_cmd_clear_fs_entries {
629 #define DPNI_MODE_SHIFT 0
630 #define DPNI_MODE_SIZE 4
631 #define DPNI_COLOR_SHIFT 4
632 #define DPNI_COLOR_SIZE 4
633 #define DPNI_UNITS_SHIFT 0
634 #define DPNI_UNITS_SIZE 4
636 struct dpni_cmd_set_rx_tc_policing {
637 /* from LSB: mode:4 color:4 */
639 /* from LSB: units: 4 */
650 struct dpni_cmd_get_rx_tc_policing {
655 struct dpni_rsp_get_rx_tc_policing {
656 /* from LSB: mode:4 color:4 */
658 /* from LSB: units: 4 */
668 #define DPNI_DROP_ENABLE_SHIFT 0
669 #define DPNI_DROP_ENABLE_SIZE 1
670 #define DPNI_DROP_UNITS_SHIFT 2
671 #define DPNI_DROP_UNITS_SIZE 2
673 struct dpni_early_drop {
674 /* from LSB: enable:1 units:2 */
678 uint8_t green_drop_probability;
680 uint64_t green_max_threshold;
681 uint64_t green_min_threshold;
683 uint8_t yellow_drop_probability;
685 uint64_t yellow_max_threshold;
686 uint64_t yellow_min_threshold;
688 uint8_t red_drop_probability;
690 uint64_t red_max_threshold;
691 uint64_t red_min_threshold;
694 struct dpni_cmd_early_drop {
699 uint64_t early_drop_iova;
702 struct dpni_rsp_get_api_version {
707 struct dpni_cmd_get_taildrop {
708 uint8_t congestion_point;
714 struct dpni_rsp_get_taildrop {
718 /* from LSB: enable:1 oal_lo:7 */
719 uint8_t enable_oal_lo;
720 /* from LSB: oal_hi:5 */
727 #define DPNI_OAL_LO_SHIFT 1
728 #define DPNI_OAL_LO_SIZE 7
729 #define DPNI_OAL_HI_SHIFT 0
730 #define DPNI_OAL_HI_SIZE 5
732 struct dpni_cmd_set_taildrop {
734 uint8_t congestion_point;
741 /* from LSB: enable:1 oal_lo:7 */
742 uint8_t enable_oal_lo;
743 /* from LSB: oal_hi:5 */
750 struct dpni_tx_confirmation_mode {
752 uint8_t confirmation_mode;
755 #define DPNI_DEST_TYPE_SHIFT 0
756 #define DPNI_DEST_TYPE_SIZE 4
757 #define DPNI_CONG_UNITS_SHIFT 4
758 #define DPNI_CONG_UNITS_SIZE 2
760 struct dpni_cmd_set_congestion_notification {
764 uint8_t congestion_point;
768 uint16_t notification_mode;
769 uint8_t dest_priority;
770 /* from LSB: dest_type: 4 units:2 */
772 uint64_t message_iova;
773 uint64_t message_ctx;
774 uint32_t threshold_entry;
775 uint32_t threshold_exit;
778 struct dpni_cmd_get_congestion_notification {
782 uint8_t congestion_point;
786 struct dpni_rsp_get_congestion_notification {
789 uint16_t notification_mode;
790 uint8_t dest_priority;
791 /* from LSB: dest_type: 4 units:2 */
793 uint64_t message_iova;
794 uint64_t message_ctx;
795 uint32_t threshold_entry;
796 uint32_t threshold_exit;
799 struct dpni_cmd_set_opr {
812 struct dpni_cmd_get_opr {
819 #define DPNI_RIP_SHIFT 0
820 #define DPNI_RIP_SIZE 1
821 #define DPNI_OPR_ENABLE_SHIFT 1
822 #define DPNI_OPR_ENABLE_SIZE 1
823 #define DPNI_TSEQ_NLIS_SHIFT 0
824 #define DPNI_TSEQ_NLIS_SIZE 1
825 #define DPNI_HSEQ_NLIS_SHIFT 0
826 #define DPNI_HSEQ_NLIS_SIZE 1
828 struct dpni_rsp_get_opr {
830 /* from LSB: rip:1 enable:1 */
859 struct dpni_load_sw_sequence {
869 struct dpni_enable_sw_sequence {
876 uint8_t param_offset;
883 struct dpni_get_sw_sequence_layout {
886 uint64_t layout_iova;
889 struct dpni_sw_sequence_layout_entry {
892 uint8_t param_offset;
897 #define DPNI_PTP_ENABLE_SHIFT 0
898 #define DPNI_PTP_ENABLE_SIZE 1
899 #define DPNI_PTP_CH_UPDATE_SHIFT 1
900 #define DPNI_PTP_CH_UPDATE_SIZE 1
901 struct dpni_cmd_single_step_cfg {
907 struct dpni_rsp_single_step_cfg {
911 uint32_t ptp_onestep_reg_base;
915 #define DPNI_PORT_LOOPBACK_EN_SHIFT 0
916 #define DPNI_PORT_LOOPBACK_EN_SIZE 1
918 struct dpni_cmd_set_port_cfg {
923 struct dpni_rsp_get_port_cfg {
928 #define DPNI_RX_FS_DIST_ENABLE_SHIFT 0
929 #define DPNI_RX_FS_DIST_ENABLE_SIZE 1
930 struct dpni_cmd_set_rx_fs_dist {
934 uint16_t miss_flow_id;
936 uint64_t key_cfg_iova;
939 #define DPNI_RX_HASH_DIST_ENABLE_SHIFT 0
940 #define DPNI_RX_HASH_DIST_ENABLE_SIZE 1
941 struct dpni_cmd_set_rx_hash_dist {
946 uint64_t key_cfg_iova;
949 struct dpni_cmd_add_custom_tpid {
954 struct dpni_cmd_remove_custom_tpid {
959 struct dpni_rsp_get_custom_tpid {
965 #endif /* _FSL_DPNI_CMD_H */