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 9
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_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_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_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;
138 struct dpni_cmd_destroy {
142 #define DPNI_BACKUP_POOL(val, order) (((val) & 0x1) << (order))
144 struct dpni_cmd_pool {
146 uint8_t priority_mask;
150 struct dpni_cmd_set_pools {
152 uint8_t backup_pool_mask;
154 struct dpni_cmd_pool pool[8];
155 uint16_t buffer_size[8];
158 /* The enable indication is always the least significant bit */
159 #define DPNI_ENABLE_SHIFT 0
160 #define DPNI_ENABLE_SIZE 1
162 struct dpni_rsp_is_enabled {
166 struct dpni_cmd_set_irq_enable {
172 struct dpni_cmd_get_irq_enable {
177 struct dpni_rsp_get_irq_enable {
181 struct dpni_cmd_set_irq_mask {
186 struct dpni_cmd_get_irq_mask {
191 struct dpni_rsp_get_irq_mask {
195 struct dpni_cmd_get_irq_status {
200 struct dpni_rsp_get_irq_status {
204 struct dpni_cmd_clear_irq_status {
209 struct dpni_rsp_get_attr {
210 /* response word 0 */
214 uint8_t mac_filter_entries;
216 /* response word 1 */
217 uint8_t vlan_filter_entries;
223 /* response word 2 */
224 uint8_t qos_key_size;
226 uint16_t wriop_version;
230 #define DPNI_ERROR_ACTION_SHIFT 0
231 #define DPNI_ERROR_ACTION_SIZE 4
232 #define DPNI_FRAME_ANN_SHIFT 4
233 #define DPNI_FRAME_ANN_SIZE 1
235 struct dpni_cmd_set_errors_behavior {
237 /* from least significant bit: error_action:4, set_frame_annotation:1 */
241 /* There are 3 separate commands for configuring Rx, Tx and Tx confirmation
242 * buffer layouts, but they all share the same parameters.
243 * If one of the functions changes, below structure needs to be split.
246 #define DPNI_PASS_TS_SHIFT 0
247 #define DPNI_PASS_TS_SIZE 1
248 #define DPNI_PASS_PR_SHIFT 1
249 #define DPNI_PASS_PR_SIZE 1
250 #define DPNI_PASS_FS_SHIFT 2
251 #define DPNI_PASS_FS_SIZE 1
252 #define DPNI_PASS_SWO_SHIFT 3
253 #define DPNI_PASS_SWO_SIZE 1
255 struct dpni_cmd_get_buffer_layout {
259 struct dpni_rsp_get_buffer_layout {
260 /* response word 0 */
262 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
265 /* response word 1 */
266 uint16_t private_data_size;
272 struct dpni_cmd_set_buffer_layout {
277 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
281 uint16_t private_data_size;
287 struct dpni_cmd_set_offload {
289 uint8_t dpni_offload;
293 struct dpni_cmd_get_offload {
295 uint8_t dpni_offload;
298 struct dpni_rsp_get_offload {
303 struct dpni_cmd_get_qdid {
307 struct dpni_rsp_get_qdid {
311 struct dpni_rsp_get_sp_info {
315 struct dpni_rsp_get_tx_data_offset {
316 uint16_t data_offset;
319 struct dpni_cmd_get_statistics {
324 struct dpni_rsp_get_statistics {
328 struct dpni_cmd_set_link_cfg {
333 uint64_t advertising;
336 #define DPNI_LINK_STATE_SHIFT 0
337 #define DPNI_LINK_STATE_SIZE 1
338 #define DPNI_STATE_VALID_SHIFT 1
339 #define DPNI_STATE_VALID_SIZE 1
341 struct dpni_rsp_get_link_state {
350 uint64_t advertising;
353 struct dpni_cmd_set_max_frame_length {
354 uint16_t max_frame_length;
357 struct dpni_rsp_get_max_frame_length {
358 uint16_t max_frame_length;
361 struct dpni_cmd_set_multicast_promisc {
365 struct dpni_rsp_get_multicast_promisc {
369 struct dpni_cmd_set_unicast_promisc {
373 struct dpni_rsp_get_unicast_promisc {
377 struct dpni_cmd_set_primary_mac_addr {
382 struct dpni_rsp_get_primary_mac_addr {
387 struct dpni_rsp_get_port_mac_addr {
392 struct dpni_cmd_add_mac_addr {
397 struct dpni_cmd_remove_mac_addr {
402 #define DPNI_UNICAST_FILTERS_SHIFT 0
403 #define DPNI_UNICAST_FILTERS_SIZE 1
404 #define DPNI_MULTICAST_FILTERS_SHIFT 1
405 #define DPNI_MULTICAST_FILTERS_SIZE 1
407 struct dpni_cmd_clear_mac_filters {
408 /* from LSB: unicast:1, multicast:1 */
412 struct dpni_cmd_enable_vlan_filter {
417 struct dpni_cmd_vlan_id {
422 #define DPNI_SEPARATE_GRP_SHIFT 0
423 #define DPNI_SEPARATE_GRP_SIZE 1
424 #define DPNI_MODE_1_SHIFT 0
425 #define DPNI_MODE_1_SIZE 4
426 #define DPNI_MODE_2_SHIFT 4
427 #define DPNI_MODE_2_SIZE 4
429 struct dpni_cmd_set_tx_priorities {
431 uint8_t prio_group_A;
432 uint8_t prio_group_B;
437 uint16_t delta_bandwidth[8];
440 #define DPNI_DIST_MODE_SHIFT 0
441 #define DPNI_DIST_MODE_SIZE 4
442 #define DPNI_MISS_ACTION_SHIFT 4
443 #define DPNI_MISS_ACTION_SIZE 4
444 #define DPNI_KEEP_HASH_KEY_SHIFT 7
445 #define DPNI_KEEP_HASH_KEY_SIZE 1
446 #define DPNI_KEEP_ENTRIES_SHIFT 6
447 #define DPNI_KEEP_ENTRIES_SIZE 1
449 struct dpni_cmd_set_rx_tc_dist {
452 /* from LSB: dist_mode:4, miss_action:4 */
456 uint8_t keep_hash_key;
457 uint16_t default_flow_id;
459 uint64_t key_cfg_iova;
462 struct dpni_cmd_get_queue {
468 #define DPNI_DEST_TYPE_SHIFT 0
469 #define DPNI_DEST_TYPE_SIZE 4
470 #define DPNI_CGID_VALID_SHIFT 5
471 #define DPNI_CGID_VALID_SIZE 1
472 #define DPNI_STASH_CTRL_SHIFT 6
473 #define DPNI_STASH_CTRL_SIZE 1
474 #define DPNI_HOLD_ACTIVE_SHIFT 7
475 #define DPNI_HOLD_ACTIVE_SIZE 1
477 struct dpni_rsp_get_queue {
478 /* response word 0 */
480 /* response word 1 */
485 * dest_type:4, pad:1, cgid_valid:1, flc_stash_ctrl:1, hold_active:1
488 /* response word 2 */
490 /* response word 3 */
491 uint64_t user_context;
492 /* response word 4 */
500 struct dpni_cmd_set_queue {
515 uint64_t user_context;
520 #define DPNI_DISCARD_ON_MISS_SHIFT 0
521 #define DPNI_DISCARD_ON_MISS_SIZE 1
522 #define DPNI_KEEP_QOS_ENTRIES_SHIFT 1
523 #define DPNI_KEEP_QOS_ENTRIES_SIZE 1
525 struct dpni_cmd_set_qos_table {
529 uint8_t discard_on_miss;
531 uint64_t key_cfg_iova;
534 struct dpni_cmd_add_qos_entry {
544 struct dpni_cmd_remove_qos_entry {
552 struct dpni_cmd_add_fs_entry {
563 struct dpni_cmd_remove_fs_entry {
572 struct dpni_cmd_clear_fs_entries {
577 #define DPNI_DROP_ENABLE_SHIFT 0
578 #define DPNI_DROP_ENABLE_SIZE 1
579 #define DPNI_DROP_UNITS_SHIFT 2
580 #define DPNI_DROP_UNITS_SIZE 2
582 struct dpni_early_drop {
583 /* from LSB: enable:1 units:2 */
587 uint8_t green_drop_probability;
589 uint64_t green_max_threshold;
590 uint64_t green_min_threshold;
592 uint8_t yellow_drop_probability;
594 uint64_t yellow_max_threshold;
595 uint64_t yellow_min_threshold;
597 uint8_t red_drop_probability;
599 uint64_t red_max_threshold;
600 uint64_t red_min_threshold;
603 struct dpni_cmd_early_drop {
607 uint64_t early_drop_iova;
610 struct dpni_rsp_get_api_version {
615 struct dpni_cmd_get_taildrop {
616 uint8_t congestion_point;
622 struct dpni_rsp_get_taildrop {
626 /* from LSB: enable:1 oal_lo:7 */
627 uint8_t enable_oal_lo;
628 /* from LSB: oal_hi:5 */
635 #define DPNI_OAL_LO_SHIFT 1
636 #define DPNI_OAL_LO_SIZE 7
637 #define DPNI_OAL_HI_SHIFT 0
638 #define DPNI_OAL_HI_SIZE 5
640 struct dpni_cmd_set_taildrop {
642 uint8_t congestion_point;
648 /* from LSB: enable:1 oal_lo:7 */
649 uint8_t enable_oal_lo;
650 /* from LSB: oal_hi:5 */
657 struct dpni_tx_confirmation_mode {
659 uint8_t confirmation_mode;
662 #define DPNI_DEST_TYPE_SHIFT 0
663 #define DPNI_DEST_TYPE_SIZE 4
664 #define DPNI_CONG_UNITS_SHIFT 4
665 #define DPNI_CONG_UNITS_SIZE 2
667 struct dpni_cmd_set_congestion_notification {
671 uint8_t congestion_point;
675 uint16_t notification_mode;
676 uint8_t dest_priority;
677 /* from LSB: dest_type: 4 units:2 */
679 uint64_t message_iova;
680 uint64_t message_ctx;
681 uint32_t threshold_entry;
682 uint32_t threshold_exit;
685 struct dpni_cmd_get_congestion_notification {
689 uint8_t congestion_point;
693 struct dpni_rsp_get_congestion_notification {
696 uint16_t notification_mode;
697 uint8_t dest_priority;
698 /* from LSB: dest_type: 4 units:2 */
700 uint64_t message_iova;
701 uint64_t message_ctx;
702 uint32_t threshold_entry;
703 uint32_t threshold_exit;
706 struct dpni_cmd_set_opr {
719 struct dpni_cmd_get_opr {
725 #define DPNI_RIP_SHIFT 0
726 #define DPNI_RIP_SIZE 1
727 #define DPNI_OPR_ENABLE_SHIFT 1
728 #define DPNI_OPR_ENABLE_SIZE 1
729 #define DPNI_TSEQ_NLIS_SHIFT 0
730 #define DPNI_TSEQ_NLIS_SIZE 1
731 #define DPNI_HSEQ_NLIS_SHIFT 0
732 #define DPNI_HSEQ_NLIS_SIZE 1
734 struct dpni_rsp_get_opr {
736 /* from LSB: rip:1 enable:1 */
765 struct dpni_cmd_add_custom_tpid {
770 struct dpni_cmd_remove_custom_tpid {
775 struct dpni_rsp_get_custom_tpid {
780 #define DPNI_RX_FS_DIST_ENABLE_SHIFT 0
781 #define DPNI_RX_FS_DIST_ENABLE_SIZE 1
782 struct dpni_cmd_set_rx_fs_dist {
786 uint16_t miss_flow_id;
788 uint64_t key_cfg_iova;
791 #define DPNI_RX_HASH_DIST_ENABLE_SHIFT 0
792 #define DPNI_RX_HASH_DIST_ENABLE_SIZE 1
793 struct dpni_cmd_set_rx_hash_dist {
798 uint64_t key_cfg_iova;
802 #endif /* _FSL_DPNI_CMD_H */