1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2013-2016 Freescale Semiconductor Inc.
4 * Copyright 2016-2019 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_QOS_TBL DPNI_CMD_V2(0x240)
73 #define DPNI_CMDID_ADD_QOS_ENT DPNI_CMD_V2(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_V3(0x25D)
81 #define DPNI_CMDID_RESET_STATISTICS DPNI_CMD(0x25E)
82 #define DPNI_CMDID_GET_QUEUE DPNI_CMD_V2(0x25F)
83 #define DPNI_CMDID_SET_QUEUE DPNI_CMD_V2(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_V2(0x267)
93 #define DPNI_CMDID_GET_CONGESTION_NOTIFICATION DPNI_CMD_V2(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_LOAD_SW_SEQUENCE DPNI_CMD(0x270)
101 #define DPNI_CMDID_ENABLE_SW_SEQUENCE DPNI_CMD(0x271)
102 #define DPNI_CMDID_GET_SW_SEQUENCE_LAYOUT DPNI_CMD(0x272)
103 #define DPNI_CMDID_SET_OPR DPNI_CMD(0x26e)
104 #define DPNI_CMDID_GET_OPR DPNI_CMD(0x26f)
105 #define DPNI_CMDID_SET_RX_FS_DIST DPNI_CMD(0x273)
106 #define DPNI_CMDID_SET_RX_HASH_DIST DPNI_CMD(0x274)
107 #define DPNI_CMDID_ADD_CUSTOM_TPID DPNI_CMD(0x275)
108 #define DPNI_CMDID_REMOVE_CUSTOM_TPID DPNI_CMD(0x276)
109 #define DPNI_CMDID_GET_CUSTOM_TPID DPNI_CMD(0x277)
111 /* Macros for accessing command fields smaller than 1byte */
112 #define DPNI_MASK(field) \
113 GENMASK(DPNI_##field##_SHIFT + DPNI_##field##_SIZE - 1, \
114 DPNI_##field##_SHIFT)
115 #define dpni_set_field(var, field, val) \
116 ((var) |= (((val) << DPNI_##field##_SHIFT) & DPNI_MASK(field)))
117 #define dpni_get_field(var, field) \
118 (((var) & DPNI_MASK(field)) >> DPNI_##field##_SHIFT)
120 #pragma pack(push, 1)
121 struct dpni_cmd_open {
125 struct dpni_cmd_create {
129 uint8_t mac_filter_entries;
131 uint8_t vlan_filter_entries;
141 struct dpni_cmd_destroy {
145 #define DPNI_BACKUP_POOL(val, order) (((val) & 0x1) << (order))
147 struct dpni_cmd_pool {
149 uint8_t priority_mask;
153 struct dpni_cmd_set_pools {
155 uint8_t backup_pool_mask;
157 uint8_t pool_options;
158 struct dpni_cmd_pool pool[8];
159 uint16_t buffer_size[8];
162 /* The enable indication is always the least significant bit */
163 #define DPNI_ENABLE_SHIFT 0
164 #define DPNI_ENABLE_SIZE 1
166 struct dpni_rsp_is_enabled {
170 struct dpni_cmd_set_irq_enable {
176 struct dpni_cmd_get_irq_enable {
181 struct dpni_rsp_get_irq_enable {
185 struct dpni_cmd_set_irq_mask {
190 struct dpni_cmd_get_irq_mask {
195 struct dpni_rsp_get_irq_mask {
199 struct dpni_cmd_get_irq_status {
204 struct dpni_rsp_get_irq_status {
208 struct dpni_cmd_clear_irq_status {
213 struct dpni_rsp_get_attr {
214 /* response word 0 */
218 uint8_t mac_filter_entries;
220 /* response word 1 */
221 uint8_t vlan_filter_entries;
227 /* response word 2 */
228 uint8_t qos_key_size;
230 uint16_t wriop_version;
234 #define DPNI_ERROR_ACTION_SHIFT 0
235 #define DPNI_ERROR_ACTION_SIZE 4
236 #define DPNI_FRAME_ANN_SHIFT 4
237 #define DPNI_FRAME_ANN_SIZE 1
239 struct dpni_cmd_set_errors_behavior {
241 /* from least significant bit: error_action:4, set_frame_annotation:1 */
245 /* There are 3 separate commands for configuring Rx, Tx and Tx confirmation
246 * buffer layouts, but they all share the same parameters.
247 * If one of the functions changes, below structure needs to be split.
250 #define DPNI_PASS_TS_SHIFT 0
251 #define DPNI_PASS_TS_SIZE 1
252 #define DPNI_PASS_PR_SHIFT 1
253 #define DPNI_PASS_PR_SIZE 1
254 #define DPNI_PASS_FS_SHIFT 2
255 #define DPNI_PASS_FS_SIZE 1
256 #define DPNI_PASS_SWO_SHIFT 3
257 #define DPNI_PASS_SWO_SIZE 1
259 struct dpni_cmd_get_buffer_layout {
263 struct dpni_rsp_get_buffer_layout {
264 /* response word 0 */
266 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
269 /* response word 1 */
270 uint16_t private_data_size;
276 struct dpni_cmd_set_buffer_layout {
281 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
285 uint16_t private_data_size;
291 struct dpni_cmd_set_offload {
293 uint8_t dpni_offload;
297 struct dpni_cmd_get_offload {
299 uint8_t dpni_offload;
302 struct dpni_rsp_get_offload {
307 struct dpni_cmd_get_qdid {
311 struct dpni_rsp_get_qdid {
315 struct dpni_rsp_get_sp_info {
319 struct dpni_rsp_get_tx_data_offset {
320 uint16_t data_offset;
323 struct dpni_cmd_get_statistics {
328 struct dpni_rsp_get_statistics {
332 struct dpni_cmd_set_link_cfg {
337 uint64_t advertising;
340 #define DPNI_LINK_STATE_SHIFT 0
341 #define DPNI_LINK_STATE_SIZE 1
342 #define DPNI_STATE_VALID_SHIFT 1
343 #define DPNI_STATE_VALID_SIZE 1
345 struct dpni_rsp_get_link_state {
354 uint64_t advertising;
357 struct dpni_cmd_set_max_frame_length {
358 uint16_t max_frame_length;
361 struct dpni_rsp_get_max_frame_length {
362 uint16_t max_frame_length;
365 struct dpni_cmd_set_multicast_promisc {
369 struct dpni_rsp_get_multicast_promisc {
373 struct dpni_cmd_set_unicast_promisc {
377 struct dpni_rsp_get_unicast_promisc {
381 struct dpni_cmd_set_primary_mac_addr {
386 struct dpni_rsp_get_primary_mac_addr {
391 struct dpni_rsp_get_port_mac_addr {
396 #define DPNI_MAC_SET_QUEUE_ACTION 1
398 struct dpni_cmd_add_mac_addr {
406 struct dpni_cmd_remove_mac_addr {
411 #define DPNI_UNICAST_FILTERS_SHIFT 0
412 #define DPNI_UNICAST_FILTERS_SIZE 1
413 #define DPNI_MULTICAST_FILTERS_SHIFT 1
414 #define DPNI_MULTICAST_FILTERS_SIZE 1
416 struct dpni_cmd_clear_mac_filters {
417 /* from LSB: unicast:1, multicast:1 */
421 struct dpni_cmd_enable_vlan_filter {
426 #define DPNI_VLAN_SET_QUEUE_ACTION 1
428 struct dpni_cmd_vlan_id {
436 #define DPNI_SEPARATE_GRP_SHIFT 0
437 #define DPNI_SEPARATE_GRP_SIZE 1
438 #define DPNI_MODE_1_SHIFT 0
439 #define DPNI_MODE_1_SIZE 4
440 #define DPNI_MODE_2_SHIFT 4
441 #define DPNI_MODE_2_SIZE 4
443 struct dpni_cmd_set_tx_priorities {
445 uint8_t prio_group_A;
446 uint8_t prio_group_B;
451 uint16_t delta_bandwidth[8];
454 #define DPNI_DIST_MODE_SHIFT 0
455 #define DPNI_DIST_MODE_SIZE 4
456 #define DPNI_MISS_ACTION_SHIFT 4
457 #define DPNI_MISS_ACTION_SIZE 4
458 #define DPNI_KEEP_HASH_KEY_SHIFT 7
459 #define DPNI_KEEP_HASH_KEY_SIZE 1
460 #define DPNI_KEEP_ENTRIES_SHIFT 6
461 #define DPNI_KEEP_ENTRIES_SIZE 1
463 struct dpni_cmd_set_rx_tc_dist {
466 /* from LSB: dist_mode:4, miss_action:4 */
470 uint8_t keep_hash_key;
471 uint16_t default_flow_id;
473 uint64_t key_cfg_iova;
476 struct dpni_cmd_get_queue {
482 #define DPNI_DEST_TYPE_SHIFT 0
483 #define DPNI_DEST_TYPE_SIZE 4
484 #define DPNI_CGID_VALID_SHIFT 5
485 #define DPNI_CGID_VALID_SIZE 1
486 #define DPNI_STASH_CTRL_SHIFT 6
487 #define DPNI_STASH_CTRL_SIZE 1
488 #define DPNI_HOLD_ACTIVE_SHIFT 7
489 #define DPNI_HOLD_ACTIVE_SIZE 1
491 struct dpni_rsp_get_queue {
492 /* response word 0 */
494 /* response word 1 */
499 * dest_type:4, pad:1, cgid_valid:1, flc_stash_ctrl:1, hold_active:1
502 /* response word 2 */
504 /* response word 3 */
505 uint64_t user_context;
506 /* response word 4 */
514 struct dpni_cmd_set_queue {
529 uint64_t user_context;
534 #define DPNI_DISCARD_ON_MISS_SHIFT 0
535 #define DPNI_DISCARD_ON_MISS_SIZE 1
536 #define DPNI_KEEP_QOS_ENTRIES_SHIFT 1
537 #define DPNI_KEEP_QOS_ENTRIES_SIZE 1
539 struct dpni_cmd_set_qos_table {
543 uint8_t discard_on_miss;
545 uint64_t key_cfg_iova;
548 #define DPNI_QOS_OPT_SET_TC_ONLY 0x0
549 #define DPNI_QOS_OPT_SET_FLOW_ID 0x1
551 struct dpni_cmd_add_qos_entry {
562 struct dpni_cmd_remove_qos_entry {
570 struct dpni_cmd_add_fs_entry {
581 struct dpni_cmd_remove_fs_entry {
590 struct dpni_cmd_clear_fs_entries {
595 #define DPNI_DROP_ENABLE_SHIFT 0
596 #define DPNI_DROP_ENABLE_SIZE 1
597 #define DPNI_DROP_UNITS_SHIFT 2
598 #define DPNI_DROP_UNITS_SIZE 2
600 struct dpni_early_drop {
601 /* from LSB: enable:1 units:2 */
605 uint8_t green_drop_probability;
607 uint64_t green_max_threshold;
608 uint64_t green_min_threshold;
610 uint8_t yellow_drop_probability;
612 uint64_t yellow_max_threshold;
613 uint64_t yellow_min_threshold;
615 uint8_t red_drop_probability;
617 uint64_t red_max_threshold;
618 uint64_t red_min_threshold;
621 struct dpni_cmd_early_drop {
625 uint64_t early_drop_iova;
628 struct dpni_rsp_get_api_version {
633 struct dpni_cmd_get_taildrop {
634 uint8_t congestion_point;
640 struct dpni_rsp_get_taildrop {
644 /* from LSB: enable:1 oal_lo:7 */
645 uint8_t enable_oal_lo;
646 /* from LSB: oal_hi:5 */
653 #define DPNI_OAL_LO_SHIFT 1
654 #define DPNI_OAL_LO_SIZE 7
655 #define DPNI_OAL_HI_SHIFT 0
656 #define DPNI_OAL_HI_SIZE 5
658 struct dpni_cmd_set_taildrop {
660 uint8_t congestion_point;
666 /* from LSB: enable:1 oal_lo:7 */
667 uint8_t enable_oal_lo;
668 /* from LSB: oal_hi:5 */
675 struct dpni_tx_confirmation_mode {
677 uint8_t confirmation_mode;
680 #define DPNI_DEST_TYPE_SHIFT 0
681 #define DPNI_DEST_TYPE_SIZE 4
682 #define DPNI_CONG_UNITS_SHIFT 4
683 #define DPNI_CONG_UNITS_SIZE 2
685 struct dpni_cmd_set_congestion_notification {
689 uint8_t congestion_point;
693 uint16_t notification_mode;
694 uint8_t dest_priority;
695 /* from LSB: dest_type: 4 units:2 */
697 uint64_t message_iova;
698 uint64_t message_ctx;
699 uint32_t threshold_entry;
700 uint32_t threshold_exit;
703 struct dpni_cmd_get_congestion_notification {
707 uint8_t congestion_point;
711 struct dpni_rsp_get_congestion_notification {
714 uint16_t notification_mode;
715 uint8_t dest_priority;
716 /* from LSB: dest_type: 4 units:2 */
718 uint64_t message_iova;
719 uint64_t message_ctx;
720 uint32_t threshold_entry;
721 uint32_t threshold_exit;
724 struct dpni_cmd_set_opr {
737 struct dpni_cmd_get_opr {
743 #define DPNI_RIP_SHIFT 0
744 #define DPNI_RIP_SIZE 1
745 #define DPNI_OPR_ENABLE_SHIFT 1
746 #define DPNI_OPR_ENABLE_SIZE 1
747 #define DPNI_TSEQ_NLIS_SHIFT 0
748 #define DPNI_TSEQ_NLIS_SIZE 1
749 #define DPNI_HSEQ_NLIS_SHIFT 0
750 #define DPNI_HSEQ_NLIS_SIZE 1
752 struct dpni_rsp_get_opr {
754 /* from LSB: rip:1 enable:1 */
783 struct dpni_cmd_add_custom_tpid {
788 struct dpni_cmd_remove_custom_tpid {
793 struct dpni_rsp_get_custom_tpid {
798 #define DPNI_RX_FS_DIST_ENABLE_SHIFT 0
799 #define DPNI_RX_FS_DIST_ENABLE_SIZE 1
800 struct dpni_cmd_set_rx_fs_dist {
804 uint16_t miss_flow_id;
806 uint64_t key_cfg_iova;
809 #define DPNI_RX_HASH_DIST_ENABLE_SHIFT 0
810 #define DPNI_RX_HASH_DIST_ENABLE_SIZE 1
811 struct dpni_cmd_set_rx_hash_dist {
816 uint64_t key_cfg_iova;
819 struct dpni_load_sw_sequence {
829 struct dpni_enable_sw_sequence {
836 uint8_t param_offset;
843 struct dpni_get_sw_sequence_layout {
846 uint64_t layout_iova;
849 struct dpni_sw_sequence_layout_entry {
852 uint8_t param_offset;
858 #endif /* _FSL_DPNI_CMD_H */