1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2013-2016 Freescale Semiconductor Inc.
4 * Copyright 2016-2021 NXP
11 #include <fsl_dpopr.h>
16 * Data Path Network Interface API
17 * Contains initialization APIs and runtime control APIs for DPNI
20 /** General DPNI macros */
23 * Maximum size of a key
25 #define DPNI_MAX_KEY_SIZE 56
28 * Maximum number of traffic classes
32 * Maximum number of buffer pools per DPNI
34 #define DPNI_MAX_DPBP 8
36 * Maximum number of storage-profiles per DPNI
41 * All traffic classes considered; see dpni_set_queue()
43 #define DPNI_ALL_TCS (uint8_t)(-1)
45 * All flows within traffic class considered; see dpni_set_queue()
47 #define DPNI_ALL_TC_FLOWS (uint16_t)(-1)
50 * Tx traffic is always released to a buffer pool on transmit, there are no
51 * resources allocated to have the frames confirmed back to the source after
54 #define DPNI_OPT_TX_FRM_RELEASE 0x000001
56 * Disables support for MAC address filtering for addresses other than primary
57 * MAC address. This affects both unicast and multicast. Promiscuous mode can
58 * still be enabled/disabled for both unicast and multicast. If promiscuous mode
59 * is disabled, only traffic matching the primary MAC address will be accepted.
61 #define DPNI_OPT_NO_MAC_FILTER 0x000002
63 * Allocate policers for this DPNI. They can be used to rate-limit traffic per
64 * traffic class (TC) basis.
66 #define DPNI_OPT_HAS_POLICING 0x000004
68 * Congestion can be managed in several ways, allowing the buffer pool to
69 * deplete on ingress, taildrop on each queue or use congestion groups for sets
70 * of queues. If set, it configures a single congestion groups across all TCs.
71 * If reset, a congestion group is allocated for each TC. Only relevant if the
72 * DPNI has multiple traffic classes.
74 #define DPNI_OPT_SHARED_CONGESTION 0x000008
76 * Enables TCAM for Flow Steering and QoS look-ups. If not specified, all
77 * look-ups are exact match. Note that TCAM is not available on LS1088 and its
78 * variants. Setting this bit on these SoCs will trigger an error.
80 #define DPNI_OPT_HAS_KEY_MASKING 0x000010
82 * Disables the flow steering table.
84 #define DPNI_OPT_NO_FS 0x000020
87 * Enable the Order Restoration support
89 #define DPNI_OPT_HAS_OPR 0x000040
92 * Order Point Records are shared for the entire TC
94 #define DPNI_OPT_OPR_PER_TC 0x000080
96 * All Tx traffic classes will use a single sender (ignore num_queueus for tx)
98 #define DPNI_OPT_SINGLE_SENDER 0x000100
100 * Define a custom number of congestion groups
102 #define DPNI_OPT_CUSTOM_CG 0x000200
104 * Define a custom number of order point records
106 #define DPNI_OPT_CUSTOM_OPR 0x000400
108 * Hash key is shared between all traffic classes
110 #define DPNI_OPT_SHARED_HASH_KEY 0x000800
112 * Flow steering table is shared between all traffic classes
114 #define DPNI_OPT_SHARED_FS 0x001000
116 * Software sequence maximum layout size
118 #define DPNI_SW_SEQUENCE_LAYOUT_SIZE 33
120 int dpni_open(struct fsl_mc_io *mc_io,
125 int dpni_close(struct fsl_mc_io *mc_io,
130 * struct dpni_cfg - Structure representing DPNI configuration
131 * @options: Any combination of the following options:
132 * DPNI_OPT_TX_FRM_RELEASE
133 * DPNI_OPT_NO_MAC_FILTER
134 * DPNI_OPT_HAS_POLICING
135 * DPNI_OPT_SHARED_CONGESTION
136 * DPNI_OPT_HAS_KEY_MASKING
138 * DPNI_OPT_SINGLE_SENDER
139 * @fs_entries: Number of entries in the flow steering table.
140 * This table is used to select the ingress queue for
141 * ingress traffic, targeting a GPP core or another.
142 * In addition it can be used to discard traffic that
143 * matches the set rule. It is either an exact match table
144 * or a TCAM table, depending on DPNI_OPT_ HAS_KEY_MASKING
145 * bit in OPTIONS field. This field is ignored if
146 * DPNI_OPT_NO_FS bit is set in OPTIONS field. Otherwise,
147 * value 0 defaults to 64. Maximum supported value is 1024.
148 * Note that the total number of entries is limited on the
149 * SoC to as low as 512 entries if TCAM is used.
150 * @vlan_filter_entries: Number of entries in the VLAN address filtering
151 * table. This is an exact match table used to filter
152 * ingress traffic based on VLAN IDs. Value 0 disables VLAN
153 * filtering. Maximum supported value is 16.
154 * @mac_filter_entries: Number of entries in the MAC address filtering
155 * table. This is an exact match table and allows both
156 * unicast and multicast entries. The primary MAC address
157 * of the network interface is not part of this table,
158 * this contains only entries in addition to it. This
159 * field is ignored if DPNI_OPT_ NO_MAC_FILTER is set in
160 * OPTIONS field. Otherwise, value 0 defaults to 80.
161 * Maximum supported value is 80.
162 * @num_queues: Number of Tx and Rx queues used for traffic
163 * distribution. This is orthogonal to QoS and is only
164 * used to distribute traffic to multiple GPP cores.
165 * This configuration affects the number of Tx queues
166 * (logical FQs, all associated with a single CEETM queue),
167 * Rx queues and Tx confirmation queues, if applicable.
168 * Value 0 defaults to one queue. Maximum supported value
170 * @num_tcs: Number of traffic classes (TCs), reserved for the DPNI.
171 * TCs can have different priority levels for the purpose
172 * of Tx scheduling (see DPNI_SET_TX_PRIORITIES), different
173 * BPs (DPNI_ SET_POOLS), policers. There are dedicated QM
174 * queues for traffic classes (including class queues on
175 * Tx). Value 0 defaults to one TC. Maximum supported value
176 * is 16. There are maximum 16 TCs for Tx and 8 TCs for Rx.
177 * When num_tcs>8 Tx will use this value but Rx will have
178 * only 8 traffic classes.
179 * @num_rx_tcs: if set to other value than zero represents number
180 * of TCs used for Rx. Maximum value is 8. If set to zero the
181 * number of Rx TCs will be initialized with the value provided
182 * in num_tcs parameter.
183 * @qos_entries: Number of entries in the QoS classification table. This
184 * table is used to select the TC for ingress traffic. It
185 * is either an exact match or a TCAM table, depending on
186 * DPNI_OPT_ HAS_KEY_MASKING bit in OPTIONS field. This
187 * field is ignored if the DPNI has a single TC. Otherwise,
188 * a value of 0 defaults to 64. Maximum supported value
194 uint8_t vlan_filter_entries;
195 uint8_t mac_filter_entries;
202 uint8_t dist_key_size;
205 int dpni_create(struct fsl_mc_io *mc_io,
208 const struct dpni_cfg *cfg,
211 int dpni_destroy(struct fsl_mc_io *mc_io,
217 * struct dpni_pools_cfg - Structure representing buffer pools configuration
218 * @num_dpbp: Number of DPBPs
219 * @pool_options: Buffer assignment options
220 * This field is a combination of DPNI_POOL_ASSOC_flags
221 * @pools: Array of buffer pools parameters; The number of valid entries
222 * must match 'num_dpbp' value
223 * @pools.dpbp_id: DPBP object ID
224 * @pools.priority: Priority mask that indicates TC's used with this buffer.
225 * I set to 0x00 MC will assume value 0xff.
226 * @pools.buffer_size: Buffer size
227 * @pools.backup_pool: Backup pool
230 #define DPNI_POOL_ASSOC_QPRI 0
231 #define DPNI_POOL_ASSOC_QDBIN 1
233 struct dpni_pools_cfg {
235 uint8_t pool_options;
238 uint8_t priority_mask;
239 uint16_t buffer_size;
241 } pools[DPNI_MAX_DPBP];
244 int dpni_set_pools(struct fsl_mc_io *mc_io,
247 const struct dpni_pools_cfg *cfg);
249 int dpni_enable(struct fsl_mc_io *mc_io,
253 int dpni_disable(struct fsl_mc_io *mc_io,
257 int dpni_is_enabled(struct fsl_mc_io *mc_io,
262 int dpni_reset(struct fsl_mc_io *mc_io,
267 * DPNI IRQ Index and Events
273 #define DPNI_IRQ_INDEX 0
275 * IRQ event - indicates a change in link state
277 #define DPNI_IRQ_EVENT_LINK_CHANGED 0x00000001
279 int dpni_set_irq_enable(struct fsl_mc_io *mc_io,
285 int dpni_get_irq_enable(struct fsl_mc_io *mc_io,
291 int dpni_set_irq_mask(struct fsl_mc_io *mc_io,
297 int dpni_get_irq_mask(struct fsl_mc_io *mc_io,
303 int dpni_get_irq_status(struct fsl_mc_io *mc_io,
309 int dpni_clear_irq_status(struct fsl_mc_io *mc_io,
316 * struct dpni_attr - Structure representing DPNI attributes
317 * @options: Any combination of the following options:
318 * DPNI_OPT_TX_FRM_RELEASE
319 * DPNI_OPT_NO_MAC_FILTER
320 * DPNI_OPT_HAS_POLICING
321 * DPNI_OPT_SHARED_CONGESTION
322 * DPNI_OPT_HAS_KEY_MASKING
324 * @num_queues: Number of Tx and Rx queues used for traffic distribution.
325 * @num_rx_tcs: Number of RX traffic classes (TCs), reserved for the DPNI.
326 * @num_tx_tcs: Number of TX traffic classes (TCs), reserved for the DPNI.
327 * @mac_filter_entries: Number of entries in the MAC address filtering
329 * @vlan_filter_entries: Number of entries in the VLAN address filtering
331 * @qos_entries: Number of entries in the QoS classification table.
332 * @fs_entries: Number of entries in the flow steering table.
333 * @qos_key_size: Size, in bytes, of the QoS look-up key. Defining a key larger
334 * than this when adding QoS entries will result
336 * @fs_key_size: Size, in bytes, of the flow steering look-up key. Defining a
337 * key larger than this when composing the hash + FS key
338 * will result in an error.
339 * @wriop_version: Version of WRIOP HW block.
340 * The 3 version values are stored on 6, 5, 5 bits
343 * - 0x400 - WRIOP version 1.0.0, used on LS2080 and
345 * - 0x421 - WRIOP version 1.1.1, used on LS2088 and
347 * - 0x422 - WRIOP version 1.1.2, used on LS1088 and
349 * - 0xC00 - WRIOP version 3.0.0, used on LX2160 and
357 uint8_t mac_filter_entries;
358 uint8_t vlan_filter_entries;
361 uint8_t qos_key_size;
363 uint16_t wriop_version;
367 int dpni_get_attributes(struct fsl_mc_io *mc_io,
370 struct dpni_attr *attr);
377 * Discard error. When set all discarded frames in wriop will be enqueued to
378 * error queue. To be used in dpni_set_errors_behavior() only if error_action
379 * parameter is set to DPNI_ERROR_ACTION_SEND_TO_ERROR_QUEUE.
381 #define DPNI_ERROR_DISC 0x80000000
384 * Extract out of frame header error
386 #define DPNI_ERROR_MS 0x40000000
387 #define DPNI_ERROR_PTP 0x08000000
388 /* Ethernet multicast frame */
389 #define DPNI_ERROR_MC 0x04000000
390 /* Ethernet broadcast frame */
391 #define DPNI_ERROR_BC 0x02000000
392 #define DPNI_ERROR_KSE 0x00040000
393 #define DPNI_ERROR_EOFHE 0x00020000
394 #define DPNI_ERROR_MNLE 0x00010000
395 #define DPNI_ERROR_TIDE 0x00008000
396 #define DPNI_ERROR_PIEE 0x00004000
400 #define DPNI_ERROR_FLE 0x00002000
402 * Frame physical error
404 #define DPNI_ERROR_FPE 0x00001000
405 #define DPNI_ERROR_PTE 0x00000080
406 #define DPNI_ERROR_ISP 0x00000040
408 * Parsing header error
410 #define DPNI_ERROR_PHE 0x00000020
412 #define DPNI_ERROR_BLE 0x00000010
414 * Parser L3 checksum error
416 #define DPNI_ERROR_L3CV 0x00000008
418 #define DPNI_ERROR_L3CE 0x00000004
420 * Parser L4 checksum error
422 #define DPNI_ERROR_L4CV 0x00000002
424 #define DPNI_ERROR_L4CE 0x00000001
426 * enum dpni_error_action - Defines DPNI behavior for errors
427 * @DPNI_ERROR_ACTION_DISCARD: Discard the frame
428 * @DPNI_ERROR_ACTION_CONTINUE: Continue with the normal flow
429 * @DPNI_ERROR_ACTION_SEND_TO_ERROR_QUEUE: Send the frame to the error queue
431 enum dpni_error_action {
432 DPNI_ERROR_ACTION_DISCARD = 0,
433 DPNI_ERROR_ACTION_CONTINUE = 1,
434 DPNI_ERROR_ACTION_SEND_TO_ERROR_QUEUE = 2
438 * struct dpni_error_cfg - Structure representing DPNI errors treatment
439 * @errors: Errors mask; use 'DPNI_ERROR__<X>
440 * @error_action: The desired action for the errors mask
441 * @set_frame_annotation: Set to '1' to mark the errors in frame
442 * annotation status (FAS); relevant only
443 * for the non-discard action
445 struct dpni_error_cfg {
447 enum dpni_error_action error_action;
448 int set_frame_annotation;
451 int dpni_set_errors_behavior(struct fsl_mc_io *mc_io,
454 struct dpni_error_cfg *cfg);
457 * DPNI buffer layout modification options
461 * Select to modify the time-stamp setting
463 #define DPNI_BUF_LAYOUT_OPT_TIMESTAMP 0x00000001
465 * Select to modify the parser-result setting; not applicable for Tx
467 #define DPNI_BUF_LAYOUT_OPT_PARSER_RESULT 0x00000002
469 * Select to modify the frame-status setting
471 #define DPNI_BUF_LAYOUT_OPT_FRAME_STATUS 0x00000004
473 * Select to modify the private-data-size setting
475 #define DPNI_BUF_LAYOUT_OPT_PRIVATE_DATA_SIZE 0x00000008
477 * Select to modify the data-alignment setting
479 #define DPNI_BUF_LAYOUT_OPT_DATA_ALIGN 0x00000010
481 * Select to modify the data-head-room setting
483 #define DPNI_BUF_LAYOUT_OPT_DATA_HEAD_ROOM 0x00000020
485 * Select to modify the data-tail-room setting
487 #define DPNI_BUF_LAYOUT_OPT_DATA_TAIL_ROOM 0x00000040
489 * Select to modify the sw-opaque value setting
491 #define DPNI_BUF_LAYOUT_OPT_SW_OPAQUE 0x00000080
493 * Select to disable Scatter Gather and use single buffer
495 #define DPNI_BUF_LAYOUT_OPT_NO_SG 0x00000100
498 * struct dpni_buffer_layout - Structure representing DPNI buffer layout
499 * @options: Flags representing the suggested modifications to the
501 * Use any combination of 'DPNI_BUF_LAYOUT_OPT_<X>' flags
502 * @pass_timestamp: Pass timestamp value
503 * @pass_parser_result: Pass parser results
504 * @pass_frame_status: Pass frame status
505 * @private_data_size: Size kept for private data (in bytes)
506 * @data_align: Data alignment
507 * @data_head_room: Data head room
508 * @data_tail_room: Data tail room
510 struct dpni_buffer_layout {
513 int pass_parser_result;
514 int pass_frame_status;
516 uint16_t private_data_size;
518 uint16_t data_head_room;
519 uint16_t data_tail_room;
523 * enum dpni_queue_type - Identifies a type of queue targeted by the command
524 * @DPNI_QUEUE_RX: Rx queue
525 * @DPNI_QUEUE_TX: Tx queue
526 * @DPNI_QUEUE_TX_CONFIRM: Tx confirmation queue
527 * @DPNI_QUEUE_RX_ERR: Rx error queue
529 enum dpni_queue_type {
532 DPNI_QUEUE_TX_CONFIRM,
536 int dpni_get_buffer_layout(struct fsl_mc_io *mc_io,
539 enum dpni_queue_type qtype,
540 struct dpni_buffer_layout *layout);
542 int dpni_set_buffer_layout(struct fsl_mc_io *mc_io,
545 enum dpni_queue_type qtype,
546 const struct dpni_buffer_layout *layout);
549 * enum dpni_offload - Identifies a type of offload targeted by the command
550 * @DPNI_OFF_RX_L3_CSUM: Rx L3 checksum validation
551 * @DPNI_OFF_RX_L4_CSUM: Rx L4 checksum validation
552 * @DPNI_OFF_TX_L3_CSUM: Tx L3 checksum generation
553 * @DPNI_OFF_TX_L4_CSUM: Tx L4 checksum generation
554 * @DPNI_OPT_FLCTYPE_HASH: flow context will be generated by WRIOP for AIOP or
565 int dpni_set_offload(struct fsl_mc_io *mc_io,
568 enum dpni_offload type,
571 int dpni_get_offload(struct fsl_mc_io *mc_io,
574 enum dpni_offload type,
577 int dpni_get_qdid(struct fsl_mc_io *mc_io,
580 enum dpni_queue_type qtype,
583 int dpni_get_tx_data_offset(struct fsl_mc_io *mc_io,
586 uint16_t *data_offset);
588 #define DPNI_STATISTICS_CNT 7
591 * union dpni_statistics - Union describing the DPNI statistics
592 * @page_0: Page_0 statistics structure
593 * @page_0.ingress_all_frames: Ingress frame count
594 * @page_0.ingress_all_bytes: Ingress byte count
595 * @page_0.ingress_multicast_frames: Ingress multicast frame count
596 * @page_0.ingress_multicast_bytes: Ingress multicast byte count
597 * @page_0.ingress_broadcast_frames: Ingress broadcast frame count
598 * @page_0.ingress_broadcast_bytes: Ingress broadcast byte count
599 * @page_1: Page_1 statistics structure
600 * @page_1.egress_all_frames: Egress frame count
601 * @page_1.egress_all_bytes: Egress byte count
602 * @page_1.egress_multicast_frames: Egress multicast frame count
603 * @page_1.egress_multicast_bytes: Egress multicast byte count
604 * @page_1.egress_broadcast_frames: Egress broadcast frame count
605 * @page_1.egress_broadcast_bytes: Egress broadcast byte count
606 * @page_2: Page_2 statistics structure
607 * @page_2.ingress_filtered_frames: Ingress filtered frame count
608 * @page_2.ingress_discarded_frames: Ingress discarded frame count
609 * @page_2.ingress_nobuffer_discards: Ingress discarded frame count due to
611 * @page_2.egress_discarded_frames: Egress discarded frame count
612 * @page_2.egress_confirmed_frames: Egress confirmed frame count
613 * @page_3: Page_3 statistics structure with values for the selected TC
614 * @page_3.ceetm_dequeue_bytes: Cumulative count of the number of bytes dequeued
615 * @page_3.ceetm_dequeue_frames: Cumulative count of the number of frames
617 * @page_3.ceetm_reject_bytes: Cumulative count of the number of bytes in all
618 * frames whose enqueue was rejected
619 * @page_3.ceetm_reject_frames: Cumulative count of all frame enqueues rejected
620 * @page_4: congestion point drops for seleted TC
621 * @page_4.cgr_reject_frames: number of rejected frames due to congestion point
622 * @page_4.cgr_reject_bytes: number of rejected bytes due to congestion point
623 * @page_5: policer statistics per TC
624 * @page_5.policer_cnt_red: NUmber of red colored frames
625 * @page_5.policer_cnt_yellow: number of yellow colored frames
626 * @page_5.policer_cnt_green: number of green colored frames
627 * @page_5.policer_cnt_re_red: number of recolored red frames
628 * @page_5.policer_cnt_re_yellow: number of recolored yellow frames
629 * @page_6.tx_pending_frames_cnt: total number of frames pending in Tx queues
630 * @raw: raw statistics structure, used to index counters
632 union dpni_statistics {
634 uint64_t ingress_all_frames;
635 uint64_t ingress_all_bytes;
636 uint64_t ingress_multicast_frames;
637 uint64_t ingress_multicast_bytes;
638 uint64_t ingress_broadcast_frames;
639 uint64_t ingress_broadcast_bytes;
642 uint64_t egress_all_frames;
643 uint64_t egress_all_bytes;
644 uint64_t egress_multicast_frames;
645 uint64_t egress_multicast_bytes;
646 uint64_t egress_broadcast_frames;
647 uint64_t egress_broadcast_bytes;
650 uint64_t ingress_filtered_frames;
651 uint64_t ingress_discarded_frames;
652 uint64_t ingress_nobuffer_discards;
653 uint64_t egress_discarded_frames;
654 uint64_t egress_confirmed_frames;
657 uint64_t ceetm_dequeue_bytes;
658 uint64_t ceetm_dequeue_frames;
659 uint64_t ceetm_reject_bytes;
660 uint64_t ceetm_reject_frames;
663 uint64_t cgr_reject_frames;
664 uint64_t cgr_reject_bytes;
667 uint64_t policer_cnt_red;
668 uint64_t policer_cnt_yellow;
669 uint64_t policer_cnt_green;
670 uint64_t policer_cnt_re_red;
671 uint64_t policer_cnt_re_yellow;
674 uint64_t tx_pending_frames_cnt;
677 uint64_t counter[DPNI_STATISTICS_CNT];
682 * Enable auto-negotiation
684 #define DPNI_LINK_OPT_AUTONEG 0x0000000000000001ULL
686 * Enable half-duplex mode
688 #define DPNI_LINK_OPT_HALF_DUPLEX 0x0000000000000002ULL
690 * Enable pause frames
692 #define DPNI_LINK_OPT_PAUSE 0x0000000000000004ULL
694 * Enable a-symmetric pause frames
696 #define DPNI_LINK_OPT_ASYM_PAUSE 0x0000000000000008ULL
698 * Enable priority flow control pause frames
700 #define DPNI_LINK_OPT_PFC_PAUSE 0x0000000000000010ULL
703 * Advertise 10MB full duplex
705 #define DPNI_ADVERTISED_10BASET_FULL 0x0000000000000001ULL
707 * Advertise 100MB full duplex
709 #define DPNI_ADVERTISED_100BASET_FULL 0x0000000000000002ULL
711 * Advertise 1GB full duplex
713 #define DPNI_ADVERTISED_1000BASET_FULL 0x0000000000000004ULL
715 * Advertise auto-negotiation enable
717 #define DPNI_ADVERTISED_AUTONEG 0x0000000000000008ULL
719 * Advertise 10GB full duplex
721 #define DPNI_ADVERTISED_10000BASET_FULL 0x0000000000000010ULL
723 * Advertise 2.5GB full duplex
725 #define DPNI_ADVERTISED_2500BASEX_FULL 0x0000000000000020ULL
727 * Advertise 5GB full duplex
729 #define DPNI_ADVERTISED_5000BASET_FULL 0x0000000000000040ULL
733 * struct - Structure representing DPNI link configuration
735 * @options: Mask of available options; use 'DPNI_LINK_OPT_<X>' values
736 * @advertising: Speeds that are advertised for autoneg (bitmap)
738 struct dpni_link_cfg {
741 uint64_t advertising;
744 int dpni_set_link_cfg(struct fsl_mc_io *mc_io,
747 const struct dpni_link_cfg *cfg);
750 * struct dpni_link_state - Structure representing DPNI link state
752 * @options: Mask of available options; use 'DPNI_LINK_OPT_<X>' values
753 * @up: Link state; '0' for down, '1' for up
754 * @state_valid: Ignore/Update the state of the link
755 * @supported: Speeds capability of the phy (bitmap)
756 * @advertising: Speeds that are advertised for autoneg (bitmap)
758 struct dpni_link_state {
764 uint64_t advertising;
767 int dpni_get_link_state(struct fsl_mc_io *mc_io,
770 struct dpni_link_state *state);
773 * struct dpni_tx_shaping - Structure representing DPNI tx shaping configuration
774 * @rate_limit: Rate in Mbits/s
775 * @max_burst_size: Burst size in bytes (up to 64KB)
777 struct dpni_tx_shaping_cfg {
779 uint16_t max_burst_size;
782 int dpni_set_tx_shaping(struct fsl_mc_io *mc_io,
785 const struct dpni_tx_shaping_cfg *tx_cr_shaper,
786 const struct dpni_tx_shaping_cfg *tx_er_shaper,
789 int dpni_set_max_frame_length(struct fsl_mc_io *mc_io,
792 uint16_t max_frame_length);
794 int dpni_get_max_frame_length(struct fsl_mc_io *mc_io,
797 uint16_t *max_frame_length);
799 int dpni_set_mtu(struct fsl_mc_io *mc_io,
804 int dpni_get_mtu(struct fsl_mc_io *mc_io,
809 int dpni_set_multicast_promisc(struct fsl_mc_io *mc_io,
814 int dpni_get_multicast_promisc(struct fsl_mc_io *mc_io,
819 int dpni_set_unicast_promisc(struct fsl_mc_io *mc_io,
824 int dpni_get_unicast_promisc(struct fsl_mc_io *mc_io,
829 int dpni_set_primary_mac_addr(struct fsl_mc_io *mc_io,
832 const uint8_t mac_addr[6]);
834 int dpni_get_primary_mac_addr(struct fsl_mc_io *mc_io,
837 uint8_t mac_addr[6]);
840 * Set mac addr queue action
842 #define DPNI_MAC_SET_QUEUE_ACTION 1
844 int dpni_add_mac_addr(struct fsl_mc_io *mc_io,
847 const uint8_t mac_addr[6],
852 int dpni_remove_mac_addr(struct fsl_mc_io *mc_io,
855 const uint8_t mac_addr[6]);
857 int dpni_clear_mac_filters(struct fsl_mc_io *mc_io,
863 int dpni_get_port_mac_addr(struct fsl_mc_io *mc_io,
866 uint8_t mac_addr[6]);
868 int dpni_enable_vlan_filter(struct fsl_mc_io *mc_io,
874 * Set vlan filter queue action
876 #define DPNI_VLAN_SET_QUEUE_ACTION 1
878 int dpni_add_vlan_id(struct fsl_mc_io *mc_io,
886 int dpni_remove_vlan_id(struct fsl_mc_io *mc_io,
891 int dpni_clear_vlan_filters(struct fsl_mc_io *mc_io,
896 * enum dpni_tx_schedule_mode - DPNI Tx scheduling mode
897 * @DPNI_TX_SCHED_STRICT_PRIORITY: strict priority
898 * @DPNI_TX_SCHED_WEIGHTED_A: weighted based scheduling in group A
899 * @DPNI_TX_SCHED_WEIGHTED_B: weighted based scheduling in group B
901 enum dpni_tx_schedule_mode {
902 DPNI_TX_SCHED_STRICT_PRIORITY = 0,
903 DPNI_TX_SCHED_WEIGHTED_A,
904 DPNI_TX_SCHED_WEIGHTED_B,
908 * struct dpni_tx_schedule_cfg - Structure representing Tx scheduling conf
909 * @mode: Scheduling mode
910 * @delta_bandwidth: Bandwidth represented in weights from 100 to 10000;
911 * not applicable for 'strict-priority' mode;
913 struct dpni_tx_schedule_cfg {
914 enum dpni_tx_schedule_mode mode;
915 uint16_t delta_bandwidth;
919 * struct dpni_tx_priorities_cfg - Structure representing transmission
920 * priorities for DPNI TCs
921 * @tc_sched: An array of traffic-classes
922 * @prio_group_A: Priority of group A
923 * @prio_group_B: Priority of group B
924 * @separate_groups: Treat A and B groups as separate
926 struct dpni_tx_priorities_cfg {
927 struct dpni_tx_schedule_cfg tc_sched[DPNI_MAX_TC];
928 uint32_t prio_group_A;
929 uint32_t prio_group_B;
930 uint8_t separate_groups;
933 int dpni_set_tx_priorities(struct fsl_mc_io *mc_io,
936 const struct dpni_tx_priorities_cfg *cfg);
939 * enum dpni_dist_mode - DPNI distribution mode
940 * @DPNI_DIST_MODE_NONE: No distribution
941 * @DPNI_DIST_MODE_HASH: Use hash distribution; only relevant if
942 * the 'DPNI_OPT_DIST_HASH' option was set at DPNI creation
943 * @DPNI_DIST_MODE_FS: Use explicit flow steering; only relevant if
944 * the 'DPNI_OPT_DIST_FS' option was set at DPNI creation
946 enum dpni_dist_mode {
947 DPNI_DIST_MODE_NONE = 0,
948 DPNI_DIST_MODE_HASH = 1,
949 DPNI_DIST_MODE_FS = 2
953 * enum dpni_fs_miss_action - DPNI Flow Steering miss action
954 * @DPNI_FS_MISS_DROP: In case of no-match, drop the frame
955 * @DPNI_FS_MISS_EXPLICIT_FLOWID: In case of no-match, use explicit flow-id
956 * @DPNI_FS_MISS_HASH: In case of no-match, distribute using hash
958 enum dpni_fs_miss_action {
959 DPNI_FS_MISS_DROP = 0,
960 DPNI_FS_MISS_EXPLICIT_FLOWID = 1,
961 DPNI_FS_MISS_HASH = 2
965 * struct dpni_fs_tbl_cfg - Flow Steering table configuration
966 * @miss_action: Miss action selection
967 * @default_flow_id: Used when 'miss_action = DPNI_FS_MISS_EXPLICIT_FLOWID'
968 * @keep_hash_key: used only when miss_action is set to DPNI_FS_MISS_HASH. When
969 * set to one unclassified frames will be distributed according to previous
970 * used hash key. If set to zero hash key will be replaced with the key
971 * provided for flow steering.
972 * @keep_entries: if set to one command will not delete the entries that already
973 * exist into FS table. Use this option with caution: if the table
974 * entries are not compatible with the distribution key the packets
975 * will not be classified properly.
977 struct dpni_fs_tbl_cfg {
978 enum dpni_fs_miss_action miss_action;
979 uint16_t default_flow_id;
981 uint8_t keep_entries;
985 * struct dpni_rx_tc_dist_cfg - Rx traffic class distribution configuration
986 * @dist_size: Set the distribution size;
987 * supported values: 1,2,3,4,6,7,8,12,14,16,24,28,32,48,56,64,96,
988 * 112,128,192,224,256,384,448,512,768,896,1024
989 * @dist_mode: Distribution mode
990 * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
991 * the extractions to be used for the distribution key by calling
992 * dpkg_prepare_key_cfg() relevant only when
993 * 'dist_mode != DPNI_DIST_MODE_NONE', otherwise it can be '0'
994 * @fs_cfg: Flow Steering table configuration; only relevant if
995 * 'dist_mode = DPNI_DIST_MODE_FS'
997 struct dpni_rx_tc_dist_cfg {
999 enum dpni_dist_mode dist_mode;
1000 uint64_t key_cfg_iova;
1001 struct dpni_fs_tbl_cfg fs_cfg;
1004 int dpni_set_rx_tc_dist(struct fsl_mc_io *mc_io,
1008 const struct dpni_rx_tc_dist_cfg *cfg);
1011 * Set to select color aware mode (otherwise - color blind)
1013 #define DPNI_POLICER_OPT_COLOR_AWARE 0x00000001
1015 * Set to discard frame with RED color
1017 #define DPNI_POLICER_OPT_DISCARD_RED 0x00000002
1020 * enum dpni_policer_mode - selecting the policer mode
1021 * @DPNI_POLICER_MODE_NONE: Policer is disabled
1022 * @DPNI_POLICER_MODE_PASS_THROUGH: Policer pass through
1023 * @DPNI_POLICER_MODE_RFC_2698: Policer algorithm RFC 2698
1024 * @DPNI_POLICER_MODE_RFC_4115: Policer algorithm RFC 4115
1026 enum dpni_policer_mode {
1027 DPNI_POLICER_MODE_NONE = 0,
1028 DPNI_POLICER_MODE_PASS_THROUGH,
1029 DPNI_POLICER_MODE_RFC_2698,
1030 DPNI_POLICER_MODE_RFC_4115
1034 * enum dpni_policer_unit - DPNI policer units
1035 * @DPNI_POLICER_UNIT_BYTES: bytes units
1036 * @DPNI_POLICER_UNIT_FRAMES: frames units
1038 enum dpni_policer_unit {
1039 DPNI_POLICER_UNIT_BYTES = 0,
1040 DPNI_POLICER_UNIT_FRAMES
1044 * enum dpni_policer_color - selecting the policer color
1045 * @DPNI_POLICER_COLOR_GREEN: Green color
1046 * @DPNI_POLICER_COLOR_YELLOW: Yellow color
1047 * @DPNI_POLICER_COLOR_RED: Red color
1049 enum dpni_policer_color {
1050 DPNI_POLICER_COLOR_GREEN = 0,
1051 DPNI_POLICER_COLOR_YELLOW,
1052 DPNI_POLICER_COLOR_RED
1056 * struct dpni_rx_tc_policing_cfg - Policer configuration
1057 * @options: Mask of available options; use 'DPNI_POLICER_OPT_<X>' values
1058 * @mode: policer mode
1059 * @default_color: For pass-through mode the policer re-colors with this
1060 * color any incoming packets. For Color aware non-pass-through mode:
1061 * policer re-colors with this color all packets with FD[DROPP]>2.
1062 * @units: Bytes or Packets
1063 * @cir: Committed information rate (CIR) in Kbps or packets/second
1064 * @cbs: Committed burst size (CBS) in bytes or packets
1065 * @eir: Peak information rate (PIR, rfc2698) in Kbps or packets/second
1066 * Excess information rate (EIR, rfc4115) in Kbps or packets/second
1067 * @ebs: Peak burst size (PBS, rfc2698) in bytes or packets
1068 * Excess burst size (EBS, rfc4115) in bytes or packets
1070 struct dpni_rx_tc_policing_cfg {
1072 enum dpni_policer_mode mode;
1073 enum dpni_policer_unit units;
1074 enum dpni_policer_color default_color;
1082 int dpni_set_rx_tc_policing(struct fsl_mc_io *mc_io,
1086 const struct dpni_rx_tc_policing_cfg *cfg);
1088 int dpni_get_rx_tc_policing(struct fsl_mc_io *mc_io,
1092 struct dpni_rx_tc_policing_cfg *cfg);
1095 * enum dpni_congestion_unit - DPNI congestion units
1096 * @DPNI_CONGESTION_UNIT_BYTES: bytes units
1097 * @DPNI_CONGESTION_UNIT_FRAMES: frames units
1099 enum dpni_congestion_unit {
1100 DPNI_CONGESTION_UNIT_BYTES = 0,
1101 DPNI_CONGESTION_UNIT_FRAMES
1105 * enum dpni_early_drop_mode - DPNI early drop mode
1106 * @DPNI_EARLY_DROP_MODE_NONE: early drop is disabled
1107 * @DPNI_EARLY_DROP_MODE_TAIL: early drop in taildrop mode
1108 * @DPNI_EARLY_DROP_MODE_WRED: early drop in WRED mode
1110 enum dpni_early_drop_mode {
1111 DPNI_EARLY_DROP_MODE_NONE = 0,
1112 DPNI_EARLY_DROP_MODE_TAIL,
1113 DPNI_EARLY_DROP_MODE_WRED
1117 * struct dpni_wred_cfg - WRED configuration
1118 * @max_threshold: maximum threshold that packets may be discarded. Above this
1119 * threshold all packets are discarded; must be less than 2^39;
1120 * approximated to be expressed as (x+256)*2^(y-1) due to HW
1122 * @min_threshold: minimum threshold that packets may be discarded at
1123 * @drop_probability: probability that a packet will be discarded (1-100,
1124 * associated with the max_threshold).
1126 struct dpni_wred_cfg {
1127 uint64_t max_threshold;
1128 uint64_t min_threshold;
1129 uint8_t drop_probability;
1133 * struct dpni_early_drop_cfg - early-drop configuration
1134 * @enable: drop enable
1135 * @units: units type
1136 * @green: WRED - 'green' configuration
1137 * @yellow: WRED - 'yellow' configuration
1138 * @red: WRED - 'red' configuration
1140 struct dpni_early_drop_cfg {
1142 enum dpni_congestion_unit units;
1143 struct dpni_wred_cfg green;
1144 struct dpni_wred_cfg yellow;
1145 struct dpni_wred_cfg red;
1148 void dpni_prepare_early_drop(const struct dpni_early_drop_cfg *cfg,
1149 uint8_t *early_drop_buf);
1151 void dpni_extract_early_drop(struct dpni_early_drop_cfg *cfg,
1152 const uint8_t *early_drop_buf);
1154 int dpni_set_early_drop(struct fsl_mc_io *mc_io,
1157 enum dpni_queue_type qtype,
1159 uint64_t early_drop_iova);
1161 int dpni_get_early_drop(struct fsl_mc_io *mc_io,
1164 enum dpni_queue_type qtype,
1166 uint64_t early_drop_iova);
1169 * enum dpni_dest - DPNI destination types
1170 * @DPNI_DEST_NONE: Unassigned destination; The queue is set in parked mode and
1171 * does not generate FQDAN notifications; user is expected to
1172 * dequeue from the queue based on polling or other user-defined
1174 * @DPNI_DEST_DPIO: The queue is set in schedule mode and generates FQDAN
1175 * notifications to the specified DPIO; user is expected to dequeue
1176 * from the queue only after notification is received
1177 * @DPNI_DEST_DPCON: The queue is set in schedule mode and does not generate
1178 * FQDAN notifications, but is connected to the specified DPCON
1179 * object; user is expected to dequeue from the DPCON channel
1188 * struct dpni_dest_cfg - Structure representing DPNI destination parameters
1189 * @dest_type: Destination type
1190 * @dest_id: Either DPIO ID or DPCON ID, depending on the destination type
1191 * @priority: Priority selection within the DPIO or DPCON channel; valid values
1192 * are 0-1 or 0-7, depending on the number of priorities in that
1193 * channel; not relevant for 'DPNI_DEST_NONE' option
1195 struct dpni_dest_cfg {
1196 enum dpni_dest dest_type;
1201 /* DPNI congestion options */
1204 * CSCN message is written to message_iova once entering a
1205 * congestion state (see 'threshold_entry')
1207 #define DPNI_CONG_OPT_WRITE_MEM_ON_ENTER 0x00000001
1209 * CSCN message is written to message_iova once exiting a
1210 * congestion state (see 'threshold_exit')
1212 #define DPNI_CONG_OPT_WRITE_MEM_ON_EXIT 0x00000002
1214 * CSCN write will attempt to allocate into a cache (coherent write);
1215 * valid only if 'DPNI_CONG_OPT_WRITE_MEM_<X>' is selected
1217 #define DPNI_CONG_OPT_COHERENT_WRITE 0x00000004
1219 * if 'dest_cfg.dest_type != DPNI_DEST_NONE' CSCN message is sent to
1220 * DPIO/DPCON's WQ channel once entering a congestion state
1221 * (see 'threshold_entry')
1223 #define DPNI_CONG_OPT_NOTIFY_DEST_ON_ENTER 0x00000008
1225 * if 'dest_cfg.dest_type != DPNI_DEST_NONE' CSCN message is sent to
1226 * DPIO/DPCON's WQ channel once exiting a congestion state
1227 * (see 'threshold_exit')
1229 #define DPNI_CONG_OPT_NOTIFY_DEST_ON_EXIT 0x00000010
1231 * if 'dest_cfg.dest_type != DPNI_DEST_NONE' when the CSCN is written to the
1232 * sw-portal's DQRR, the DQRI interrupt is asserted immediately (if enabled)
1234 #define DPNI_CONG_OPT_INTR_COALESCING_DISABLED 0x00000020
1236 * This congestion will trigger flow control or priority flow control. This
1237 * will have effect only if flow control is enabled with dpni_set_link_cfg()
1239 #define DPNI_CONG_OPT_FLOW_CONTROL 0x00000040
1242 * enum dpni_congestion_point - Structure representing congestion point
1243 * @DPNI_CP_QUEUE: Set congestion per queue, identified by QUEUE_TYPE, TC
1245 * @DPNI_CP_GROUP: Set congestion per queue group. Depending on options
1246 * used to define the DPNI this can be either per
1247 * TC (default) or per interface
1248 * (DPNI_OPT_SHARED_CONGESTION set at DPNI create).
1249 * QUEUE_INDEX is ignored if this type is used.
1250 * @DPNI_CP_CONGESTION_GROUP: Set per congestion group id. This will work
1251 * only if the DPNI is created with DPNI_OPT_CUSTOM_CG option
1254 enum dpni_congestion_point {
1257 DPNI_CP_CONGESTION_GROUP,
1261 * struct dpni_congestion_notification_cfg - congestion notification
1263 * @units: units type
1264 * @threshold_entry: above this threshold we enter a congestion state.
1265 * set it to '0' to disable it
1266 * @threshold_exit: below this threshold we exit the congestion state.
1267 * @message_ctx: The context that will be part of the CSCN message
1268 * @message_iova: I/O virtual address (must be in DMA-able memory),
1269 * must be 16B aligned; valid only if 'DPNI_CONG_OPT_WRITE_MEM_<X>' is
1270 * contained in 'options'
1271 * @dest_cfg: CSCN can be send to either DPIO or DPCON WQ channel
1272 * @notification_mode: Mask of available options; use 'DPNI_CONG_OPT_<X>' values
1273 * @cg_point: Congestion point settings
1274 * @cgid: id of the congestion group. The index is relative to dpni.
1277 struct dpni_congestion_notification_cfg {
1278 enum dpni_congestion_unit units;
1279 uint32_t threshold_entry;
1280 uint32_t threshold_exit;
1281 uint64_t message_ctx;
1282 uint64_t message_iova;
1283 struct dpni_dest_cfg dest_cfg;
1284 uint16_t notification_mode;
1285 enum dpni_congestion_point cg_point;
1289 int dpni_set_congestion_notification(struct fsl_mc_io *mc_io,
1292 enum dpni_queue_type qtype,
1294 const struct dpni_congestion_notification_cfg *cfg);
1296 int dpni_get_congestion_notification(struct fsl_mc_io *mc_io,
1299 enum dpni_queue_type qtype,
1301 struct dpni_congestion_notification_cfg *cfg);
1303 /* DPNI FLC stash options */
1306 * stashes the whole annotation area (up to 192 bytes)
1308 #define DPNI_FLC_STASH_FRAME_ANNOTATION 0x00000001
1311 * struct dpni_queue - Queue structure
1312 * @destination - Destination structure
1313 * @destination.id: ID of the destination, only relevant if DEST_TYPE is > 0.
1314 * Identifies either a DPIO or a DPCON object.
1315 * Not relevant for Tx queues.
1316 * @destination.type: May be one of the following:
1317 * 0 - No destination, queue can be manually
1318 * queried, but will not push traffic or
1319 * notifications to a DPIO;
1320 * 1 - The destination is a DPIO. When traffic
1321 * becomes available in the queue a FQDAN
1322 * (FQ data available notification) will be
1323 * generated to selected DPIO;
1324 * 2 - The destination is a DPCON. The queue is
1325 * associated with a DPCON object for the
1326 * purpose of scheduling between multiple
1327 * queues. The DPCON may be independently
1328 * configured to generate notifications.
1329 * Not relevant for Tx queues.
1330 * @destination.hold_active: Hold active, maintains a queue scheduled for longer
1331 * in a DPIO during dequeue to reduce spread of traffic.
1332 * Only relevant if queues are
1333 * not affined to a single DPIO.
1334 * @user_context: User data, presented to the user along with any frames
1335 * from this queue. Not relevant for Tx queues.
1336 * @flc: FD FLow Context structure
1337 * @flc.value: Default FLC value for traffic dequeued from
1338 * this queue. Please check description of FD
1339 * structure for more information.
1340 * Note that FLC values set using dpni_add_fs_entry,
1341 * if any, take precedence over values per queue.
1342 * @flc.stash_control: Boolean, indicates whether the 6 lowest
1343 * - significant bits are used for stash control.
1344 * significant bits are used for stash control. If set, the 6
1345 * least significant bits in value are interpreted as follows:
1346 * - bits 0-1: indicates the number of 64 byte units of context
1347 * that are stashed. FLC value is interpreted as a memory address
1348 * in this case, excluding the 6 LS bits.
1349 * - bits 2-3: indicates the number of 64 byte units of frame
1350 * annotation to be stashed. Annotation is placed at FD[ADDR].
1351 * - bits 4-5: indicates the number of 64 byte units of frame
1352 * data to be stashed. Frame data is placed at FD[ADDR] +
1354 * For more details check the Frame Descriptor section in the
1355 * hardware documentation.
1356 *@cgid :indicate the cgid to set relative to dpni
1361 enum dpni_dest type;
1365 uint64_t user_context;
1374 * struct dpni_queue_id - Queue identification, used for enqueue commands
1376 * @fqid: FQID used for enqueueing to and/or configuration of this
1378 * @qdbin: Queueing bin, used to enqueue using QDID, DQBIN, QPRI.
1379 * Only relevant for Tx queues.
1381 struct dpni_queue_id {
1387 * enum dpni_confirmation_mode - Defines DPNI options supported for Tx
1389 * @DPNI_CONF_AFFINE: For each Tx queue set associated with a sender there is
1390 * an affine Tx Confirmation queue
1391 * @DPNI_CONF_SINGLE: All Tx queues are associated with a single Tx
1392 * confirmation queue
1393 * @DPNI_CONF_DISABLE: Tx frames are not confirmed. This must be associated
1394 * with proper FD set-up to have buffers release to a Buffer Pool, otherwise
1395 * buffers will be leaked
1397 enum dpni_confirmation_mode {
1403 int dpni_set_tx_confirmation_mode(struct fsl_mc_io *mc_io,
1406 enum dpni_confirmation_mode mode);
1408 int dpni_get_tx_confirmation_mode(struct fsl_mc_io *mc_io,
1411 enum dpni_confirmation_mode *mode);
1414 * struct dpni_qos_tbl_cfg - Structure representing QOS table configuration
1415 * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
1416 * key extractions to be used as the QoS criteria by calling
1417 * dpkg_prepare_key_cfg()
1418 * @discard_on_miss: Set to '1' to discard frames in case of no match (miss);
1419 * '0' to use the 'default_tc' in such cases
1420 * @keep_entries: if set to one will not delele existing table entries. This
1421 * option will work properly only for dpni objects created with
1422 * DPNI_OPT_HAS_KEY_MASKING option. All previous QoS entries must
1423 * be compatible with new key composition rule.
1424 * It is the caller's job to delete incompatible entries before
1425 * executing this function.
1426 * @default_tc: Used in case of no-match and 'discard_on_miss'= 0
1428 struct dpni_qos_tbl_cfg {
1429 uint64_t key_cfg_iova;
1430 int discard_on_miss;
1435 int dpni_set_qos_table(struct fsl_mc_io *mc_io,
1438 const struct dpni_qos_tbl_cfg *cfg);
1441 * struct dpni_rule_cfg - Rule configuration for table lookup
1442 * @key_iova: I/O virtual address of the key (must be in DMA-able memory)
1443 * @mask_iova: I/O virtual address of the mask (must be in DMA-able memory)
1444 * @key_size: key and mask size (in bytes)
1446 struct dpni_rule_cfg {
1452 int dpni_add_qos_entry(struct fsl_mc_io *mc_io,
1455 const struct dpni_rule_cfg *cfg,
1461 int dpni_remove_qos_entry(struct fsl_mc_io *mc_io,
1464 const struct dpni_rule_cfg *cfg);
1466 int dpni_clear_qos_table(struct fsl_mc_io *mc_io,
1471 * Discard matching traffic. If set, this takes precedence over any other
1472 * configuration and matching traffic is always discarded.
1474 #define DPNI_FS_OPT_DISCARD 0x1
1477 * Set FLC value. If set, flc member of truct dpni_fs_action_cfg is used to
1478 * override the FLC value set per queue.
1479 * For more details check the Frame Descriptor section in the hardware
1482 #define DPNI_FS_OPT_SET_FLC 0x2
1485 * Indicates whether the 6 lowest significant bits of FLC are used for stash
1486 * control. If set, the 6 least significant bits in value are interpreted as
1488 * - bits 0-1: indicates the number of 64 byte units of context that are
1489 * stashed. FLC value is interpreted as a memory address in this case,
1490 * excluding the 6 LS bits.
1491 * - bits 2-3: indicates the number of 64 byte units of frame annotation
1492 * to be stashed. Annotation is placed at FD[ADDR].
1493 * - bits 4-5: indicates the number of 64 byte units of frame data to be
1494 * stashed. Frame data is placed at FD[ADDR] + FD[OFFSET].
1495 * This flag is ignored if DPNI_FS_OPT_SET_FLC is not specified.
1497 #define DPNI_FS_OPT_SET_STASH_CONTROL 0x4
1500 * Redirect matching traffic to Rx part of another dpni object. The frame
1501 * will be classified according to new qos and flow steering rules from
1502 * target dpni object.
1504 #define DPNI_FS_OPT_REDIRECT_TO_DPNI_RX 0x08
1507 * Redirect matching traffic into Tx queue of another dpni object. The
1508 * frame will be transmitted directly
1510 #define DPNI_FS_OPT_REDIRECT_TO_DPNI_TX 0x10
1513 * struct dpni_fs_action_cfg - Action configuration for table look-up
1514 * @flc: FLC value for traffic matching this rule. Please check the Frame
1515 * Descriptor section in the hardware documentation for more information.
1516 * @flow_id: Identifies the Rx queue used for matching traffic. Supported
1517 * values are in range 0 to num_queue-1.
1518 * @redirect_obj_token: token that identifies the object where frame is
1519 * redirected when this rule is hit. This paraneter is used only when one of the
1520 * flags DPNI_FS_OPT_REDIRECT_TO_DPNI_RX or DPNI_FS_OPT_REDIRECT_TO_DPNI_TX is
1522 * The token is obtained using dpni_open() API call. The object must stay
1523 * open during the operation to ensure the fact that application has access
1524 * on it. If the object is destroyed of closed next actions will take place:
1525 * - if DPNI_FS_OPT_DISCARD is set the frame will be discarded by current dpni
1526 * - if DPNI_FS_OPT_DISCARD is cleared the frame will be enqueued in queue with
1527 * index provided in flow_id parameter.
1528 * @options: Any combination of DPNI_FS_OPT_ values.
1530 struct dpni_fs_action_cfg {
1533 uint16_t redirect_obj_token;
1537 int dpni_add_fs_entry(struct fsl_mc_io *mc_io,
1542 const struct dpni_rule_cfg *cfg,
1543 const struct dpni_fs_action_cfg *action);
1545 int dpni_remove_fs_entry(struct fsl_mc_io *mc_io,
1549 const struct dpni_rule_cfg *cfg);
1551 int dpni_clear_fs_entries(struct fsl_mc_io *mc_io,
1556 int dpni_get_api_version(struct fsl_mc_io *mc_io,
1558 uint16_t *major_ver,
1559 uint16_t *minor_ver);
1564 #define DPNI_QUEUE_OPT_USER_CTX 0x00000001
1567 * Set queue destination configuration
1569 #define DPNI_QUEUE_OPT_DEST 0x00000002
1572 * Set FD[FLC] configuration for traffic on this queue. Note that FLC values
1573 * set with dpni_add_fs_entry, if any, take precedence over values per queue.
1575 #define DPNI_QUEUE_OPT_FLC 0x00000004
1578 * Set the queue to hold active mode. This prevents the queue from being
1579 * rescheduled between DPIOs while it carries traffic and is active on one
1580 * DPNI. Can help reduce reordering when servicing one queue on multiple
1581 * CPUs, but the queue is also less likely to push data to multiple CPUs
1582 * especially when congested.
1584 #define DPNI_QUEUE_OPT_HOLD_ACTIVE 0x00000008
1586 #define DPNI_QUEUE_OPT_SET_CGID 0x00000040
1587 #define DPNI_QUEUE_OPT_CLEAR_CGID 0x00000080
1589 int dpni_set_queue(struct fsl_mc_io *mc_io,
1592 enum dpni_queue_type qtype,
1596 const struct dpni_queue *queue);
1598 int dpni_get_queue(struct fsl_mc_io *mc_io,
1601 enum dpni_queue_type qtype,
1604 struct dpni_queue *queue,
1605 struct dpni_queue_id *qid);
1607 int dpni_get_statistics(struct fsl_mc_io *mc_io,
1612 union dpni_statistics *stat);
1614 int dpni_reset_statistics(struct fsl_mc_io *mc_io,
1619 * struct dpni_taildrop - Structure representing the taildrop
1620 * @enable: Indicates whether the taildrop is active or not.
1621 * @units: Indicates the unit of THRESHOLD. Queue taildrop only
1622 * supports byte units, this field is ignored and
1623 * assumed = 0 if CONGESTION_POINT is 0.
1624 * @threshold: Threshold value, in units identified by UNITS field. Value 0
1625 * cannot be used as a valid taildrop threshold,
1626 * THRESHOLD must be > 0 if the taildrop is
1628 * @oal : Overhead Accounting Length, a 12-bit, 2's complement value
1629 * with range (-2048 to +2047) representing a fixed per-frame
1630 * overhead to be added to the actual length of a frame when
1631 * performing WRED and tail drop calculations and threshold
1634 struct dpni_taildrop {
1636 enum dpni_congestion_unit units;
1641 int dpni_set_taildrop(struct fsl_mc_io *mc_io,
1644 enum dpni_congestion_point cg_point,
1645 enum dpni_queue_type q_type,
1648 struct dpni_taildrop *taildrop);
1650 int dpni_get_taildrop(struct fsl_mc_io *mc_io,
1653 enum dpni_congestion_point cg_point,
1654 enum dpni_queue_type q_type,
1657 struct dpni_taildrop *taildrop);
1659 int dpni_set_opr(struct fsl_mc_io *mc_io,
1665 struct opr_cfg *cfg,
1668 int dpni_get_opr(struct fsl_mc_io *mc_io,
1673 struct opr_cfg *cfg,
1674 struct opr_qry *qry,
1679 * When used for queue_idx in function dpni_set_rx_dist_default_queue will
1680 * signal to dpni to drop all unclassified frames
1682 #define DPNI_FS_MISS_DROP ((uint16_t)-1)
1685 * struct dpni_rx_dist_cfg - distribution configuration
1686 * @dist_size: distribution size; supported values: 1,2,3,4,6,7,8,
1687 * 12,14,16,24,28,32,48,56,64,96,112,128,192,224,256,384,448,
1689 * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
1690 * the extractions to be used for the distribution key by calling
1691 * dpkg_prepare_key_cfg() relevant only when enable!=0 otherwise
1693 * @enable: enable/disable the distribution.
1694 * @tc: TC id for which distribution is set
1695 * @fs_miss_flow_id: when packet misses all rules from flow steering table and
1696 * hash is disabled it will be put into this queue id; use
1697 * DPNI_FS_MISS_DROP to drop frames. The value of this field is
1698 * used only when flow steering distribution is enabled and hash
1699 * distribution is disabled
1701 struct dpni_rx_dist_cfg {
1703 uint64_t key_cfg_iova;
1706 uint16_t fs_miss_flow_id;
1709 int dpni_set_rx_fs_dist(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1710 uint16_t token, const struct dpni_rx_dist_cfg *cfg);
1712 int dpni_set_rx_hash_dist(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1713 uint16_t token, const struct dpni_rx_dist_cfg *cfg);
1715 int dpni_add_custom_tpid(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1716 uint16_t token, uint16_t tpid);
1718 int dpni_remove_custom_tpid(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1719 uint16_t token, uint16_t tpid);
1722 * struct dpni_custom_tpid_cfg - custom TPID configuration. Contains custom TPID
1723 * values used in current dpni object to detect 802.1q frames.
1724 * @tpid1: first tag. Not used if zero.
1725 * @tpid2: second tag. Not used if zero.
1727 struct dpni_custom_tpid_cfg {
1732 int dpni_get_custom_tpid(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1733 uint16_t token, struct dpni_custom_tpid_cfg *tpid);
1736 * enum dpni_soft_sequence_dest - Enumeration of WRIOP software sequence
1738 * @DPNI_SS_INGRESS: Ingress parser
1739 * @DPNI_SS_EGRESS: Egress parser
1741 enum dpni_soft_sequence_dest {
1742 DPNI_SS_INGRESS = 0,
1747 * struct dpni_load_ss_cfg - Structure for Software Sequence load configuration
1748 * @dest: Destination of the Software Sequence: ingress or egress parser
1749 * @ss_size: Size of the Software Sequence
1750 * @ss_offset: The offset where to load the Software Sequence (0x20-0x7FD)
1751 * @ss_iova: I/O virtual address of the Software Sequence
1753 struct dpni_load_ss_cfg {
1754 enum dpni_soft_sequence_dest dest;
1761 * struct dpni_enable_ss_cfg - Structure for software sequence enable
1763 * @dest: Destination of the Software Sequence: ingress or egress parser
1764 * @hxs: HXS to attach the software sequence to
1765 * @set_start: If the Software Sequence or HDR it is attached to is set as
1767 * If hxs=DUMMY_LAST_HXS the ss_offset is set directly as parser
1768 * start else the hdr index code is set as parser start
1769 * @ss_offset: The offset of the Software Sequence to enable or set as parse
1771 * @param_size: Size of the software sequence parameters
1772 * @param_offset: Offset in the parameter zone for the software sequence
1774 * @param_iova: I/O virtual address of the parameters
1776 struct dpni_enable_ss_cfg {
1777 enum dpni_soft_sequence_dest dest;
1782 uint8_t param_offset;
1783 uint64_t param_iova;
1787 * dpni_load_sw_sequence() - Loads a software sequence in parser memory.
1788 * @mc_io: Pointer to MC portal's I/O object
1789 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
1790 * @token: Token of DPNI object
1791 * @cfg: Software sequence load configuration
1792 * Return: '0' on Success; Error code otherwise.
1794 int dpni_load_sw_sequence(struct fsl_mc_io *mc_io,
1797 struct dpni_load_ss_cfg *cfg);
1800 * dpni_eanble_sw_sequence() - Enables a software sequence in the parser
1802 * corresponding to the ingress or egress of the DPNI.
1803 * @mc_io: Pointer to MC portal's I/O object
1804 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
1805 * @token: Token of DPNI object
1806 * @cfg: Software sequence enable configuration
1807 * Return: '0' on Success; Error code otherwise.
1809 int dpni_enable_sw_sequence(struct fsl_mc_io *mc_io,
1812 struct dpni_enable_ss_cfg *cfg);
1815 * struct dpni_sw_sequence_layout - Structure for software sequence enable
1817 * @num_ss: Number of software sequences returned
1818 * @ss: Array of software sequence entries. The number of valid entries
1819 * must match 'num_ss' value
1821 struct dpni_sw_sequence_layout {
1826 uint8_t param_offset;
1828 } ss[DPNI_SW_SEQUENCE_LAYOUT_SIZE];
1832 * dpni_get_sw_sequence_layout() - Get the soft sequence layout
1833 * @mc_io: Pointer to MC portal's I/O object
1834 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
1835 * @token: Token of DPNI object
1836 * @src: Source of the layout (WRIOP Rx or Tx)
1837 * @ss_layout_iova: I/O virtual address of 264 bytes DMA-able memory
1839 * warning: After calling this function, call dpni_extract_sw_sequence_layout()
1842 * Return: '0' on Success; error code otherwise.
1844 int dpni_get_sw_sequence_layout(struct fsl_mc_io *mc_io,
1847 enum dpni_soft_sequence_dest src,
1848 uint64_t ss_layout_iova);
1851 * dpni_extract_sw_sequence_layout() - extract the software sequence layout
1852 * @layout: software sequence layout
1853 * @sw_sequence_layout_buf:Zeroed 264 bytes of memory before mapping it to DMA
1855 * This function has to be called after dpni_get_sw_sequence_layout
1857 void dpni_extract_sw_sequence_layout(struct dpni_sw_sequence_layout *layout,
1858 const uint8_t *sw_sequence_layout_buf);
1861 * struct dpni_ptp_cfg - configure single step PTP (IEEE 1588)
1862 * @en: enable single step PTP. When enabled the PTPv1 functionality will
1863 * not work. If the field is zero, offset and ch_update parameters
1865 * @offset: start offset from the beginning of the frame where timestamp
1866 * field is found. The offset must respect all MAC headers, VLAN
1867 * tags and other protocol headers
1868 * @ch_update: when set UDP checksum will be updated inside packet
1869 * @peer_delay: For peer-to-peer transparent clocks add this value to the
1870 * correction field in addition to the transient time update. The
1871 * value expresses nanoseconds.
1873 struct dpni_single_step_cfg {
1877 uint32_t peer_delay;
1880 int dpni_set_single_step_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1881 uint16_t token, struct dpni_single_step_cfg *ptp_cfg);
1883 int dpni_get_single_step_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1884 uint16_t token, struct dpni_single_step_cfg *ptp_cfg);
1887 * loopback_en field is valid when calling function dpni_set_port_cfg
1889 #define DPNI_PORT_CFG_LOOPBACK 0x01
1892 * struct dpni_port_cfg - custom configuration for dpni physical port
1893 * @loopback_en: port loopback enabled
1895 struct dpni_port_cfg {
1899 int dpni_set_port_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1900 uint16_t token, uint32_t flags, struct dpni_port_cfg *port_cfg);
1902 int dpni_get_port_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1903 uint16_t token, struct dpni_port_cfg *port_cfg);
1905 #endif /* __FSL_DPNI_H */