1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2013-2016 Freescale Semiconductor Inc.
4 * Copyright 2016-2020 NXP
7 #ifndef _FSL_DPNI_CMD_H
8 #define _FSL_DPNI_CMD_H
11 #define DPNI_VER_MAJOR 7
12 #define DPNI_VER_MINOR 13
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_V3(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_V3(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_V3(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_V2(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_V2(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_RX_TC_POLICING DPNI_CMD(0x23E)
74 #define DPNI_CMDID_SET_QOS_TBL DPNI_CMD_V2(0x240)
75 #define DPNI_CMDID_ADD_QOS_ENT DPNI_CMD_V2(0x241)
76 #define DPNI_CMDID_REMOVE_QOS_ENT DPNI_CMD(0x242)
77 #define DPNI_CMDID_CLR_QOS_TBL DPNI_CMD(0x243)
78 #define DPNI_CMDID_ADD_FS_ENT DPNI_CMD(0x244)
79 #define DPNI_CMDID_REMOVE_FS_ENT DPNI_CMD(0x245)
80 #define DPNI_CMDID_CLR_FS_ENT DPNI_CMD(0x246)
82 #define DPNI_CMDID_SET_TX_PRIORITIES DPNI_CMD_V2(0x250)
83 #define DPNI_CMDID_GET_RX_TC_POLICING DPNI_CMD(0x251)
85 #define DPNI_CMDID_GET_STATISTICS DPNI_CMD_V3(0x25D)
86 #define DPNI_CMDID_RESET_STATISTICS DPNI_CMD(0x25E)
87 #define DPNI_CMDID_GET_QUEUE DPNI_CMD_V2(0x25F)
88 #define DPNI_CMDID_SET_QUEUE DPNI_CMD_V2(0x260)
89 #define DPNI_CMDID_GET_TAILDROP DPNI_CMD_V2(0x261)
90 #define DPNI_CMDID_SET_TAILDROP DPNI_CMD_V2(0x262)
92 #define DPNI_CMDID_GET_PORT_MAC_ADDR DPNI_CMD(0x263)
94 #define DPNI_CMDID_GET_BUFFER_LAYOUT DPNI_CMD_V2(0x264)
95 #define DPNI_CMDID_SET_BUFFER_LAYOUT DPNI_CMD_V2(0x265)
97 #define DPNI_CMDID_SET_CONGESTION_NOTIFICATION DPNI_CMD_V2(0x267)
98 #define DPNI_CMDID_GET_CONGESTION_NOTIFICATION DPNI_CMD_V2(0x268)
99 #define DPNI_CMDID_SET_EARLY_DROP DPNI_CMD_V2(0x269)
100 #define DPNI_CMDID_GET_EARLY_DROP DPNI_CMD_V2(0x26A)
101 #define DPNI_CMDID_GET_OFFLOAD DPNI_CMD(0x26B)
102 #define DPNI_CMDID_SET_OFFLOAD DPNI_CMD(0x26C)
103 #define DPNI_CMDID_SET_TX_CONFIRMATION_MODE DPNI_CMD(0x266)
104 #define DPNI_CMDID_GET_TX_CONFIRMATION_MODE DPNI_CMD(0x26D)
105 #define DPNI_CMDID_LOAD_SW_SEQUENCE DPNI_CMD(0x270)
106 #define DPNI_CMDID_ENABLE_SW_SEQUENCE DPNI_CMD(0x271)
107 #define DPNI_CMDID_GET_SW_SEQUENCE_LAYOUT DPNI_CMD(0x272)
108 #define DPNI_CMDID_SET_OPR DPNI_CMD(0x26e)
109 #define DPNI_CMDID_GET_OPR DPNI_CMD(0x26f)
110 #define DPNI_CMDID_SET_RX_FS_DIST DPNI_CMD(0x273)
111 #define DPNI_CMDID_SET_RX_HASH_DIST DPNI_CMD(0x274)
112 #define DPNI_CMDID_ADD_CUSTOM_TPID DPNI_CMD(0x275)
113 #define DPNI_CMDID_REMOVE_CUSTOM_TPID DPNI_CMD(0x276)
114 #define DPNI_CMDID_GET_CUSTOM_TPID DPNI_CMD(0x277)
116 /* Macros for accessing command fields smaller than 1byte */
117 #define DPNI_MASK(field) \
118 GENMASK(DPNI_##field##_SHIFT + DPNI_##field##_SIZE - 1, \
119 DPNI_##field##_SHIFT)
120 #define dpni_set_field(var, field, val) \
121 ((var) |= (((val) << DPNI_##field##_SHIFT) & DPNI_MASK(field)))
122 #define dpni_get_field(var, field) \
123 (((var) & DPNI_MASK(field)) >> DPNI_##field##_SHIFT)
125 #pragma pack(push, 1)
126 struct dpni_cmd_open {
130 struct dpni_cmd_create {
134 uint8_t mac_filter_entries;
136 uint8_t vlan_filter_entries;
146 struct dpni_cmd_destroy {
150 #define DPNI_BACKUP_POOL(val, order) (((val) & 0x1) << (order))
152 struct dpni_cmd_pool {
154 uint8_t priority_mask;
158 struct dpni_cmd_set_pools {
160 uint8_t backup_pool_mask;
162 uint8_t pool_options;
163 struct dpni_cmd_pool pool[8];
164 uint16_t buffer_size[8];
167 /* The enable indication is always the least significant bit */
168 #define DPNI_ENABLE_SHIFT 0
169 #define DPNI_ENABLE_SIZE 1
171 struct dpni_rsp_is_enabled {
175 struct dpni_cmd_set_irq_enable {
181 struct dpni_cmd_get_irq_enable {
186 struct dpni_rsp_get_irq_enable {
190 struct dpni_cmd_set_irq_mask {
195 struct dpni_cmd_get_irq_mask {
200 struct dpni_rsp_get_irq_mask {
204 struct dpni_cmd_get_irq_status {
209 struct dpni_rsp_get_irq_status {
213 struct dpni_cmd_clear_irq_status {
218 struct dpni_rsp_get_attr {
219 /* response word 0 */
223 uint8_t mac_filter_entries;
225 /* response word 1 */
226 uint8_t vlan_filter_entries;
232 /* response word 2 */
233 uint8_t qos_key_size;
235 uint16_t wriop_version;
239 #define DPNI_ERROR_ACTION_SHIFT 0
240 #define DPNI_ERROR_ACTION_SIZE 4
241 #define DPNI_FRAME_ANN_SHIFT 4
242 #define DPNI_FRAME_ANN_SIZE 1
244 struct dpni_cmd_set_errors_behavior {
246 /* from least significant bit: error_action:4, set_frame_annotation:1 */
250 /* There are 3 separate commands for configuring Rx, Tx and Tx confirmation
251 * buffer layouts, but they all share the same parameters.
252 * If one of the functions changes, below structure needs to be split.
255 #define DPNI_PASS_TS_SHIFT 0
256 #define DPNI_PASS_TS_SIZE 1
257 #define DPNI_PASS_PR_SHIFT 1
258 #define DPNI_PASS_PR_SIZE 1
259 #define DPNI_PASS_FS_SHIFT 2
260 #define DPNI_PASS_FS_SIZE 1
261 #define DPNI_PASS_SWO_SHIFT 3
262 #define DPNI_PASS_SWO_SIZE 1
264 struct dpni_cmd_get_buffer_layout {
268 struct dpni_rsp_get_buffer_layout {
269 /* response word 0 */
271 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
274 /* response word 1 */
275 uint16_t private_data_size;
281 struct dpni_cmd_set_buffer_layout {
286 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
290 uint16_t private_data_size;
296 struct dpni_cmd_set_offload {
298 uint8_t dpni_offload;
302 struct dpni_cmd_get_offload {
304 uint8_t dpni_offload;
307 struct dpni_rsp_get_offload {
312 struct dpni_cmd_get_qdid {
316 struct dpni_rsp_get_qdid {
320 struct dpni_rsp_get_sp_info {
324 struct dpni_rsp_get_tx_data_offset {
325 uint16_t data_offset;
328 struct dpni_cmd_get_statistics {
333 struct dpni_rsp_get_statistics {
337 struct dpni_cmd_set_link_cfg {
342 uint64_t advertising;
345 #define DPNI_LINK_STATE_SHIFT 0
346 #define DPNI_LINK_STATE_SIZE 1
347 #define DPNI_STATE_VALID_SHIFT 1
348 #define DPNI_STATE_VALID_SIZE 1
350 struct dpni_rsp_get_link_state {
359 uint64_t advertising;
362 #define DPNI_COUPLED_SHIFT 0
363 #define DPNI_COUPLED_SIZE 1
365 struct dpni_cmd_set_tx_shaping {
366 uint16_t tx_cr_max_burst_size;
367 uint16_t tx_er_max_burst_size;
369 uint32_t tx_cr_rate_limit;
370 uint32_t tx_er_rate_limit;
371 /* from LSB: coupled:1 */
375 struct dpni_cmd_set_max_frame_length {
376 uint16_t max_frame_length;
379 struct dpni_rsp_get_max_frame_length {
380 uint16_t max_frame_length;
383 struct dpni_cmd_set_multicast_promisc {
387 struct dpni_rsp_get_multicast_promisc {
391 struct dpni_cmd_set_unicast_promisc {
395 struct dpni_rsp_get_unicast_promisc {
399 struct dpni_cmd_set_primary_mac_addr {
404 struct dpni_rsp_get_primary_mac_addr {
409 struct dpni_rsp_get_port_mac_addr {
414 #define DPNI_MAC_SET_QUEUE_ACTION 1
416 struct dpni_cmd_add_mac_addr {
424 struct dpni_cmd_remove_mac_addr {
429 #define DPNI_UNICAST_FILTERS_SHIFT 0
430 #define DPNI_UNICAST_FILTERS_SIZE 1
431 #define DPNI_MULTICAST_FILTERS_SHIFT 1
432 #define DPNI_MULTICAST_FILTERS_SIZE 1
434 struct dpni_cmd_clear_mac_filters {
435 /* from LSB: unicast:1, multicast:1 */
439 struct dpni_cmd_enable_vlan_filter {
444 #define DPNI_VLAN_SET_QUEUE_ACTION 1
446 struct dpni_cmd_vlan_id {
454 #define DPNI_SEPARATE_GRP_SHIFT 0
455 #define DPNI_SEPARATE_GRP_SIZE 1
456 #define DPNI_MODE_1_SHIFT 0
457 #define DPNI_MODE_1_SIZE 4
458 #define DPNI_MODE_2_SHIFT 4
459 #define DPNI_MODE_2_SIZE 4
461 struct dpni_cmd_set_tx_priorities {
463 uint8_t prio_group_A;
464 uint8_t prio_group_B;
469 uint16_t delta_bandwidth[8];
472 #define DPNI_DIST_MODE_SHIFT 0
473 #define DPNI_DIST_MODE_SIZE 4
474 #define DPNI_MISS_ACTION_SHIFT 4
475 #define DPNI_MISS_ACTION_SIZE 4
476 #define DPNI_KEEP_HASH_KEY_SHIFT 7
477 #define DPNI_KEEP_HASH_KEY_SIZE 1
478 #define DPNI_KEEP_ENTRIES_SHIFT 6
479 #define DPNI_KEEP_ENTRIES_SIZE 1
481 struct dpni_cmd_set_rx_tc_dist {
484 /* from LSB: dist_mode:4, miss_action:4 */
488 uint8_t keep_hash_key;
489 uint16_t default_flow_id;
491 uint64_t key_cfg_iova;
494 struct dpni_cmd_get_queue {
500 #define DPNI_DEST_TYPE_SHIFT 0
501 #define DPNI_DEST_TYPE_SIZE 4
502 #define DPNI_CGID_VALID_SHIFT 5
503 #define DPNI_CGID_VALID_SIZE 1
504 #define DPNI_STASH_CTRL_SHIFT 6
505 #define DPNI_STASH_CTRL_SIZE 1
506 #define DPNI_HOLD_ACTIVE_SHIFT 7
507 #define DPNI_HOLD_ACTIVE_SIZE 1
509 struct dpni_rsp_get_queue {
510 /* response word 0 */
512 /* response word 1 */
517 * dest_type:4, pad:1, cgid_valid:1, flc_stash_ctrl:1, hold_active:1
520 /* response word 2 */
522 /* response word 3 */
523 uint64_t user_context;
524 /* response word 4 */
532 struct dpni_cmd_set_queue {
547 uint64_t user_context;
552 #define DPNI_DISCARD_ON_MISS_SHIFT 0
553 #define DPNI_DISCARD_ON_MISS_SIZE 1
554 #define DPNI_KEEP_QOS_ENTRIES_SHIFT 1
555 #define DPNI_KEEP_QOS_ENTRIES_SIZE 1
557 struct dpni_cmd_set_qos_table {
561 uint8_t discard_on_miss;
563 uint64_t key_cfg_iova;
566 #define DPNI_QOS_OPT_SET_TC_ONLY 0x0
567 #define DPNI_QOS_OPT_SET_FLOW_ID 0x1
569 struct dpni_cmd_add_qos_entry {
580 struct dpni_cmd_remove_qos_entry {
588 struct dpni_cmd_add_fs_entry {
599 struct dpni_cmd_remove_fs_entry {
608 struct dpni_cmd_clear_fs_entries {
613 #define DPNI_MODE_SHIFT 0
614 #define DPNI_MODE_SIZE 4
615 #define DPNI_COLOR_SHIFT 4
616 #define DPNI_COLOR_SIZE 4
617 #define DPNI_UNITS_SHIFT 0
618 #define DPNI_UNITS_SIZE 4
620 struct dpni_cmd_set_rx_tc_policing {
621 /* from LSB: mode:4 color:4 */
623 /* from LSB: units: 4 */
634 struct dpni_cmd_get_rx_tc_policing {
639 struct dpni_rsp_get_rx_tc_policing {
640 /* from LSB: mode:4 color:4 */
642 /* from LSB: units: 4 */
652 #define DPNI_DROP_ENABLE_SHIFT 0
653 #define DPNI_DROP_ENABLE_SIZE 1
654 #define DPNI_DROP_UNITS_SHIFT 2
655 #define DPNI_DROP_UNITS_SIZE 2
657 struct dpni_early_drop {
658 /* from LSB: enable:1 units:2 */
662 uint8_t green_drop_probability;
664 uint64_t green_max_threshold;
665 uint64_t green_min_threshold;
667 uint8_t yellow_drop_probability;
669 uint64_t yellow_max_threshold;
670 uint64_t yellow_min_threshold;
672 uint8_t red_drop_probability;
674 uint64_t red_max_threshold;
675 uint64_t red_min_threshold;
678 struct dpni_cmd_early_drop {
682 uint64_t early_drop_iova;
685 struct dpni_rsp_get_api_version {
690 struct dpni_cmd_get_taildrop {
691 uint8_t congestion_point;
697 struct dpni_rsp_get_taildrop {
701 /* from LSB: enable:1 oal_lo:7 */
702 uint8_t enable_oal_lo;
703 /* from LSB: oal_hi:5 */
710 #define DPNI_OAL_LO_SHIFT 1
711 #define DPNI_OAL_LO_SIZE 7
712 #define DPNI_OAL_HI_SHIFT 0
713 #define DPNI_OAL_HI_SIZE 5
715 struct dpni_cmd_set_taildrop {
717 uint8_t congestion_point;
723 /* from LSB: enable:1 oal_lo:7 */
724 uint8_t enable_oal_lo;
725 /* from LSB: oal_hi:5 */
732 struct dpni_tx_confirmation_mode {
734 uint8_t confirmation_mode;
737 #define DPNI_DEST_TYPE_SHIFT 0
738 #define DPNI_DEST_TYPE_SIZE 4
739 #define DPNI_CONG_UNITS_SHIFT 4
740 #define DPNI_CONG_UNITS_SIZE 2
742 struct dpni_cmd_set_congestion_notification {
746 uint8_t congestion_point;
750 uint16_t notification_mode;
751 uint8_t dest_priority;
752 /* from LSB: dest_type: 4 units:2 */
754 uint64_t message_iova;
755 uint64_t message_ctx;
756 uint32_t threshold_entry;
757 uint32_t threshold_exit;
760 struct dpni_cmd_get_congestion_notification {
764 uint8_t congestion_point;
768 struct dpni_rsp_get_congestion_notification {
771 uint16_t notification_mode;
772 uint8_t dest_priority;
773 /* from LSB: dest_type: 4 units:2 */
775 uint64_t message_iova;
776 uint64_t message_ctx;
777 uint32_t threshold_entry;
778 uint32_t threshold_exit;
781 struct dpni_cmd_set_opr {
794 struct dpni_cmd_get_opr {
800 #define DPNI_RIP_SHIFT 0
801 #define DPNI_RIP_SIZE 1
802 #define DPNI_OPR_ENABLE_SHIFT 1
803 #define DPNI_OPR_ENABLE_SIZE 1
804 #define DPNI_TSEQ_NLIS_SHIFT 0
805 #define DPNI_TSEQ_NLIS_SIZE 1
806 #define DPNI_HSEQ_NLIS_SHIFT 0
807 #define DPNI_HSEQ_NLIS_SIZE 1
809 struct dpni_rsp_get_opr {
811 /* from LSB: rip:1 enable:1 */
840 struct dpni_cmd_add_custom_tpid {
845 struct dpni_cmd_remove_custom_tpid {
850 struct dpni_rsp_get_custom_tpid {
855 #define DPNI_RX_FS_DIST_ENABLE_SHIFT 0
856 #define DPNI_RX_FS_DIST_ENABLE_SIZE 1
857 struct dpni_cmd_set_rx_fs_dist {
861 uint16_t miss_flow_id;
863 uint64_t key_cfg_iova;
866 #define DPNI_RX_HASH_DIST_ENABLE_SHIFT 0
867 #define DPNI_RX_HASH_DIST_ENABLE_SIZE 1
868 struct dpni_cmd_set_rx_hash_dist {
873 uint64_t key_cfg_iova;
876 struct dpni_load_sw_sequence {
886 struct dpni_enable_sw_sequence {
893 uint8_t param_offset;
900 struct dpni_get_sw_sequence_layout {
903 uint64_t layout_iova;
906 struct dpni_sw_sequence_layout_entry {
909 uint8_t param_offset;
915 #endif /* _FSL_DPNI_CMD_H */