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 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_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 struct dpni_cmd_pool pool[8];
158 uint16_t buffer_size[8];
161 /* The enable indication is always the least significant bit */
162 #define DPNI_ENABLE_SHIFT 0
163 #define DPNI_ENABLE_SIZE 1
165 struct dpni_rsp_is_enabled {
169 struct dpni_cmd_set_irq_enable {
175 struct dpni_cmd_get_irq_enable {
180 struct dpni_rsp_get_irq_enable {
184 struct dpni_cmd_set_irq_mask {
189 struct dpni_cmd_get_irq_mask {
194 struct dpni_rsp_get_irq_mask {
198 struct dpni_cmd_get_irq_status {
203 struct dpni_rsp_get_irq_status {
207 struct dpni_cmd_clear_irq_status {
212 struct dpni_rsp_get_attr {
213 /* response word 0 */
217 uint8_t mac_filter_entries;
219 /* response word 1 */
220 uint8_t vlan_filter_entries;
226 /* response word 2 */
227 uint8_t qos_key_size;
229 uint16_t wriop_version;
233 #define DPNI_ERROR_ACTION_SHIFT 0
234 #define DPNI_ERROR_ACTION_SIZE 4
235 #define DPNI_FRAME_ANN_SHIFT 4
236 #define DPNI_FRAME_ANN_SIZE 1
238 struct dpni_cmd_set_errors_behavior {
240 /* from least significant bit: error_action:4, set_frame_annotation:1 */
244 /* There are 3 separate commands for configuring Rx, Tx and Tx confirmation
245 * buffer layouts, but they all share the same parameters.
246 * If one of the functions changes, below structure needs to be split.
249 #define DPNI_PASS_TS_SHIFT 0
250 #define DPNI_PASS_TS_SIZE 1
251 #define DPNI_PASS_PR_SHIFT 1
252 #define DPNI_PASS_PR_SIZE 1
253 #define DPNI_PASS_FS_SHIFT 2
254 #define DPNI_PASS_FS_SIZE 1
255 #define DPNI_PASS_SWO_SHIFT 3
256 #define DPNI_PASS_SWO_SIZE 1
258 struct dpni_cmd_get_buffer_layout {
262 struct dpni_rsp_get_buffer_layout {
263 /* response word 0 */
265 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
268 /* response word 1 */
269 uint16_t private_data_size;
275 struct dpni_cmd_set_buffer_layout {
280 /* from LSB: pass_timestamp:1, parser_result:1, frame_status:1 */
284 uint16_t private_data_size;
290 struct dpni_cmd_set_offload {
292 uint8_t dpni_offload;
296 struct dpni_cmd_get_offload {
298 uint8_t dpni_offload;
301 struct dpni_rsp_get_offload {
306 struct dpni_cmd_get_qdid {
310 struct dpni_rsp_get_qdid {
314 struct dpni_rsp_get_sp_info {
318 struct dpni_rsp_get_tx_data_offset {
319 uint16_t data_offset;
322 struct dpni_cmd_get_statistics {
327 struct dpni_rsp_get_statistics {
331 struct dpni_cmd_set_link_cfg {
336 uint64_t advertising;
339 #define DPNI_LINK_STATE_SHIFT 0
340 #define DPNI_LINK_STATE_SIZE 1
341 #define DPNI_STATE_VALID_SHIFT 1
342 #define DPNI_STATE_VALID_SIZE 1
344 struct dpni_rsp_get_link_state {
353 uint64_t advertising;
356 struct dpni_cmd_set_max_frame_length {
357 uint16_t max_frame_length;
360 struct dpni_rsp_get_max_frame_length {
361 uint16_t max_frame_length;
364 struct dpni_cmd_set_multicast_promisc {
368 struct dpni_rsp_get_multicast_promisc {
372 struct dpni_cmd_set_unicast_promisc {
376 struct dpni_rsp_get_unicast_promisc {
380 struct dpni_cmd_set_primary_mac_addr {
385 struct dpni_rsp_get_primary_mac_addr {
390 struct dpni_rsp_get_port_mac_addr {
395 struct dpni_cmd_add_mac_addr {
400 struct dpni_cmd_remove_mac_addr {
405 #define DPNI_UNICAST_FILTERS_SHIFT 0
406 #define DPNI_UNICAST_FILTERS_SIZE 1
407 #define DPNI_MULTICAST_FILTERS_SHIFT 1
408 #define DPNI_MULTICAST_FILTERS_SIZE 1
410 struct dpni_cmd_clear_mac_filters {
411 /* from LSB: unicast:1, multicast:1 */
415 struct dpni_cmd_enable_vlan_filter {
420 struct dpni_cmd_vlan_id {
425 #define DPNI_SEPARATE_GRP_SHIFT 0
426 #define DPNI_SEPARATE_GRP_SIZE 1
427 #define DPNI_MODE_1_SHIFT 0
428 #define DPNI_MODE_1_SIZE 4
429 #define DPNI_MODE_2_SHIFT 4
430 #define DPNI_MODE_2_SIZE 4
432 struct dpni_cmd_set_tx_priorities {
434 uint8_t prio_group_A;
435 uint8_t prio_group_B;
440 uint16_t delta_bandwidth[8];
443 #define DPNI_DIST_MODE_SHIFT 0
444 #define DPNI_DIST_MODE_SIZE 4
445 #define DPNI_MISS_ACTION_SHIFT 4
446 #define DPNI_MISS_ACTION_SIZE 4
447 #define DPNI_KEEP_HASH_KEY_SHIFT 7
448 #define DPNI_KEEP_HASH_KEY_SIZE 1
449 #define DPNI_KEEP_ENTRIES_SHIFT 6
450 #define DPNI_KEEP_ENTRIES_SIZE 1
452 struct dpni_cmd_set_rx_tc_dist {
455 /* from LSB: dist_mode:4, miss_action:4 */
459 uint8_t keep_hash_key;
460 uint16_t default_flow_id;
462 uint64_t key_cfg_iova;
465 struct dpni_cmd_get_queue {
471 #define DPNI_DEST_TYPE_SHIFT 0
472 #define DPNI_DEST_TYPE_SIZE 4
473 #define DPNI_CGID_VALID_SHIFT 5
474 #define DPNI_CGID_VALID_SIZE 1
475 #define DPNI_STASH_CTRL_SHIFT 6
476 #define DPNI_STASH_CTRL_SIZE 1
477 #define DPNI_HOLD_ACTIVE_SHIFT 7
478 #define DPNI_HOLD_ACTIVE_SIZE 1
480 struct dpni_rsp_get_queue {
481 /* response word 0 */
483 /* response word 1 */
488 * dest_type:4, pad:1, cgid_valid:1, flc_stash_ctrl:1, hold_active:1
491 /* response word 2 */
493 /* response word 3 */
494 uint64_t user_context;
495 /* response word 4 */
503 struct dpni_cmd_set_queue {
518 uint64_t user_context;
523 #define DPNI_DISCARD_ON_MISS_SHIFT 0
524 #define DPNI_DISCARD_ON_MISS_SIZE 1
525 #define DPNI_KEEP_QOS_ENTRIES_SHIFT 1
526 #define DPNI_KEEP_QOS_ENTRIES_SIZE 1
528 struct dpni_cmd_set_qos_table {
532 uint8_t discard_on_miss;
534 uint64_t key_cfg_iova;
537 struct dpni_cmd_add_qos_entry {
547 struct dpni_cmd_remove_qos_entry {
555 struct dpni_cmd_add_fs_entry {
566 struct dpni_cmd_remove_fs_entry {
575 struct dpni_cmd_clear_fs_entries {
580 #define DPNI_DROP_ENABLE_SHIFT 0
581 #define DPNI_DROP_ENABLE_SIZE 1
582 #define DPNI_DROP_UNITS_SHIFT 2
583 #define DPNI_DROP_UNITS_SIZE 2
585 struct dpni_early_drop {
586 /* from LSB: enable:1 units:2 */
590 uint8_t green_drop_probability;
592 uint64_t green_max_threshold;
593 uint64_t green_min_threshold;
595 uint8_t yellow_drop_probability;
597 uint64_t yellow_max_threshold;
598 uint64_t yellow_min_threshold;
600 uint8_t red_drop_probability;
602 uint64_t red_max_threshold;
603 uint64_t red_min_threshold;
606 struct dpni_cmd_early_drop {
610 uint64_t early_drop_iova;
613 struct dpni_rsp_get_api_version {
618 struct dpni_cmd_get_taildrop {
619 uint8_t congestion_point;
625 struct dpni_rsp_get_taildrop {
629 /* from LSB: enable:1 oal_lo:7 */
630 uint8_t enable_oal_lo;
631 /* from LSB: oal_hi:5 */
638 #define DPNI_OAL_LO_SHIFT 1
639 #define DPNI_OAL_LO_SIZE 7
640 #define DPNI_OAL_HI_SHIFT 0
641 #define DPNI_OAL_HI_SIZE 5
643 struct dpni_cmd_set_taildrop {
645 uint8_t congestion_point;
651 /* from LSB: enable:1 oal_lo:7 */
652 uint8_t enable_oal_lo;
653 /* from LSB: oal_hi:5 */
660 struct dpni_tx_confirmation_mode {
662 uint8_t confirmation_mode;
665 #define DPNI_DEST_TYPE_SHIFT 0
666 #define DPNI_DEST_TYPE_SIZE 4
667 #define DPNI_CONG_UNITS_SHIFT 4
668 #define DPNI_CONG_UNITS_SIZE 2
670 struct dpni_cmd_set_congestion_notification {
674 uint8_t congestion_point;
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_get_congestion_notification {
692 uint8_t congestion_point;
696 struct dpni_rsp_get_congestion_notification {
699 uint16_t notification_mode;
700 uint8_t dest_priority;
701 /* from LSB: dest_type: 4 units:2 */
703 uint64_t message_iova;
704 uint64_t message_ctx;
705 uint32_t threshold_entry;
706 uint32_t threshold_exit;
709 struct dpni_cmd_set_opr {
722 struct dpni_cmd_get_opr {
728 #define DPNI_RIP_SHIFT 0
729 #define DPNI_RIP_SIZE 1
730 #define DPNI_OPR_ENABLE_SHIFT 1
731 #define DPNI_OPR_ENABLE_SIZE 1
732 #define DPNI_TSEQ_NLIS_SHIFT 0
733 #define DPNI_TSEQ_NLIS_SIZE 1
734 #define DPNI_HSEQ_NLIS_SHIFT 0
735 #define DPNI_HSEQ_NLIS_SIZE 1
737 struct dpni_rsp_get_opr {
739 /* from LSB: rip:1 enable:1 */
768 struct dpni_cmd_add_custom_tpid {
773 struct dpni_cmd_remove_custom_tpid {
778 struct dpni_rsp_get_custom_tpid {
783 #define DPNI_RX_FS_DIST_ENABLE_SHIFT 0
784 #define DPNI_RX_FS_DIST_ENABLE_SIZE 1
785 struct dpni_cmd_set_rx_fs_dist {
789 uint16_t miss_flow_id;
791 uint64_t key_cfg_iova;
794 #define DPNI_RX_HASH_DIST_ENABLE_SHIFT 0
795 #define DPNI_RX_HASH_DIST_ENABLE_SIZE 1
796 struct dpni_cmd_set_rx_hash_dist {
801 uint64_t key_cfg_iova;
804 struct dpni_load_sw_sequence {
814 struct dpni_enable_sw_sequence {
821 uint8_t param_offset;
828 struct dpni_get_sw_sequence_layout {
831 uint64_t layout_iova;
834 struct dpni_sw_sequence_layout_entry {
837 uint8_t param_offset;
843 #endif /* _FSL_DPNI_CMD_H */