freescale/dpaa2/dpni.h

1 /* SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause) */
2 /* Copyright 2013-2016 Freescale Semiconductor Inc.
21  * Maximum number of traffic classes
25  * Maximum number of buffer pools per DPNI
32 #define DPNI_ALL_TCS				(u8)(-1)
36 #define DPNI_ALL_TC_FLOWS			(u16)(-1)
40 #define DPNI_NEW_FLOW_ID			(u16)(-1)
56  * Allocate policers for this DPNI. They can be used to rate-limit traffic per
69  * Enables TCAM for Flow Steering and QoS look-ups. If not specified, all
70  * look-ups are exact match. Note that TCAM is not available on LS1088 and its
93  * struct dpni_pools_cfg - Structure representing buffer pools configuration
94  * @num_dpbp: Number of DPBPs
95  * @pools: Array of buffer pools parameters; The number of valid entries
185  * struct dpni_attr - Structure representing DPNI attributes
193  * @num_queues: Number of Tx and Rx queues used for traffic distribution.
194  * @num_tcs: Number of traffic classes (TCs), reserved for the DPNI.
195  * @mac_filter_entries: Number of entries in the MAC address filtering table.
196  * @vlan_filter_entries: Number of entries in the VLAN address filtering table.
197  * @qos_entries: Number of entries in the QoS classification table.
198  * @fs_entries: Number of entries in the flow steering table.
199  * @qos_key_size: Size, in bytes, of the QoS look-up key. Defining a key larger
201  * @fs_key_size: Size, in bytes, of the flow steering look-up key. Defining a
230  * Extract out of frame header error
234  * Frame length error
238  * Frame physical error
255  * enum dpni_error_action - Defines DPNI behavior for errors
256  * @DPNI_ERROR_ACTION_DISCARD: Discard the frame
258  * @DPNI_ERROR_ACTION_SEND_TO_ERROR_QUEUE: Send the frame to the error queue
267  * struct dpni_error_cfg - Structure representing DPNI errors treatment
270  * @set_frame_annotation: Set to '1' to mark the errors in frame annotation
271  *		status (FAS); relevant only for the non-discard action
289  * Select to modify the time-stamp setting
293  * Select to modify the parser-result setting; not applicable for Tx
297  * Select to modify the frame-status setting
301  * Select to modify the private-data-size setting
305  * Select to modify the data-alignment setting
309  * Select to modify the data-head-room setting
313  * Select to modify the data-tail-room setting
318  * struct dpni_buffer_layout - Structure representing DPNI buffer layout
323  * @pass_frame_status: Pass frame status
341  * enum dpni_queue_type - Identifies a type of queue targeted by the command
366  * enum dpni_offload - Identifies a type of offload targeted by the command
405  * union dpni_statistics - Union describing the DPNI statistics
407  * @page_0.ingress_all_frames: Ingress frame count
409  * @page_0.ingress_multicast_frames: Ingress multicast frame count
411  * @page_0.ingress_broadcast_frames: Ingress broadcast frame count
414  * @page_1.egress_all_frames: Egress frame count
416  * @page_1.egress_multicast_frames: Egress multicast frame count
418  * @page_1.egress_broadcast_frames: Egress broadcast frame count
421  * @page_2.ingress_filtered_frames: Ingress filtered frame count
422  * @page_2.ingress_discarded_frames: Ingress discarded frame count
423  * @page_2.ingress_nobuffer_discards: Ingress discarded frame count due to
425  * @page_2.egress_discarded_frames: Egress discarded frame count
426  * @page_2.egress_confirmed_frames: Egress confirmed frame count
428  * @page_3.egress_dequeue_bytes: Cumulative count of the number of bytes
430  * @page_3.egress_dequeue_frames: Cumulative count of the number of frames
432  * @page_3.egress_reject_bytes: Cumulative count of the number of bytes in
434  * @page_3.egress_reject_frames: Cumulative count of the number of egress
437  * @page_4.cgr_reject_frames: number of rejected frames due to congestion point
438  * @page_4.cgr_reject_bytes: number of rejected bytes due to congestion point
440  * @page_5.policer_cnt_red: NUmber of red colored frames
441  * @page_5.policer_cnt_yellow: number of yellow colored frames
442  * @page_5.policer_cnt_green: number of green colored frames
443  * @page_5.policer_cnt_re_red: number of recolored red frames
444  * @page_5.policer_cnt_re_yellow: number of recolored yellow frames
446  * @page_6.tx_pending_frames: total number of frames pending in egress FQs
505  * Enable auto-negotiation
509  * Enable half-duplex mode
517  * Enable a-symmetric pause frames
527  * struct - Structure representing DPNI link configuration
547  * struct dpni_link_state - Structure representing DPNI link state
625  * enum dpni_dist_mode - DPNI distribution mode
639  * enum dpni_fs_miss_action -   DPNI Flow Steering miss action
640  * @DPNI_FS_MISS_DROP: In case of no-match, drop the frame
641  * @DPNI_FS_MISS_EXPLICIT_FLOWID: In case of no-match, use explicit flow-id
642  * @DPNI_FS_MISS_HASH: In case of no-match, distribute using hash
651  * struct dpni_fs_tbl_cfg - Flow Steering table configuration
664  * struct dpni_rx_tc_dist_cfg - Rx traffic class distribution configuration
669  * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
693 #define DPNI_FS_MISS_DROP		((uint16_t)-1)
696  * struct dpni_rx_dist_cfg - Rx distribution configuration
698  * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
729  * struct dpni_qos_tbl_cfg - Structure representing QOS table configuration
730  * @key_cfg_iova: I/O virtual address of 256 bytes DMA-able memory filled with
735  * @default_tc: Used in case of no-match and 'discard_on_miss'= 0
749  * enum dpni_dest - DPNI destination types
752  *		dequeue from the queue based on polling or other user-defined
768  * struct dpni_queue - Queue structure
769  * @destination - Destination structure
774  *	0 - No destination, queue can be manually
777  *	1 - The destination is a DPIO. When traffic
781  *	2 - The destination is a DPCON. The queue is
800  *      - significant bits are used for stash control.
803  *      - bits 0-1: indicates the number of 64 byte units of context
806  *      - bits 2-3: indicates the number of 64 byte units of frame
808  *      - bits 4-5: indicates the number of 64 byte units of frame
809  *      data to be stashed.  Frame data is placed at FD[ADDR] +
811  *      For more details check the Frame Descriptor section in the
829  * struct dpni_queue_id - Queue identification, used for enqueue commands
867  * enum dpni_congestion_unit - DPNI congestion units
877  * enum dpni_congestion_point - Structure representing congestion point
891  * struct dpni_dest_cfg - Structure representing DPNI destination parameters
895  *		values are 0-1 or 0-7, depending on the number of priorities
914  * struct dpni_congestion_notification_cfg - congestion notification
921  * @message_iova: I/O virtual address (must be in DMA-able memory),
947  * struct dpni_taildrop - Structure representing the taildrop
981  * struct dpni_rule_cfg - Rule configuration for table lookup
982  * @key_iova: I/O virtual address of the key (must be in DMA-able memory)
983  * @mask_iova: I/O virtual address of the mask (must be in DMA-able memory)
1001  * For more details check the Frame Descriptor section in the hardware
1010  *     - bits 0-1: indicates the number of 64 byte units of context that are
1013  *     - bits 2-3: indicates the number of 64 byte units of frame annotation
1015  *     - bits 4-5: indicates the number of 64 byte units of frame data to be
1016  *     stashed. Frame data is placed at FD[ADDR] + FD[OFFSET].
1022  * struct dpni_fs_action_cfg - Action configuration for table look-up
1024  *		Frame Descriptor section in the hardware documentation for
1027  *		values are in range 0 to num_queue-1.
1071  * struct dpni_tx_shaping - Structure representing DPNI tx shaping configuration
1088  * struct dpni_single_step_cfg - configure single step PTP (IEEE 1588)
1092  * @offset:	start offset from the beginning of the frame where
1096  * @peer_delay:	For peer-to-peer transparent clocks add this value to the