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
40 * Maximum number of Tx channels per DPNI
42 #define DPNI_MAX_CHANNELS 16
45 * All traffic classes considered; see dpni_set_queue()
47 #define DPNI_ALL_TCS (uint8_t)(-1)
49 * All flows within traffic class considered; see dpni_set_queue()
51 #define DPNI_ALL_TC_FLOWS (uint16_t)(-1)
54 * Tx traffic is always released to a buffer pool on transmit, there are no
55 * resources allocated to have the frames confirmed back to the source after
58 #define DPNI_OPT_TX_FRM_RELEASE 0x000001
60 * Disables support for MAC address filtering for addresses other than primary
61 * MAC address. This affects both unicast and multicast. Promiscuous mode can
62 * still be enabled/disabled for both unicast and multicast. If promiscuous mode
63 * is disabled, only traffic matching the primary MAC address will be accepted.
65 #define DPNI_OPT_NO_MAC_FILTER 0x000002
67 * Allocate policers for this DPNI. They can be used to rate-limit traffic per
68 * traffic class (TC) basis.
70 #define DPNI_OPT_HAS_POLICING 0x000004
72 * Congestion can be managed in several ways, allowing the buffer pool to
73 * deplete on ingress, taildrop on each queue or use congestion groups for sets
74 * of queues. If set, it configures a single congestion groups across all TCs.
75 * If reset, a congestion group is allocated for each TC. Only relevant if the
76 * DPNI has multiple traffic classes.
78 #define DPNI_OPT_SHARED_CONGESTION 0x000008
80 * Enables TCAM for Flow Steering and QoS look-ups. If not specified, all
81 * look-ups are exact match. Note that TCAM is not available on LS1088 and its
82 * variants. Setting this bit on these SoCs will trigger an error.
84 #define DPNI_OPT_HAS_KEY_MASKING 0x000010
86 * Disables the flow steering table.
88 #define DPNI_OPT_NO_FS 0x000020
91 * Enable the Order Restoration support
93 #define DPNI_OPT_HAS_OPR 0x000040
96 * Order Point Records are shared for the entire TC
98 #define DPNI_OPT_OPR_PER_TC 0x000080
100 * All Tx traffic classes will use a single sender (ignore num_queues for tx)
102 #define DPNI_OPT_SINGLE_SENDER 0x000100
104 * Define a custom number of congestion groups
106 #define DPNI_OPT_CUSTOM_CG 0x000200
108 * Define a custom number of order point records
110 #define DPNI_OPT_CUSTOM_OPR 0x000400
112 * Hash key is shared between all traffic classes
114 #define DPNI_OPT_SHARED_HASH_KEY 0x000800
116 * Flow steering table is shared between all traffic classes
118 #define DPNI_OPT_SHARED_FS 0x001000
120 * Software sequence maximum layout size
122 #define DPNI_SW_SEQUENCE_LAYOUT_SIZE 33
125 * Build a parameter from dpni channel and trafiic class. This parameter
126 * will be used to configure / query information from dpni objects created
127 * to support multiple channels.
129 #define DPNI_BUILD_PARAM(channel, tc_id) (((channel) << 8) | (tc_id))
131 int dpni_open(struct fsl_mc_io *mc_io,
136 int dpni_close(struct fsl_mc_io *mc_io,
141 * struct dpni_cfg - Structure representing DPNI configuration
142 * @options: Any combination of the following options:
143 * DPNI_OPT_TX_FRM_RELEASE
144 * DPNI_OPT_NO_MAC_FILTER
145 * DPNI_OPT_HAS_POLICING
146 * DPNI_OPT_SHARED_CONGESTION
147 * DPNI_OPT_HAS_KEY_MASKING
149 * DPNI_OPT_SINGLE_SENDER
150 * @fs_entries: Number of entries in the flow steering table.
151 * This table is used to select the ingress queue for
152 * ingress traffic, targeting a GPP core or another.
153 * In addition it can be used to discard traffic that
154 * matches the set rule. It is either an exact match table
155 * or a TCAM table, depending on DPNI_OPT_ HAS_KEY_MASKING
156 * bit in OPTIONS field. This field is ignored if
157 * DPNI_OPT_NO_FS bit is set in OPTIONS field. Otherwise,
158 * value 0 defaults to 64. Maximum supported value is 1024.
159 * Note that the total number of entries is limited on the
160 * SoC to as low as 512 entries if TCAM is used.
161 * @vlan_filter_entries: Number of entries in the VLAN address filtering
162 * table. This is an exact match table used to filter
163 * ingress traffic based on VLAN IDs. Value 0 disables VLAN
164 * filtering. Maximum supported value is 16.
165 * @mac_filter_entries: Number of entries in the MAC address filtering
166 * table. This is an exact match table and allows both
167 * unicast and multicast entries. The primary MAC address
168 * of the network interface is not part of this table,
169 * this contains only entries in addition to it. This
170 * field is ignored if DPNI_OPT_ NO_MAC_FILTER is set in
171 * OPTIONS field. Otherwise, value 0 defaults to 80.
172 * Maximum supported value is 80.
173 * @num_queues: Number of Tx and Rx queues used for traffic
174 * distribution. This is orthogonal to QoS and is only
175 * used to distribute traffic to multiple GPP cores.
176 * This configuration affects the number of Tx queues
177 * (logical FQs, all associated with a single CEETM queue),
178 * Rx queues and Tx confirmation queues, if applicable.
179 * Value 0 defaults to one queue. Maximum supported value
181 * @num_tcs: Number of traffic classes (TCs), reserved for the DPNI.
182 * TCs can have different priority levels for the purpose
183 * of Tx scheduling (see DPNI_SET_TX_PRIORITIES), different
184 * BPs (DPNI_ SET_POOLS), policers. There are dedicated QM
185 * queues for traffic classes (including class queues on
186 * Tx). Value 0 defaults to one TC. Maximum supported value
187 * is 16. There are maximum 16 TCs for Tx and 8 TCs for Rx.
188 * When num_tcs>8 Tx will use this value but Rx will have
189 * only 8 traffic classes.
190 * @num_rx_tcs: if set to other value than zero represents number
191 * of TCs used for Rx. Maximum value is 8. If set to zero the
192 * number of Rx TCs will be initialized with the value provided
193 * in num_tcs parameter.
194 * @qos_entries: Number of entries in the QoS classification table. This
195 * table is used to select the TC for ingress traffic. It
196 * is either an exact match or a TCAM table, depending on
197 * DPNI_OPT_ HAS_KEY_MASKING bit in OPTIONS field. This
198 * field is ignored if the DPNI has a single TC. Otherwise,
199 * a value of 0 defaults to 64. Maximum supported value
201 * @num_channels: Number of egress channels used by this dpni object. If
202 * set to zero the dpni object will use a single CEETM channel.
207 uint8_t vlan_filter_entries;
208 uint8_t mac_filter_entries;
215 uint8_t dist_key_size;
216 uint8_t num_channels;
219 int dpni_create(struct fsl_mc_io *mc_io,
222 const struct dpni_cfg *cfg,
225 int dpni_destroy(struct fsl_mc_io *mc_io,
231 * struct dpni_pools_cfg - Structure representing buffer pools configuration
232 * @num_dpbp: Number of DPBPs
233 * @pool_options: Buffer assignment options
234 * This field is a combination of DPNI_POOL_ASSOC_flags
235 * @pools: Array of buffer pools parameters; The number of valid entries
236 * must match 'num_dpbp' value
237 * @pools.dpbp_id: DPBP object ID
238 * @pools.priority: Priority mask that indicates TC's used with this buffer.
239 * I set to 0x00 MC will assume value 0xff.
240 * @pools.buffer_size: Buffer size
241 * @pools.backup_pool: Backup pool
244 #define DPNI_POOL_ASSOC_QPRI 0
245 #define DPNI_POOL_ASSOC_QDBIN 1
247 struct dpni_pools_cfg {
249 uint8_t pool_options;
252 uint8_t priority_mask;
253 uint16_t buffer_size;
255 } pools[DPNI_MAX_DPBP];
258 int dpni_set_pools(struct fsl_mc_io *mc_io,
261 const struct dpni_pools_cfg *cfg);
263 int dpni_enable(struct fsl_mc_io *mc_io,
267 int dpni_disable(struct fsl_mc_io *mc_io,
271 int dpni_is_enabled(struct fsl_mc_io *mc_io,
276 int dpni_reset(struct fsl_mc_io *mc_io,
281 * DPNI IRQ Index and Events
287 #define DPNI_IRQ_INDEX 0
289 * IRQ event - indicates a change in link state
291 #define DPNI_IRQ_EVENT_LINK_CHANGED 0x00000001
293 int dpni_set_irq_enable(struct fsl_mc_io *mc_io,
299 int dpni_get_irq_enable(struct fsl_mc_io *mc_io,
305 int dpni_set_irq_mask(struct fsl_mc_io *mc_io,
311 int dpni_get_irq_mask(struct fsl_mc_io *mc_io,
317 int dpni_get_irq_status(struct fsl_mc_io *mc_io,
323 int dpni_clear_irq_status(struct fsl_mc_io *mc_io,
330 * struct dpni_attr - Structure representing DPNI attributes
331 * @options: Any combination of the following options:
332 * DPNI_OPT_TX_FRM_RELEASE
333 * DPNI_OPT_NO_MAC_FILTER
334 * DPNI_OPT_HAS_POLICING
335 * DPNI_OPT_SHARED_CONGESTION
336 * DPNI_OPT_HAS_KEY_MASKING
338 * @num_queues: Number of Tx and Rx queues used for traffic distribution.
339 * @num_rx_tcs: Number of RX traffic classes (TCs), reserved for the DPNI.
340 * @num_tx_tcs: Number of TX traffic classes (TCs), reserved for the DPNI.
341 * @mac_filter_entries: Number of entries in the MAC address filtering
343 * @vlan_filter_entries: Number of entries in the VLAN address filtering
345 * @qos_entries: Number of entries in the QoS classification table.
346 * @fs_entries: Number of entries in the flow steering table.
347 * @qos_key_size: Size, in bytes, of the QoS look-up key. Defining a key larger
348 * than this when adding QoS entries will result
350 * @fs_key_size: Size, in bytes, of the flow steering look-up key. Defining a
351 * key larger than this when composing the hash + FS key
352 * will result in an error.
353 * @wriop_version: Version of WRIOP HW block.
354 * The 3 version values are stored on 6, 5, 5 bits
357 * - 0x400 - WRIOP version 1.0.0, used on LS2080 and
359 * - 0x421 - WRIOP version 1.1.1, used on LS2088 and
361 * - 0x422 - WRIOP version 1.1.2, used on LS1088 and
363 * - 0xC00 - WRIOP version 3.0.0, used on LX2160 and
371 uint8_t mac_filter_entries;
372 uint8_t vlan_filter_entries;
375 uint8_t qos_key_size;
377 uint16_t wriop_version;
379 uint8_t num_channels;
382 int dpni_get_attributes(struct fsl_mc_io *mc_io,
385 struct dpni_attr *attr);
392 * Discard error. When set all discarded frames in wriop will be enqueued to
393 * error queue. To be used in dpni_set_errors_behavior() only if error_action
394 * parameter is set to DPNI_ERROR_ACTION_SEND_TO_ERROR_QUEUE.
396 #define DPNI_ERROR_DISC 0x80000000
399 * Extract out of frame header error
401 #define DPNI_ERROR_MS 0x40000000
402 #define DPNI_ERROR_PTP 0x08000000
403 /* Ethernet multicast frame */
404 #define DPNI_ERROR_MC 0x04000000
405 /* Ethernet broadcast frame */
406 #define DPNI_ERROR_BC 0x02000000
407 #define DPNI_ERROR_KSE 0x00040000
408 #define DPNI_ERROR_EOFHE 0x00020000
409 #define DPNI_ERROR_MNLE 0x00010000
410 #define DPNI_ERROR_TIDE 0x00008000
411 #define DPNI_ERROR_PIEE 0x00004000
415 #define DPNI_ERROR_FLE 0x00002000
417 * Frame physical error
419 #define DPNI_ERROR_FPE 0x00001000
420 #define DPNI_ERROR_PTE 0x00000080
421 #define DPNI_ERROR_ISP 0x00000040
423 * Parsing header error
425 #define DPNI_ERROR_PHE 0x00000020
427 #define DPNI_ERROR_BLE 0x00000010
429 * Parser L3 checksum error
431 #define DPNI_ERROR_L3CV 0x00000008
433 #define DPNI_ERROR_L3CE 0x00000004
435 * Parser L4 checksum error
437 #define DPNI_ERROR_L4CV 0x00000002
439 #define DPNI_ERROR_L4CE 0x00000001
441 * enum dpni_error_action - Defines DPNI behavior for errors
442 * @DPNI_ERROR_ACTION_DISCARD: Discard the frame
443 * @DPNI_ERROR_ACTION_CONTINUE: Continue with the normal flow
444 * @DPNI_ERROR_ACTION_SEND_TO_ERROR_QUEUE: Send the frame to the error queue
446 enum dpni_error_action {
447 DPNI_ERROR_ACTION_DISCARD = 0,
448 DPNI_ERROR_ACTION_CONTINUE = 1,
449 DPNI_ERROR_ACTION_SEND_TO_ERROR_QUEUE = 2
453 * struct dpni_error_cfg - Structure representing DPNI errors treatment
454 * @errors: Errors mask; use 'DPNI_ERROR__<X>
455 * @error_action: The desired action for the errors mask
456 * @set_frame_annotation: Set to '1' to mark the errors in frame
457 * annotation status (FAS); relevant only
458 * for the non-discard action
460 struct dpni_error_cfg {
462 enum dpni_error_action error_action;
463 int set_frame_annotation;
466 int dpni_set_errors_behavior(struct fsl_mc_io *mc_io,
469 struct dpni_error_cfg *cfg);
472 * DPNI buffer layout modification options
476 * Select to modify the time-stamp setting
478 #define DPNI_BUF_LAYOUT_OPT_TIMESTAMP 0x00000001
480 * Select to modify the parser-result setting; not applicable for Tx
482 #define DPNI_BUF_LAYOUT_OPT_PARSER_RESULT 0x00000002
484 * Select to modify the frame-status setting
486 #define DPNI_BUF_LAYOUT_OPT_FRAME_STATUS 0x00000004
488 * Select to modify the private-data-size setting
490 #define DPNI_BUF_LAYOUT_OPT_PRIVATE_DATA_SIZE 0x00000008
492 * Select to modify the data-alignment setting
494 #define DPNI_BUF_LAYOUT_OPT_DATA_ALIGN 0x00000010
496 * Select to modify the data-head-room setting
498 #define DPNI_BUF_LAYOUT_OPT_DATA_HEAD_ROOM 0x00000020
500 * Select to modify the data-tail-room setting
502 #define DPNI_BUF_LAYOUT_OPT_DATA_TAIL_ROOM 0x00000040
504 * Select to modify the sw-opaque value setting
506 #define DPNI_BUF_LAYOUT_OPT_SW_OPAQUE 0x00000080
508 * Select to disable Scatter Gather and use single buffer
510 #define DPNI_BUF_LAYOUT_OPT_NO_SG 0x00000100
513 * struct dpni_buffer_layout - Structure representing DPNI buffer layout
514 * @options: Flags representing the suggested modifications to the
516 * Use any combination of 'DPNI_BUF_LAYOUT_OPT_<X>' flags
517 * @pass_timestamp: Pass timestamp value
518 * @pass_parser_result: Pass parser results
519 * @pass_frame_status: Pass frame status
520 * @private_data_size: Size kept for private data (in bytes)
521 * @data_align: Data alignment
522 * @data_head_room: Data head room
523 * @data_tail_room: Data tail room
525 struct dpni_buffer_layout {
528 int pass_parser_result;
529 int pass_frame_status;
531 uint16_t private_data_size;
533 uint16_t data_head_room;
534 uint16_t data_tail_room;
538 * enum dpni_queue_type - Identifies a type of queue targeted by the command
539 * @DPNI_QUEUE_RX: Rx queue
540 * @DPNI_QUEUE_TX: Tx queue
541 * @DPNI_QUEUE_TX_CONFIRM: Tx confirmation queue
542 * @DPNI_QUEUE_RX_ERR: Rx error queue
544 enum dpni_queue_type {
547 DPNI_QUEUE_TX_CONFIRM,
551 int dpni_get_buffer_layout(struct fsl_mc_io *mc_io,
554 enum dpni_queue_type qtype,
555 struct dpni_buffer_layout *layout);
557 int dpni_set_buffer_layout(struct fsl_mc_io *mc_io,
560 enum dpni_queue_type qtype,
561 const struct dpni_buffer_layout *layout);
564 * enum dpni_offload - Identifies a type of offload targeted by the command
565 * @DPNI_OFF_RX_L3_CSUM: Rx L3 checksum validation
566 * @DPNI_OFF_RX_L4_CSUM: Rx L4 checksum validation
567 * @DPNI_OFF_TX_L3_CSUM: Tx L3 checksum generation
568 * @DPNI_OFF_TX_L4_CSUM: Tx L4 checksum generation
569 * @DPNI_OPT_FLCTYPE_HASH: flow context will be generated by WRIOP for AIOP or
580 int dpni_set_offload(struct fsl_mc_io *mc_io,
583 enum dpni_offload type,
586 int dpni_get_offload(struct fsl_mc_io *mc_io,
589 enum dpni_offload type,
592 int dpni_get_qdid(struct fsl_mc_io *mc_io,
595 enum dpni_queue_type qtype,
598 int dpni_get_tx_data_offset(struct fsl_mc_io *mc_io,
601 uint16_t *data_offset);
603 #define DPNI_STATISTICS_CNT 7
606 * union dpni_statistics - Union describing the DPNI statistics
607 * @page_0: Page_0 statistics structure
608 * @page_0.ingress_all_frames: Ingress frame count
609 * @page_0.ingress_all_bytes: Ingress byte count
610 * @page_0.ingress_multicast_frames: Ingress multicast frame count
611 * @page_0.ingress_multicast_bytes: Ingress multicast byte count
612 * @page_0.ingress_broadcast_frames: Ingress broadcast frame count
613 * @page_0.ingress_broadcast_bytes: Ingress broadcast byte count
614 * @page_1: Page_1 statistics structure
615 * @page_1.egress_all_frames: Egress frame count
616 * @page_1.egress_all_bytes: Egress byte count
617 * @page_1.egress_multicast_frames: Egress multicast frame count
618 * @page_1.egress_multicast_bytes: Egress multicast byte count
619 * @page_1.egress_broadcast_frames: Egress broadcast frame count
620 * @page_1.egress_broadcast_bytes: Egress broadcast byte count
621 * @page_2: Page_2 statistics structure
622 * @page_2.ingress_filtered_frames: Ingress filtered frame count
623 * @page_2.ingress_discarded_frames: Ingress discarded frame count
624 * @page_2.ingress_nobuffer_discards: Ingress discarded frame count due to
626 * @page_2.egress_discarded_frames: Egress discarded frame count
627 * @page_2.egress_confirmed_frames: Egress confirmed frame count
628 * @page_3: Page_3 statistics structure with values for the selected TC
629 * @page_3.ceetm_dequeue_bytes: Cumulative count of the number of bytes dequeued
630 * @page_3.ceetm_dequeue_frames: Cumulative count of the number of frames
632 * @page_3.ceetm_reject_bytes: Cumulative count of the number of bytes in all
633 * frames whose enqueue was rejected
634 * @page_3.ceetm_reject_frames: Cumulative count of all frame enqueues rejected
635 * @page_4: congestion point drops for selected TC
636 * @page_4.cgr_reject_frames: number of rejected frames due to congestion point
637 * @page_4.cgr_reject_bytes: number of rejected bytes due to congestion point
638 * @page_5: policer statistics per TC
639 * @page_5.policer_cnt_red: NUmber of red colored frames
640 * @page_5.policer_cnt_yellow: number of yellow colored frames
641 * @page_5.policer_cnt_green: number of green colored frames
642 * @page_5.policer_cnt_re_red: number of recolored red frames
643 * @page_5.policer_cnt_re_yellow: number of recolored yellow frames
644 * @page_6.tx_pending_frames_cnt: total number of frames pending in Tx queues
645 * @raw: raw statistics structure, used to index counters
647 union dpni_statistics {
649 uint64_t ingress_all_frames;
650 uint64_t ingress_all_bytes;
651 uint64_t ingress_multicast_frames;
652 uint64_t ingress_multicast_bytes;
653 uint64_t ingress_broadcast_frames;
654 uint64_t ingress_broadcast_bytes;
657 uint64_t egress_all_frames;
658 uint64_t egress_all_bytes;
659 uint64_t egress_multicast_frames;
660 uint64_t egress_multicast_bytes;
661 uint64_t egress_broadcast_frames;
662 uint64_t egress_broadcast_bytes;
665 uint64_t ingress_filtered_frames;
666 uint64_t ingress_discarded_frames;
667 uint64_t ingress_nobuffer_discards;
668 uint64_t egress_discarded_frames;
669 uint64_t egress_confirmed_frames;
672 uint64_t ceetm_dequeue_bytes;
673 uint64_t ceetm_dequeue_frames;
674 uint64_t ceetm_reject_bytes;
675 uint64_t ceetm_reject_frames;
678 uint64_t cgr_reject_frames;
679 uint64_t cgr_reject_bytes;
682 uint64_t policer_cnt_red;
683 uint64_t policer_cnt_yellow;
684 uint64_t policer_cnt_green;
685 uint64_t policer_cnt_re_red;
686 uint64_t policer_cnt_re_yellow;
689 uint64_t tx_pending_frames_cnt;
692 uint64_t counter[DPNI_STATISTICS_CNT];
697 * Enable auto-negotiation
699 #define DPNI_LINK_OPT_AUTONEG 0x0000000000000001ULL
701 * Enable half-duplex mode
703 #define DPNI_LINK_OPT_HALF_DUPLEX 0x0000000000000002ULL
705 * Enable pause frames
707 #define DPNI_LINK_OPT_PAUSE 0x0000000000000004ULL
709 * Enable a-symmetric pause frames
711 #define DPNI_LINK_OPT_ASYM_PAUSE 0x0000000000000008ULL
713 * Enable priority flow control pause frames
715 #define DPNI_LINK_OPT_PFC_PAUSE 0x0000000000000010ULL
718 * Advertise 10MB full duplex
720 #define DPNI_ADVERTISED_10BASET_FULL 0x0000000000000001ULL
722 * Advertise 100MB full duplex
724 #define DPNI_ADVERTISED_100BASET_FULL 0x0000000000000002ULL
726 * Advertise 1GB full duplex
728 #define DPNI_ADVERTISED_1000BASET_FULL 0x0000000000000004ULL
730 * Advertise auto-negotiation enable
732 #define DPNI_ADVERTISED_AUTONEG 0x0000000000000008ULL
734 * Advertise 10GB full duplex
736 #define DPNI_ADVERTISED_10000BASET_FULL 0x0000000000000010ULL
738 * Advertise 2.5GB full duplex
740 #define DPNI_ADVERTISED_2500BASEX_FULL 0x0000000000000020ULL
742 * Advertise 5GB full duplex
744 #define DPNI_ADVERTISED_5000BASET_FULL 0x0000000000000040ULL
748 * struct - Structure representing DPNI link configuration
750 * @options: Mask of available options; use 'DPNI_LINK_OPT_<X>' values
751 * @advertising: Speeds that are advertised for autoneg (bitmap)
753 struct dpni_link_cfg {
756 uint64_t advertising;
759 int dpni_set_link_cfg(struct fsl_mc_io *mc_io,
762 const struct dpni_link_cfg *cfg);
764 int dpni_get_link_cfg(struct fsl_mc_io *mc_io,
767 struct dpni_link_cfg *cfg);
770 * struct dpni_link_state - Structure representing DPNI link state
772 * @options: Mask of available options; use 'DPNI_LINK_OPT_<X>' values
773 * @up: Link state; '0' for down, '1' for up
774 * @state_valid: Ignore/Update the state of the link
775 * @supported: Speeds capability of the phy (bitmap)
776 * @advertising: Speeds that are advertised for autoneg (bitmap)
778 struct dpni_link_state {
784 uint64_t advertising;
787 int dpni_get_link_state(struct fsl_mc_io *mc_io,
790 struct dpni_link_state *state);
793 * struct dpni_tx_shaping - Structure representing DPNI tx shaping configuration
794 * @rate_limit: Rate in Mbits/s
795 * @max_burst_size: Burst size in bytes (up to 64KB)
797 struct dpni_tx_shaping_cfg {
799 uint16_t max_burst_size;
803 * Build the parameter for dpni_set_tx_shaping() call
804 * @oal: Overhead accounting length. 11bit value added to the size of
805 * each frame. Used only for LNI shaping. If set to zero, will use default
806 * value of 24. Ignored if shaping_lni is set to zero.
807 * @shaping_lni: 1 for LNI shaping (configure whole throughput of the dpni object)
808 * 0 for channel shaping (configure shaping for individual channels)
809 * Set to one only if dpni is connected to a dpmac object.
810 * @channel_id: Channel to be configured. Ignored shaping_lni is set to 1
811 * @coupled: Committed and excess rates are coupled
813 #define DPNI_TX_SHAPING_PARAM(oal, shaping_lni, channel_id, coupled) ( \
814 ((uint32_t)(((oal) & 0x7ff) << 16)) | \
815 ((uint32_t)((channel_id) & 0xff) << 8) | \
816 ((uint32_t)(!!shaping_lni) << 1) | \
817 ((uint32_t)!!coupled))
819 int dpni_set_tx_shaping(struct fsl_mc_io *mc_io,
822 const struct dpni_tx_shaping_cfg *tx_cr_shaper,
823 const struct dpni_tx_shaping_cfg *tx_er_shaper,
826 int dpni_set_max_frame_length(struct fsl_mc_io *mc_io,
829 uint16_t max_frame_length);
831 int dpni_get_max_frame_length(struct fsl_mc_io *mc_io,
834 uint16_t *max_frame_length);
836 int dpni_set_mtu(struct fsl_mc_io *mc_io,
841 int dpni_get_mtu(struct fsl_mc_io *mc_io,
846 int dpni_set_multicast_promisc(struct fsl_mc_io *mc_io,
851 int dpni_get_multicast_promisc(struct fsl_mc_io *mc_io,
856 int dpni_set_unicast_promisc(struct fsl_mc_io *mc_io,
861 int dpni_get_unicast_promisc(struct fsl_mc_io *mc_io,
866 int dpni_set_primary_mac_addr(struct fsl_mc_io *mc_io,
869 const uint8_t mac_addr[6]);
871 int dpni_get_primary_mac_addr(struct fsl_mc_io *mc_io,
874 uint8_t mac_addr[6]);
877 * Set mac addr queue action
879 #define DPNI_MAC_SET_QUEUE_ACTION 1
881 int dpni_add_mac_addr(struct fsl_mc_io *mc_io,
884 const uint8_t mac_addr[6],
889 int dpni_remove_mac_addr(struct fsl_mc_io *mc_io,
892 const uint8_t mac_addr[6]);
894 int dpni_clear_mac_filters(struct fsl_mc_io *mc_io,
900 int dpni_get_port_mac_addr(struct fsl_mc_io *mc_io,
903 uint8_t mac_addr[6]);
905 int dpni_enable_vlan_filter(struct fsl_mc_io *mc_io,
911 * Set vlan filter queue action
913 #define DPNI_VLAN_SET_QUEUE_ACTION 1
915 int dpni_add_vlan_id(struct fsl_mc_io *mc_io,
923 int dpni_remove_vlan_id(struct fsl_mc_io *mc_io,
928 int dpni_clear_vlan_filters(struct fsl_mc_io *mc_io,
933 * enum dpni_tx_schedule_mode - DPNI Tx scheduling mode
934 * @DPNI_TX_SCHED_STRICT_PRIORITY: strict priority
935 * @DPNI_TX_SCHED_WEIGHTED_A: weighted based scheduling in group A
936 * @DPNI_TX_SCHED_WEIGHTED_B: weighted based scheduling in group B
938 enum dpni_tx_schedule_mode {
939 DPNI_TX_SCHED_STRICT_PRIORITY = 0,
940 DPNI_TX_SCHED_WEIGHTED_A,
941 DPNI_TX_SCHED_WEIGHTED_B,
945 * struct dpni_tx_schedule_cfg - Structure representing Tx scheduling conf
946 * @mode: Scheduling mode
947 * @delta_bandwidth: Bandwidth represented in weights from 100 to 10000;
948 * not applicable for 'strict-priority' mode;
950 struct dpni_tx_schedule_cfg {
951 enum dpni_tx_schedule_mode mode;
952 uint16_t delta_bandwidth;
956 * struct dpni_tx_priorities_cfg - Structure representing transmission
957 * priorities for DPNI TCs
958 * @channel_idx: channel to perform the configuration
959 * @tc_sched: An array of traffic-classes
960 * @prio_group_A: Priority of group A
961 * @prio_group_B: Priority of group B
962 * @separate_groups: Treat A and B groups as separate
964 struct dpni_tx_priorities_cfg {
966 struct dpni_tx_schedule_cfg tc_sched[DPNI_MAX_TC];
967 uint32_t prio_group_A;
968 uint32_t prio_group_B;
969 uint8_t separate_groups;
972 int dpni_set_tx_priorities(struct fsl_mc_io *mc_io,
975 const struct dpni_tx_priorities_cfg *cfg);
978 * enum dpni_dist_mode - DPNI distribution mode
979 * @DPNI_DIST_MODE_NONE: No distribution
980 * @DPNI_DIST_MODE_HASH: Use hash distribution; only relevant if
981 * the 'DPNI_OPT_DIST_HASH' option was set at DPNI creation
982 * @DPNI_DIST_MODE_FS: Use explicit flow steering; only relevant if
983 * the 'DPNI_OPT_DIST_FS' option was set at DPNI creation
985 enum dpni_dist_mode {
986 DPNI_DIST_MODE_NONE = 0,
987 DPNI_DIST_MODE_HASH = 1,
988 DPNI_DIST_MODE_FS = 2
992 * enum dpni_fs_miss_action - DPNI Flow Steering miss action
993 * @DPNI_FS_MISS_DROP: In case of no-match, drop the frame
994 * @DPNI_FS_MISS_EXPLICIT_FLOWID: In case of no-match, use explicit flow-id
995 * @DPNI_FS_MISS_HASH: In case of no-match, distribute using hash
997 enum dpni_fs_miss_action {
998 DPNI_FS_MISS_DROP = 0,
999 DPNI_FS_MISS_EXPLICIT_FLOWID = 1,
1000 DPNI_FS_MISS_HASH = 2
1004 * struct dpni_fs_tbl_cfg - Flow Steering table configuration
1005 * @miss_action: Miss action selection
1006 * @default_flow_id: Used when 'miss_action = DPNI_FS_MISS_EXPLICIT_FLOWID'
1007 * @keep_hash_key: used only when miss_action is set to DPNI_FS_MISS_HASH. When
1008 * set to one unclassified frames will be distributed according to previous
1009 * used hash key. If set to zero hash key will be replaced with the key
1010 * provided for flow steering.
1011 * @keep_entries: if set to one command will not delete the entries that already
1012 * exist into FS table. Use this option with caution: if the table
1013 * entries are not compatible with the distribution key the packets
1014 * will not be classified properly.
1016 struct dpni_fs_tbl_cfg {
1017 enum dpni_fs_miss_action miss_action;
1018 uint16_t default_flow_id;
1020 uint8_t keep_entries;
1024 * struct dpni_rx_tc_dist_cfg - Rx traffic class distribution configuration
1025 * @dist_size: Set the distribution size;
1026 * supported values: 1,2,3,4,6,7,8,12,14,16,24,28,32,48,56,64,96,
1027 * 112,128,192,224,256,384,448,512,768,896,1024
1028 * @dist_mode: Distribution mode
1029 * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
1030 * the extractions to be used for the distribution key by calling
1031 * dpkg_prepare_key_cfg() relevant only when
1032 * 'dist_mode != DPNI_DIST_MODE_NONE', otherwise it can be '0'
1033 * @fs_cfg: Flow Steering table configuration; only relevant if
1034 * 'dist_mode = DPNI_DIST_MODE_FS'
1036 struct dpni_rx_tc_dist_cfg {
1038 enum dpni_dist_mode dist_mode;
1039 uint64_t key_cfg_iova;
1040 struct dpni_fs_tbl_cfg fs_cfg;
1043 int dpni_set_rx_tc_dist(struct fsl_mc_io *mc_io,
1047 const struct dpni_rx_tc_dist_cfg *cfg);
1050 * Set to select color aware mode (otherwise - color blind)
1052 #define DPNI_POLICER_OPT_COLOR_AWARE 0x00000001
1054 * Set to discard frame with RED color
1056 #define DPNI_POLICER_OPT_DISCARD_RED 0x00000002
1059 * enum dpni_policer_mode - selecting the policer mode
1060 * @DPNI_POLICER_MODE_NONE: Policer is disabled
1061 * @DPNI_POLICER_MODE_PASS_THROUGH: Policer pass through
1062 * @DPNI_POLICER_MODE_RFC_2698: Policer algorithm RFC 2698
1063 * @DPNI_POLICER_MODE_RFC_4115: Policer algorithm RFC 4115
1065 enum dpni_policer_mode {
1066 DPNI_POLICER_MODE_NONE = 0,
1067 DPNI_POLICER_MODE_PASS_THROUGH,
1068 DPNI_POLICER_MODE_RFC_2698,
1069 DPNI_POLICER_MODE_RFC_4115
1073 * enum dpni_policer_unit - DPNI policer units
1074 * @DPNI_POLICER_UNIT_BYTES: bytes units
1075 * @DPNI_POLICER_UNIT_FRAMES: frames units
1077 enum dpni_policer_unit {
1078 DPNI_POLICER_UNIT_BYTES = 0,
1079 DPNI_POLICER_UNIT_FRAMES
1083 * enum dpni_policer_color - selecting the policer color
1084 * @DPNI_POLICER_COLOR_GREEN: Green color
1085 * @DPNI_POLICER_COLOR_YELLOW: Yellow color
1086 * @DPNI_POLICER_COLOR_RED: Red color
1088 enum dpni_policer_color {
1089 DPNI_POLICER_COLOR_GREEN = 0,
1090 DPNI_POLICER_COLOR_YELLOW,
1091 DPNI_POLICER_COLOR_RED
1095 * struct dpni_rx_tc_policing_cfg - Policer configuration
1096 * @options: Mask of available options; use 'DPNI_POLICER_OPT_<X>' values
1097 * @mode: policer mode
1098 * @default_color: For pass-through mode the policer re-colors with this
1099 * color any incoming packets. For Color aware non-pass-through mode:
1100 * policer re-colors with this color all packets with FD[DROPP]>2.
1101 * @units: Bytes or Packets
1102 * @cir: Committed information rate (CIR) in Kbps or packets/second
1103 * @cbs: Committed burst size (CBS) in bytes or packets
1104 * @eir: Peak information rate (PIR, rfc2698) in Kbps or packets/second
1105 * Excess information rate (EIR, rfc4115) in Kbps or packets/second
1106 * @ebs: Peak burst size (PBS, rfc2698) in bytes or packets
1107 * Excess burst size (EBS, rfc4115) in bytes or packets
1109 struct dpni_rx_tc_policing_cfg {
1111 enum dpni_policer_mode mode;
1112 enum dpni_policer_unit units;
1113 enum dpni_policer_color default_color;
1121 int dpni_set_rx_tc_policing(struct fsl_mc_io *mc_io,
1125 const struct dpni_rx_tc_policing_cfg *cfg);
1127 int dpni_get_rx_tc_policing(struct fsl_mc_io *mc_io,
1131 struct dpni_rx_tc_policing_cfg *cfg);
1134 * enum dpni_congestion_unit - DPNI congestion units
1135 * @DPNI_CONGESTION_UNIT_BYTES: bytes units
1136 * @DPNI_CONGESTION_UNIT_FRAMES: frames units
1138 enum dpni_congestion_unit {
1139 DPNI_CONGESTION_UNIT_BYTES = 0,
1140 DPNI_CONGESTION_UNIT_FRAMES
1144 * enum dpni_early_drop_mode - DPNI early drop mode
1145 * @DPNI_EARLY_DROP_MODE_NONE: early drop is disabled
1146 * @DPNI_EARLY_DROP_MODE_TAIL: early drop in taildrop mode
1147 * @DPNI_EARLY_DROP_MODE_WRED: early drop in WRED mode
1149 enum dpni_early_drop_mode {
1150 DPNI_EARLY_DROP_MODE_NONE = 0,
1151 DPNI_EARLY_DROP_MODE_TAIL,
1152 DPNI_EARLY_DROP_MODE_WRED
1156 * struct dpni_wred_cfg - WRED configuration
1157 * @max_threshold: maximum threshold that packets may be discarded. Above this
1158 * threshold all packets are discarded; must be less than 2^39;
1159 * approximated to be expressed as (x+256)*2^(y-1) due to HW
1161 * @min_threshold: minimum threshold that packets may be discarded at
1162 * @drop_probability: probability that a packet will be discarded (1-100,
1163 * associated with the max_threshold).
1165 struct dpni_wred_cfg {
1166 uint64_t max_threshold;
1167 uint64_t min_threshold;
1168 uint8_t drop_probability;
1172 * struct dpni_early_drop_cfg - early-drop configuration
1173 * @enable: drop enable
1174 * @units: units type
1175 * @green: WRED - 'green' configuration
1176 * @yellow: WRED - 'yellow' configuration
1177 * @red: WRED - 'red' configuration
1179 struct dpni_early_drop_cfg {
1181 enum dpni_congestion_unit units;
1182 struct dpni_wred_cfg green;
1183 struct dpni_wred_cfg yellow;
1184 struct dpni_wred_cfg red;
1187 void dpni_prepare_early_drop(const struct dpni_early_drop_cfg *cfg,
1188 uint8_t *early_drop_buf);
1190 void dpni_extract_early_drop(struct dpni_early_drop_cfg *cfg,
1191 const uint8_t *early_drop_buf);
1193 int dpni_set_early_drop(struct fsl_mc_io *mc_io,
1196 enum dpni_queue_type qtype,
1198 uint64_t early_drop_iova);
1200 int dpni_get_early_drop(struct fsl_mc_io *mc_io,
1203 enum dpni_queue_type qtype,
1205 uint64_t early_drop_iova);
1208 * enum dpni_dest - DPNI destination types
1209 * @DPNI_DEST_NONE: Unassigned destination; The queue is set in parked mode and
1210 * does not generate FQDAN notifications; user is expected to
1211 * dequeue from the queue based on polling or other user-defined
1213 * @DPNI_DEST_DPIO: The queue is set in schedule mode and generates FQDAN
1214 * notifications to the specified DPIO; user is expected to dequeue
1215 * from the queue only after notification is received
1216 * @DPNI_DEST_DPCON: The queue is set in schedule mode and does not generate
1217 * FQDAN notifications, but is connected to the specified DPCON
1218 * object; user is expected to dequeue from the DPCON channel
1227 * struct dpni_dest_cfg - Structure representing DPNI destination parameters
1228 * @dest_type: Destination type
1229 * @dest_id: Either DPIO ID or DPCON ID, depending on the destination type
1230 * @priority: Priority selection within the DPIO or DPCON channel; valid values
1231 * are 0-1 or 0-7, depending on the number of priorities in that
1232 * channel; not relevant for 'DPNI_DEST_NONE' option
1234 struct dpni_dest_cfg {
1235 enum dpni_dest dest_type;
1240 /* DPNI congestion options */
1243 * CSCN message is written to message_iova once entering a
1244 * congestion state (see 'threshold_entry')
1246 #define DPNI_CONG_OPT_WRITE_MEM_ON_ENTER 0x00000001
1248 * CSCN message is written to message_iova once exiting a
1249 * congestion state (see 'threshold_exit')
1251 #define DPNI_CONG_OPT_WRITE_MEM_ON_EXIT 0x00000002
1253 * CSCN write will attempt to allocate into a cache (coherent write);
1254 * valid only if 'DPNI_CONG_OPT_WRITE_MEM_<X>' is selected
1256 #define DPNI_CONG_OPT_COHERENT_WRITE 0x00000004
1258 * if 'dest_cfg.dest_type != DPNI_DEST_NONE' CSCN message is sent to
1259 * DPIO/DPCON's WQ channel once entering a congestion state
1260 * (see 'threshold_entry')
1262 #define DPNI_CONG_OPT_NOTIFY_DEST_ON_ENTER 0x00000008
1264 * if 'dest_cfg.dest_type != DPNI_DEST_NONE' CSCN message is sent to
1265 * DPIO/DPCON's WQ channel once exiting a congestion state
1266 * (see 'threshold_exit')
1268 #define DPNI_CONG_OPT_NOTIFY_DEST_ON_EXIT 0x00000010
1270 * if 'dest_cfg.dest_type != DPNI_DEST_NONE' when the CSCN is written to the
1271 * sw-portal's DQRR, the DQRI interrupt is asserted immediately (if enabled)
1273 #define DPNI_CONG_OPT_INTR_COALESCING_DISABLED 0x00000020
1275 * This congestion will trigger flow control or priority flow control. This
1276 * will have effect only if flow control is enabled with dpni_set_link_cfg()
1278 #define DPNI_CONG_OPT_FLOW_CONTROL 0x00000040
1281 * enum dpni_congestion_point - Structure representing congestion point
1282 * @DPNI_CP_QUEUE: Set congestion per queue, identified by QUEUE_TYPE, TC
1284 * @DPNI_CP_GROUP: Set congestion per queue group. Depending on options
1285 * used to define the DPNI this can be either per
1286 * TC (default) or per interface
1287 * (DPNI_OPT_SHARED_CONGESTION set at DPNI create).
1288 * QUEUE_INDEX is ignored if this type is used.
1289 * @DPNI_CP_CONGESTION_GROUP: Set per congestion group id. This will work
1290 * only if the DPNI is created with DPNI_OPT_CUSTOM_CG option
1293 enum dpni_congestion_point {
1296 DPNI_CP_CONGESTION_GROUP,
1300 * struct dpni_congestion_notification_cfg - congestion notification
1302 * @units: units type
1303 * @threshold_entry: above this threshold we enter a congestion state.
1304 * set it to '0' to disable it
1305 * @threshold_exit: below this threshold we exit the congestion state.
1306 * @message_ctx: The context that will be part of the CSCN message
1307 * @message_iova: I/O virtual address (must be in DMA-able memory),
1308 * must be 16B aligned; valid only if 'DPNI_CONG_OPT_WRITE_MEM_<X>' is
1309 * contained in 'options'
1310 * @dest_cfg: CSCN can be send to either DPIO or DPCON WQ channel
1311 * @notification_mode: Mask of available options; use 'DPNI_CONG_OPT_<X>' values
1312 * @cg_point: Congestion point settings
1313 * @cgid: id of the congestion group. The index is relative to dpni.
1316 struct dpni_congestion_notification_cfg {
1317 enum dpni_congestion_unit units;
1318 uint32_t threshold_entry;
1319 uint32_t threshold_exit;
1320 uint64_t message_ctx;
1321 uint64_t message_iova;
1322 struct dpni_dest_cfg dest_cfg;
1323 uint16_t notification_mode;
1324 enum dpni_congestion_point cg_point;
1328 int dpni_set_congestion_notification(struct fsl_mc_io *mc_io,
1331 enum dpni_queue_type qtype,
1333 const struct dpni_congestion_notification_cfg *cfg);
1335 int dpni_get_congestion_notification(struct fsl_mc_io *mc_io,
1338 enum dpni_queue_type qtype,
1340 struct dpni_congestion_notification_cfg *cfg);
1342 /* DPNI FLC stash options */
1345 * stashes the whole annotation area (up to 192 bytes)
1347 #define DPNI_FLC_STASH_FRAME_ANNOTATION 0x00000001
1350 * struct dpni_queue - Queue structure
1351 * @destination - Destination structure
1352 * @destination.id: ID of the destination, only relevant if DEST_TYPE is > 0.
1353 * Identifies either a DPIO or a DPCON object.
1354 * Not relevant for Tx queues.
1355 * @destination.type: May be one of the following:
1356 * 0 - No destination, queue can be manually
1357 * queried, but will not push traffic or
1358 * notifications to a DPIO;
1359 * 1 - The destination is a DPIO. When traffic
1360 * becomes available in the queue a FQDAN
1361 * (FQ data available notification) will be
1362 * generated to selected DPIO;
1363 * 2 - The destination is a DPCON. The queue is
1364 * associated with a DPCON object for the
1365 * purpose of scheduling between multiple
1366 * queues. The DPCON may be independently
1367 * configured to generate notifications.
1368 * Not relevant for Tx queues.
1369 * @destination.hold_active: Hold active, maintains a queue scheduled for longer
1370 * in a DPIO during dequeue to reduce spread of traffic.
1371 * Only relevant if queues are
1372 * not affined to a single DPIO.
1373 * @user_context: User data, presented to the user along with any frames
1374 * from this queue. Not relevant for Tx queues.
1375 * @flc: FD FLow Context structure
1376 * @flc.value: Default FLC value for traffic dequeued from
1377 * this queue. Please check description of FD
1378 * structure for more information.
1379 * Note that FLC values set using dpni_add_fs_entry,
1380 * if any, take precedence over values per queue.
1381 * @flc.stash_control: Boolean, indicates whether the 6 lowest
1382 * - significant bits are used for stash control.
1383 * significant bits are used for stash control. If set, the 6
1384 * least significant bits in value are interpreted as follows:
1385 * - bits 0-1: indicates the number of 64 byte units of context
1386 * that are stashed. FLC value is interpreted as a memory address
1387 * in this case, excluding the 6 LS bits.
1388 * - bits 2-3: indicates the number of 64 byte units of frame
1389 * annotation to be stashed. Annotation is placed at FD[ADDR].
1390 * - bits 4-5: indicates the number of 64 byte units of frame
1391 * data to be stashed. Frame data is placed at FD[ADDR] +
1393 * For more details check the Frame Descriptor section in the
1394 * hardware documentation.
1395 *@cgid :indicate the cgid to set relative to dpni
1400 enum dpni_dest type;
1404 uint64_t user_context;
1413 * struct dpni_queue_id - Queue identification, used for enqueue commands
1415 * @fqid: FQID used for enqueueing to and/or configuration of this
1417 * @qdbin: Queueing bin, used to enqueue using QDID, DQBIN, QPRI.
1418 * Only relevant for Tx queues.
1420 struct dpni_queue_id {
1426 * enum dpni_confirmation_mode - Defines DPNI options supported for Tx
1428 * @DPNI_CONF_AFFINE: For each Tx queue set associated with a sender there is
1429 * an affine Tx Confirmation queue
1430 * @DPNI_CONF_SINGLE: All Tx queues are associated with a single Tx
1431 * confirmation queue
1432 * @DPNI_CONF_DISABLE: Tx frames are not confirmed. This must be associated
1433 * with proper FD set-up to have buffers release to a Buffer Pool, otherwise
1434 * buffers will be leaked
1436 enum dpni_confirmation_mode {
1442 int dpni_set_tx_confirmation_mode(struct fsl_mc_io *mc_io,
1445 enum dpni_confirmation_mode mode);
1447 int dpni_get_tx_confirmation_mode(struct fsl_mc_io *mc_io,
1450 enum dpni_confirmation_mode *mode);
1453 * struct dpni_qos_tbl_cfg - Structure representing QOS table configuration
1454 * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
1455 * key extractions to be used as the QoS criteria by calling
1456 * dpkg_prepare_key_cfg()
1457 * @discard_on_miss: Set to '1' to discard frames in case of no match (miss);
1458 * '0' to use the 'default_tc' in such cases
1459 * @keep_entries: if set to one will not delete existing table entries. This
1460 * option will work properly only for dpni objects created with
1461 * DPNI_OPT_HAS_KEY_MASKING option. All previous QoS entries must
1462 * be compatible with new key composition rule.
1463 * It is the caller's job to delete incompatible entries before
1464 * executing this function.
1465 * @default_tc: Used in case of no-match and 'discard_on_miss'= 0
1467 struct dpni_qos_tbl_cfg {
1468 uint64_t key_cfg_iova;
1469 int discard_on_miss;
1474 int dpni_set_qos_table(struct fsl_mc_io *mc_io,
1477 const struct dpni_qos_tbl_cfg *cfg);
1480 * struct dpni_rule_cfg - Rule configuration for table lookup
1481 * @key_iova: I/O virtual address of the key (must be in DMA-able memory)
1482 * @mask_iova: I/O virtual address of the mask (must be in DMA-able memory)
1483 * @key_size: key and mask size (in bytes)
1485 struct dpni_rule_cfg {
1491 int dpni_add_qos_entry(struct fsl_mc_io *mc_io,
1494 const struct dpni_rule_cfg *cfg,
1500 int dpni_remove_qos_entry(struct fsl_mc_io *mc_io,
1503 const struct dpni_rule_cfg *cfg);
1505 int dpni_clear_qos_table(struct fsl_mc_io *mc_io,
1510 * Discard matching traffic. If set, this takes precedence over any other
1511 * configuration and matching traffic is always discarded.
1513 #define DPNI_FS_OPT_DISCARD 0x1
1516 * Set FLC value. If set, flc member of truct dpni_fs_action_cfg is used to
1517 * override the FLC value set per queue.
1518 * For more details check the Frame Descriptor section in the hardware
1521 #define DPNI_FS_OPT_SET_FLC 0x2
1524 * Indicates whether the 6 lowest significant bits of FLC are used for stash
1525 * control. If set, the 6 least significant bits in value are interpreted as
1527 * - bits 0-1: indicates the number of 64 byte units of context that are
1528 * stashed. FLC value is interpreted as a memory address in this case,
1529 * excluding the 6 LS bits.
1530 * - bits 2-3: indicates the number of 64 byte units of frame annotation
1531 * to be stashed. Annotation is placed at FD[ADDR].
1532 * - bits 4-5: indicates the number of 64 byte units of frame data to be
1533 * stashed. Frame data is placed at FD[ADDR] + FD[OFFSET].
1534 * This flag is ignored if DPNI_FS_OPT_SET_FLC is not specified.
1536 #define DPNI_FS_OPT_SET_STASH_CONTROL 0x4
1539 * Redirect matching traffic to Rx part of another dpni object. The frame
1540 * will be classified according to new qos and flow steering rules from
1541 * target dpni object.
1543 #define DPNI_FS_OPT_REDIRECT_TO_DPNI_RX 0x08
1546 * Redirect matching traffic into Tx queue of another dpni object. The
1547 * frame will be transmitted directly
1549 #define DPNI_FS_OPT_REDIRECT_TO_DPNI_TX 0x10
1552 * struct dpni_fs_action_cfg - Action configuration for table look-up
1553 * @flc: FLC value for traffic matching this rule. Please check the Frame
1554 * Descriptor section in the hardware documentation for more information.
1555 * @flow_id: Identifies the Rx queue used for matching traffic. Supported
1556 * values are in range 0 to num_queue-1.
1557 * @redirect_obj_token: token that identifies the object where frame is
1558 * redirected when this rule is hit. This parameter is used only when one of the
1559 * flags DPNI_FS_OPT_REDIRECT_TO_DPNI_RX or DPNI_FS_OPT_REDIRECT_TO_DPNI_TX is
1561 * The token is obtained using dpni_open() API call. The object must stay
1562 * open during the operation to ensure the fact that application has access
1563 * on it. If the object is destroyed of closed next actions will take place:
1564 * - if DPNI_FS_OPT_DISCARD is set the frame will be discarded by current dpni
1565 * - if DPNI_FS_OPT_DISCARD is cleared the frame will be enqueued in queue with
1566 * index provided in flow_id parameter.
1567 * @options: Any combination of DPNI_FS_OPT_ values.
1569 struct dpni_fs_action_cfg {
1572 uint16_t redirect_obj_token;
1576 int dpni_add_fs_entry(struct fsl_mc_io *mc_io,
1581 const struct dpni_rule_cfg *cfg,
1582 const struct dpni_fs_action_cfg *action);
1584 int dpni_remove_fs_entry(struct fsl_mc_io *mc_io,
1588 const struct dpni_rule_cfg *cfg);
1590 int dpni_clear_fs_entries(struct fsl_mc_io *mc_io,
1595 int dpni_get_api_version(struct fsl_mc_io *mc_io,
1597 uint16_t *major_ver,
1598 uint16_t *minor_ver);
1603 #define DPNI_QUEUE_OPT_USER_CTX 0x00000001
1606 * Set queue destination configuration
1608 #define DPNI_QUEUE_OPT_DEST 0x00000002
1611 * Set FD[FLC] configuration for traffic on this queue. Note that FLC values
1612 * set with dpni_add_fs_entry, if any, take precedence over values per queue.
1614 #define DPNI_QUEUE_OPT_FLC 0x00000004
1617 * Set the queue to hold active mode. This prevents the queue from being
1618 * rescheduled between DPIOs while it carries traffic and is active on one
1619 * DPNI. Can help reduce reordering when servicing one queue on multiple
1620 * CPUs, but the queue is also less likely to push data to multiple CPUs
1621 * especially when congested.
1623 #define DPNI_QUEUE_OPT_HOLD_ACTIVE 0x00000008
1625 #define DPNI_QUEUE_OPT_SET_CGID 0x00000040
1626 #define DPNI_QUEUE_OPT_CLEAR_CGID 0x00000080
1628 int dpni_set_queue(struct fsl_mc_io *mc_io,
1631 enum dpni_queue_type qtype,
1635 const struct dpni_queue *queue);
1637 int dpni_get_queue(struct fsl_mc_io *mc_io,
1640 enum dpni_queue_type qtype,
1643 struct dpni_queue *queue,
1644 struct dpni_queue_id *qid);
1646 int dpni_get_statistics(struct fsl_mc_io *mc_io,
1651 union dpni_statistics *stat);
1653 int dpni_reset_statistics(struct fsl_mc_io *mc_io,
1658 * struct dpni_taildrop - Structure representing the taildrop
1659 * @enable: Indicates whether the taildrop is active or not.
1660 * @units: Indicates the unit of THRESHOLD. Queue taildrop only
1661 * supports byte units, this field is ignored and
1662 * assumed = 0 if CONGESTION_POINT is 0.
1663 * @threshold: Threshold value, in units identified by UNITS field. Value 0
1664 * cannot be used as a valid taildrop threshold,
1665 * THRESHOLD must be > 0 if the taildrop is
1667 * @oal : Overhead Accounting Length, a 12-bit, 2's complement value
1668 * with range (-2048 to +2047) representing a fixed per-frame
1669 * overhead to be added to the actual length of a frame when
1670 * performing WRED and tail drop calculations and threshold
1673 struct dpni_taildrop {
1675 enum dpni_congestion_unit units;
1680 int dpni_set_taildrop(struct fsl_mc_io *mc_io,
1683 enum dpni_congestion_point cg_point,
1684 enum dpni_queue_type q_type,
1687 struct dpni_taildrop *taildrop);
1689 int dpni_get_taildrop(struct fsl_mc_io *mc_io,
1692 enum dpni_congestion_point cg_point,
1693 enum dpni_queue_type q_type,
1696 struct dpni_taildrop *taildrop);
1698 int dpni_set_opr(struct fsl_mc_io *mc_io,
1704 struct opr_cfg *cfg,
1707 int dpni_get_opr(struct fsl_mc_io *mc_io,
1712 struct opr_cfg *cfg,
1713 struct opr_qry *qry,
1718 * enum dpni_soft_sequence_dest - Enumeration of WRIOP software sequence
1720 * @DPNI_SS_INGRESS: Ingress parser
1721 * @DPNI_SS_EGRESS: Egress parser
1723 enum dpni_soft_sequence_dest {
1724 DPNI_SS_INGRESS = 0,
1729 * struct dpni_load_ss_cfg - Structure for Software Sequence load configuration
1730 * @dest: Destination of the Software Sequence: ingress or egress parser
1731 * @ss_size: Size of the Software Sequence
1732 * @ss_offset: The offset where to load the Software Sequence (0x20-0x7FD)
1733 * @ss_iova: I/O virtual address of the Software Sequence
1735 struct dpni_load_ss_cfg {
1736 enum dpni_soft_sequence_dest dest;
1743 * struct dpni_enable_ss_cfg - Structure for software sequence enable
1745 * @dest: Destination of the Software Sequence: ingress or egress parser
1746 * @hxs: HXS to attach the software sequence to
1747 * @set_start: If the Software Sequence or HDR it is attached to is set as
1749 * If hxs=DUMMY_LAST_HXS the ss_offset is set directly as parser
1750 * start else the hdr index code is set as parser start
1751 * @ss_offset: The offset of the Software Sequence to enable or set as parse
1753 * @param_size: Size of the software sequence parameters
1754 * @param_offset: Offset in the parameter zone for the software sequence
1756 * @param_iova: I/O virtual address of the parameters
1758 struct dpni_enable_ss_cfg {
1759 enum dpni_soft_sequence_dest dest;
1764 uint8_t param_offset;
1765 uint64_t param_iova;
1769 * dpni_load_sw_sequence() - Loads a software sequence in parser memory.
1770 * @mc_io: Pointer to MC portal's I/O object
1771 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
1772 * @token: Token of DPNI object
1773 * @cfg: Software sequence load configuration
1774 * Return: '0' on Success; Error code otherwise.
1776 int dpni_load_sw_sequence(struct fsl_mc_io *mc_io,
1779 struct dpni_load_ss_cfg *cfg);
1782 * dpni_enable_sw_sequence() - Enables a software sequence in the parser
1784 * corresponding to the ingress or egress of the DPNI.
1785 * @mc_io: Pointer to MC portal's I/O object
1786 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
1787 * @token: Token of DPNI object
1788 * @cfg: Software sequence enable configuration
1789 * Return: '0' on Success; Error code otherwise.
1791 int dpni_enable_sw_sequence(struct fsl_mc_io *mc_io,
1794 struct dpni_enable_ss_cfg *cfg);
1797 * struct dpni_sw_sequence_layout - Structure for software sequence enable
1799 * @num_ss: Number of software sequences returned
1800 * @ss: Array of software sequence entries. The number of valid entries
1801 * must match 'num_ss' value
1803 struct dpni_sw_sequence_layout {
1808 uint8_t param_offset;
1810 } ss[DPNI_SW_SEQUENCE_LAYOUT_SIZE];
1814 * dpni_get_sw_sequence_layout() - Get the soft sequence layout
1815 * @mc_io: Pointer to MC portal's I/O object
1816 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
1817 * @token: Token of DPNI object
1818 * @src: Source of the layout (WRIOP Rx or Tx)
1819 * @ss_layout_iova: I/O virtual address of 264 bytes DMA-able memory
1821 * warning: After calling this function, call dpni_extract_sw_sequence_layout()
1824 * Return: '0' on Success; error code otherwise.
1826 int dpni_get_sw_sequence_layout(struct fsl_mc_io *mc_io,
1829 enum dpni_soft_sequence_dest src,
1830 uint64_t ss_layout_iova);
1833 * dpni_extract_sw_sequence_layout() - extract the software sequence layout
1834 * @layout: software sequence layout
1835 * @sw_sequence_layout_buf:Zeroed 264 bytes of memory before mapping it to DMA
1837 * This function has to be called after dpni_get_sw_sequence_layout
1839 void dpni_extract_sw_sequence_layout(struct dpni_sw_sequence_layout *layout,
1840 const uint8_t *sw_sequence_layout_buf);
1843 * struct dpni_ptp_cfg - configure single step PTP (IEEE 1588)
1844 * @en: enable single step PTP. When enabled the PTPv1 functionality will
1845 * not work. If the field is zero, offset and ch_update parameters
1847 * @offset: start offset from the beginning of the frame where timestamp
1848 * field is found. The offset must respect all MAC headers, VLAN
1849 * tags and other protocol headers
1850 * @ch_update: when set UDP checksum will be updated inside packet
1851 * @peer_delay: For peer-to-peer transparent clocks add this value to the
1852 * correction field in addition to the transient time update. The
1853 * value expresses nanoseconds.
1855 struct dpni_single_step_cfg {
1859 uint32_t peer_delay;
1862 int dpni_set_single_step_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1863 uint16_t token, struct dpni_single_step_cfg *ptp_cfg);
1865 int dpni_get_single_step_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1866 uint16_t token, struct dpni_single_step_cfg *ptp_cfg);
1869 * loopback_en field is valid when calling function dpni_set_port_cfg
1871 #define DPNI_PORT_CFG_LOOPBACK 0x01
1874 * struct dpni_port_cfg - custom configuration for dpni physical port
1875 * @loopback_en: port loopback enabled
1877 struct dpni_port_cfg {
1881 int dpni_set_port_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1882 uint16_t token, uint32_t flags, struct dpni_port_cfg *port_cfg);
1884 int dpni_get_port_cfg(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1885 uint16_t token, struct dpni_port_cfg *port_cfg);
1888 * When used for queue_idx in function dpni_set_rx_dist_default_queue will
1889 * signal to dpni to drop all unclassified frames
1891 #define DPNI_FS_MISS_DROP ((uint16_t)-1)
1894 * struct dpni_rx_dist_cfg - distribution configuration
1895 * @dist_size: distribution size; supported values: 1,2,3,4,6,7,8,
1896 * 12,14,16,24,28,32,48,56,64,96,112,128,192,224,256,384,448,
1898 * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
1899 * the extractions to be used for the distribution key by calling
1900 * dpkg_prepare_key_cfg() relevant only when enable!=0 otherwise
1902 * @enable: enable/disable the distribution.
1903 * @tc: TC id for which distribution is set
1904 * @fs_miss_flow_id: when packet misses all rules from flow steering table and
1905 * hash is disabled it will be put into this queue id; use
1906 * DPNI_FS_MISS_DROP to drop frames. The value of this field is
1907 * used only when flow steering distribution is enabled and hash
1908 * distribution is disabled
1910 struct dpni_rx_dist_cfg {
1912 uint64_t key_cfg_iova;
1915 uint16_t fs_miss_flow_id;
1918 int dpni_set_rx_fs_dist(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1919 uint16_t token, const struct dpni_rx_dist_cfg *cfg);
1921 int dpni_set_rx_hash_dist(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1922 uint16_t token, const struct dpni_rx_dist_cfg *cfg);
1924 int dpni_add_custom_tpid(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1925 uint16_t token, uint16_t tpid);
1927 int dpni_remove_custom_tpid(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1928 uint16_t token, uint16_t tpid);
1931 * struct dpni_custom_tpid_cfg - custom TPID configuration. Contains custom TPID
1932 * values used in current dpni object to detect 802.1q frames.
1933 * @tpid1: first tag. Not used if zero.
1934 * @tpid2: second tag. Not used if zero.
1936 struct dpni_custom_tpid_cfg {
1941 int dpni_get_custom_tpid(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
1942 uint16_t token, struct dpni_custom_tpid_cfg *tpid);
1944 #endif /* __FSL_DPNI_H */