soc/fsl/dpaa2-fd.h

14  * DOC: DPAA2 FD - Frame Descriptor APIs for DPAA2
16  * Frame Descriptors (FDs) are used to describe frame data in the DPAA2.
17  * Frames can be enqueued and dequeued to Frame Queues (FQs) which are consumed
20  * There are three types of frames: single, scatter gather, and frame lists.
23  * query Frame Descriptors.
33  * @frc:           frame context
37  * This structure represents the basic Frame Descriptor used in the system.
99  * dpaa2_fd_get_addr() - get the addr field of frame descriptor
100  * @fd: the given frame descriptor
102  * Return the address in the frame descriptor.
110  * dpaa2_fd_set_addr() - Set the addr field of frame descriptor
111  * @fd: the given frame descriptor
112  * @addr: the address needs to be set in frame descriptor
120  * dpaa2_fd_get_frc() - Get the frame context in the frame descriptor
121  * @fd: the given frame descriptor
123  * Return the frame context field in the frame descriptor.
131  * dpaa2_fd_set_frc() - Set the frame context in the frame descriptor
132  * @fd: the given frame descriptor
133  * @frc: the frame context needs to be set in frame descriptor
141  * dpaa2_fd_get_ctrl() - Get the control bits in the frame descriptor
142  * @fd: the given frame descriptor
144  * Return the control bits field in the frame descriptor.
152  * dpaa2_fd_set_ctrl() - Set the control bits in the frame descriptor
153  * @fd: the given frame descriptor
154  * @ctrl: the control bits to be set in the frame descriptor
162  * dpaa2_fd_get_flc() - Get the flow context in the frame descriptor
163  * @fd: the given frame descriptor
165  * Return the flow context in the frame descriptor.
173  * dpaa2_fd_set_flc() - Set the flow context field of frame descriptor
174  * @fd: the given frame descriptor
175  * @flc_addr: the flow context needs to be set in frame descriptor
189  * dpaa2_fd_get_len() - Get the length in the frame descriptor
190  * @fd: the given frame descriptor
192  * Return the length field in the frame descriptor.
203  * dpaa2_fd_set_len() - Set the length field of frame descriptor
204  * @fd: the given frame descriptor
205  * @len: the length needs to be set in frame descriptor
213  * dpaa2_fd_get_offset() - Get the offset field in the frame descriptor
214  * @fd: the given frame descriptor
224  * dpaa2_fd_set_offset() - Set the offset field of frame descriptor
225  * @fd: the given frame descriptor
226  * @offset: the offset needs to be set in frame descriptor
235  * dpaa2_fd_get_format() - Get the format field in the frame descriptor
236  * @fd: the given frame descriptor
248  * dpaa2_fd_set_format() - Set the format field of frame descriptor
249  * @fd: the given frame descriptor
250  * @format: the format needs to be set in frame descriptor
261  * dpaa2_fd_get_bpid() - Get the bpid field in the frame descriptor
262  * @fd: the given frame descriptor
272  * dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor
273  * @fd: the given frame descriptor
449  * struct dpaa2_fl_entry - structure for frame list entry.
454  * @frc:           frame context
476  * @fle: the given frame list entry
478  * Return the address in the frame list entry.
487  * @fle: the given frame list entry
488  * @addr: the address needs to be set in frame list entry
497  * dpaa2_fl_get_frc() - Get the frame context in the FLE
498  * @fle: the given frame list entry
500  * Return the frame context field in the frame lsit entry.
508  * dpaa2_fl_set_frc() - Set the frame context in the FLE
509  * @fle: the given frame list entry
510  * @frc: the frame context needs to be set in frame list entry
519  * @fle: the given frame list entry
521  * Return the control bits field in the frame list entry.
530  * @fle: the given frame list entry
531  * @ctrl: the control bits to be set in the frame list entry
540  * @fle: the given frame list entry
542  * Return the flow context in the frame list entry.
551  * @fle: the given frame list entry
552  * @flc_addr: the flow context needs to be set in frame list entry
568  * @fle: the given frame list entry
570  * Return the length field in the frame list entry.
582  * @fle: the given frame list entry
583  * @len: the length needs to be set in frame list entry
591  * dpaa2_fl_get_offset() - Get the offset field in the frame list entry
592  * @fle: the given frame list entry
603  * @fle: the given frame list entry
604  * @offset: the offset needs to be set in frame list entry
614  * @fle: the given frame list entry
626  * @fle: the given frame list entry
627  * @format: the format needs to be set in frame list entry
638  * @fle: the given frame list entry
649  * @fle: the given frame list entry
660  * @fle: the given frame list entry
671  * @fle: the given frame list entry