/* SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause) */ /* * Copyright 2014-2016 Freescale Semiconductor Inc. * Copyright 2016 NXP * */ #ifndef __FSL_DPAA2_FD_H #define __FSL_DPAA2_FD_H #include <linux/byteorder/generic.h> #include <linux/types.h> /** * DOC: DPAA2 FD - Frame Descriptor APIs for DPAA2 * * Frame Descriptors (FDs) are used to describe frame data in the DPAA2. * Frames can be enqueued and dequeued to Frame Queues (FQs) which are consumed * by the various DPAA accelerators (WRIOP, SEC, PME, DCE) * * There are three types of frames: single, scatter gather, and frame lists. * * The set of APIs in this file must be used to create, manipulate and * query Frame Descriptors. */ /** * struct dpaa2_fd - Struct describing FDs * @words: for easier/faster copying the whole FD structure * @addr: address in the FD * @len: length in the FD * @bpid: buffer pool ID * @format_offset: format, offset, and short-length fields * @frc: frame context * @ctrl: control bits...including dd, sc, va, err, etc * @flc: flow context address * * This structure represents the basic Frame Descriptor used in the system. */ struct dpaa2_fd { … }; #define FD_SHORT_LEN_FLAG_MASK … #define FD_SHORT_LEN_FLAG_SHIFT … #define FD_SHORT_LEN_MASK … #define FD_OFFSET_MASK … #define FD_FORMAT_MASK … #define FD_FORMAT_SHIFT … #define FD_BPID_MASK … #define SG_SHORT_LEN_FLAG_MASK … #define SG_SHORT_LEN_FLAG_SHIFT … #define SG_SHORT_LEN_MASK … #define SG_OFFSET_MASK … #define SG_FORMAT_MASK … #define SG_FORMAT_SHIFT … #define SG_BPID_MASK … #define SG_FINAL_FLAG_MASK … #define SG_FINAL_FLAG_SHIFT … #define FL_SHORT_LEN_FLAG_MASK … #define FL_SHORT_LEN_FLAG_SHIFT … #define FL_SHORT_LEN_MASK … #define FL_OFFSET_MASK … #define FL_FORMAT_MASK … #define FL_FORMAT_SHIFT … #define FL_BPID_MASK … #define FL_FINAL_FLAG_MASK … #define FL_FINAL_FLAG_SHIFT … /* Error bits in FD CTRL */ #define FD_CTRL_ERR_MASK … #define FD_CTRL_UFD … #define FD_CTRL_SBE … #define FD_CTRL_FLC … #define FD_CTRL_FSE … #define FD_CTRL_FAERR … /* Annotation bits in FD CTRL */ #define FD_CTRL_PTA … #define FD_CTRL_PTV1 … enum dpaa2_fd_format { … }; /** * dpaa2_fd_get_addr() - get the addr field of frame descriptor * @fd: the given frame descriptor * * Return the address in the frame descriptor. */ static inline dma_addr_t dpaa2_fd_get_addr(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_addr() - Set the addr field of frame descriptor * @fd: the given frame descriptor * @addr: the address needs to be set in frame descriptor */ static inline void dpaa2_fd_set_addr(struct dpaa2_fd *fd, dma_addr_t addr) { … } /** * dpaa2_fd_get_frc() - Get the frame context in the frame descriptor * @fd: the given frame descriptor * * Return the frame context field in the frame descriptor. */ static inline u32 dpaa2_fd_get_frc(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_frc() - Set the frame context in the frame descriptor * @fd: the given frame descriptor * @frc: the frame context needs to be set in frame descriptor */ static inline void dpaa2_fd_set_frc(struct dpaa2_fd *fd, u32 frc) { … } /** * dpaa2_fd_get_ctrl() - Get the control bits in the frame descriptor * @fd: the given frame descriptor * * Return the control bits field in the frame descriptor. */ static inline u32 dpaa2_fd_get_ctrl(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_ctrl() - Set the control bits in the frame descriptor * @fd: the given frame descriptor * @ctrl: the control bits to be set in the frame descriptor */ static inline void dpaa2_fd_set_ctrl(struct dpaa2_fd *fd, u32 ctrl) { … } /** * dpaa2_fd_get_flc() - Get the flow context in the frame descriptor * @fd: the given frame descriptor * * Return the flow context in the frame descriptor. */ static inline dma_addr_t dpaa2_fd_get_flc(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_flc() - Set the flow context field of frame descriptor * @fd: the given frame descriptor * @flc_addr: the flow context needs to be set in frame descriptor */ static inline void dpaa2_fd_set_flc(struct dpaa2_fd *fd, dma_addr_t flc_addr) { … } static inline bool dpaa2_fd_short_len(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_get_len() - Get the length in the frame descriptor * @fd: the given frame descriptor * * Return the length field in the frame descriptor. */ static inline u32 dpaa2_fd_get_len(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_len() - Set the length field of frame descriptor * @fd: the given frame descriptor * @len: the length needs to be set in frame descriptor */ static inline void dpaa2_fd_set_len(struct dpaa2_fd *fd, u32 len) { … } /** * dpaa2_fd_get_offset() - Get the offset field in the frame descriptor * @fd: the given frame descriptor * * Return the offset. */ static inline uint16_t dpaa2_fd_get_offset(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_offset() - Set the offset field of frame descriptor * @fd: the given frame descriptor * @offset: the offset needs to be set in frame descriptor */ static inline void dpaa2_fd_set_offset(struct dpaa2_fd *fd, uint16_t offset) { … } /** * dpaa2_fd_get_format() - Get the format field in the frame descriptor * @fd: the given frame descriptor * * Return the format. */ static inline enum dpaa2_fd_format dpaa2_fd_get_format( const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_format() - Set the format field of frame descriptor * @fd: the given frame descriptor * @format: the format needs to be set in frame descriptor */ static inline void dpaa2_fd_set_format(struct dpaa2_fd *fd, enum dpaa2_fd_format format) { … } /** * dpaa2_fd_get_bpid() - Get the bpid field in the frame descriptor * @fd: the given frame descriptor * * Return the buffer pool id. */ static inline uint16_t dpaa2_fd_get_bpid(const struct dpaa2_fd *fd) { … } /** * dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor * @fd: the given frame descriptor * @bpid: buffer pool id to be set */ static inline void dpaa2_fd_set_bpid(struct dpaa2_fd *fd, uint16_t bpid) { … } /** * struct dpaa2_sg_entry - the scatter-gathering structure * @addr: address of the sg entry * @len: length in this sg entry * @bpid: buffer pool id * @format_offset: format and offset fields */ struct dpaa2_sg_entry { … }; enum dpaa2_sg_format { … }; /* Accessors for SG entry fields */ /** * dpaa2_sg_get_addr() - Get the address from SG entry * @sg: the given scatter-gathering object * * Return the address. */ static inline dma_addr_t dpaa2_sg_get_addr(const struct dpaa2_sg_entry *sg) { … } /** * dpaa2_sg_set_addr() - Set the address in SG entry * @sg: the given scatter-gathering object * @addr: the address to be set */ static inline void dpaa2_sg_set_addr(struct dpaa2_sg_entry *sg, dma_addr_t addr) { … } static inline bool dpaa2_sg_short_len(const struct dpaa2_sg_entry *sg) { … } /** * dpaa2_sg_get_len() - Get the length in SG entry * @sg: the given scatter-gathering object * * Return the length. */ static inline u32 dpaa2_sg_get_len(const struct dpaa2_sg_entry *sg) { … } /** * dpaa2_sg_set_len() - Set the length in SG entry * @sg: the given scatter-gathering object * @len: the length to be set */ static inline void dpaa2_sg_set_len(struct dpaa2_sg_entry *sg, u32 len) { … } /** * dpaa2_sg_get_offset() - Get the offset in SG entry * @sg: the given scatter-gathering object * * Return the offset. */ static inline u16 dpaa2_sg_get_offset(const struct dpaa2_sg_entry *sg) { … } /** * dpaa2_sg_set_offset() - Set the offset in SG entry * @sg: the given scatter-gathering object * @offset: the offset to be set */ static inline void dpaa2_sg_set_offset(struct dpaa2_sg_entry *sg, u16 offset) { … } /** * dpaa2_sg_get_format() - Get the SG format in SG entry * @sg: the given scatter-gathering object * * Return the format. */ static inline enum dpaa2_sg_format dpaa2_sg_get_format(const struct dpaa2_sg_entry *sg) { … } /** * dpaa2_sg_set_format() - Set the SG format in SG entry * @sg: the given scatter-gathering object * @format: the format to be set */ static inline void dpaa2_sg_set_format(struct dpaa2_sg_entry *sg, enum dpaa2_sg_format format) { … } /** * dpaa2_sg_get_bpid() - Get the buffer pool id in SG entry * @sg: the given scatter-gathering object * * Return the bpid. */ static inline u16 dpaa2_sg_get_bpid(const struct dpaa2_sg_entry *sg) { … } /** * dpaa2_sg_set_bpid() - Set the buffer pool id in SG entry * @sg: the given scatter-gathering object * @bpid: the bpid to be set */ static inline void dpaa2_sg_set_bpid(struct dpaa2_sg_entry *sg, u16 bpid) { … } /** * dpaa2_sg_is_final() - Check final bit in SG entry * @sg: the given scatter-gathering object * * Return bool. */ static inline bool dpaa2_sg_is_final(const struct dpaa2_sg_entry *sg) { … } /** * dpaa2_sg_set_final() - Set the final bit in SG entry * @sg: the given scatter-gathering object * @final: the final boolean to be set */ static inline void dpaa2_sg_set_final(struct dpaa2_sg_entry *sg, bool final) { … } /** * struct dpaa2_fl_entry - structure for frame list entry. * @addr: address in the FLE * @len: length in the FLE * @bpid: buffer pool ID * @format_offset: format, offset, and short-length fields * @frc: frame context * @ctrl: control bits...including pta, pvt1, pvt2, err, etc * @flc: flow context address */ struct dpaa2_fl_entry { … }; enum dpaa2_fl_format { … }; /** * dpaa2_fl_get_addr() - get the addr field of FLE * @fle: the given frame list entry * * Return the address in the frame list entry. */ static inline dma_addr_t dpaa2_fl_get_addr(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_addr() - Set the addr field of FLE * @fle: the given frame list entry * @addr: the address needs to be set in frame list entry */ static inline void dpaa2_fl_set_addr(struct dpaa2_fl_entry *fle, dma_addr_t addr) { … } /** * dpaa2_fl_get_frc() - Get the frame context in the FLE * @fle: the given frame list entry * * Return the frame context field in the frame lsit entry. */ static inline u32 dpaa2_fl_get_frc(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_frc() - Set the frame context in the FLE * @fle: the given frame list entry * @frc: the frame context needs to be set in frame list entry */ static inline void dpaa2_fl_set_frc(struct dpaa2_fl_entry *fle, u32 frc) { … } /** * dpaa2_fl_get_ctrl() - Get the control bits in the FLE * @fle: the given frame list entry * * Return the control bits field in the frame list entry. */ static inline u32 dpaa2_fl_get_ctrl(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_ctrl() - Set the control bits in the FLE * @fle: the given frame list entry * @ctrl: the control bits to be set in the frame list entry */ static inline void dpaa2_fl_set_ctrl(struct dpaa2_fl_entry *fle, u32 ctrl) { … } /** * dpaa2_fl_get_flc() - Get the flow context in the FLE * @fle: the given frame list entry * * Return the flow context in the frame list entry. */ static inline dma_addr_t dpaa2_fl_get_flc(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_flc() - Set the flow context field of FLE * @fle: the given frame list entry * @flc_addr: the flow context needs to be set in frame list entry */ static inline void dpaa2_fl_set_flc(struct dpaa2_fl_entry *fle, dma_addr_t flc_addr) { … } static inline bool dpaa2_fl_short_len(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_get_len() - Get the length in the FLE * @fle: the given frame list entry * * Return the length field in the frame list entry. */ static inline u32 dpaa2_fl_get_len(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_len() - Set the length field of FLE * @fle: the given frame list entry * @len: the length needs to be set in frame list entry */ static inline void dpaa2_fl_set_len(struct dpaa2_fl_entry *fle, u32 len) { … } /** * dpaa2_fl_get_offset() - Get the offset field in the frame list entry * @fle: the given frame list entry * * Return the offset. */ static inline u16 dpaa2_fl_get_offset(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_offset() - Set the offset field of FLE * @fle: the given frame list entry * @offset: the offset needs to be set in frame list entry */ static inline void dpaa2_fl_set_offset(struct dpaa2_fl_entry *fle, u16 offset) { … } /** * dpaa2_fl_get_format() - Get the format field in the FLE * @fle: the given frame list entry * * Return the format. */ static inline enum dpaa2_fl_format dpaa2_fl_get_format(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_format() - Set the format field of FLE * @fle: the given frame list entry * @format: the format needs to be set in frame list entry */ static inline void dpaa2_fl_set_format(struct dpaa2_fl_entry *fle, enum dpaa2_fl_format format) { … } /** * dpaa2_fl_get_bpid() - Get the bpid field in the FLE * @fle: the given frame list entry * * Return the buffer pool id. */ static inline u16 dpaa2_fl_get_bpid(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_bpid() - Set the bpid field of FLE * @fle: the given frame list entry * @bpid: buffer pool id to be set */ static inline void dpaa2_fl_set_bpid(struct dpaa2_fl_entry *fle, u16 bpid) { … } /** * dpaa2_fl_is_final() - Check final bit in FLE * @fle: the given frame list entry * * Return bool. */ static inline bool dpaa2_fl_is_final(const struct dpaa2_fl_entry *fle) { … } /** * dpaa2_fl_set_final() - Set the final bit in FLE * @fle: the given frame list entry * @final: the final boolean to be set */ static inline void dpaa2_fl_set_final(struct dpaa2_fl_entry *fle, bool final) { … } #endif /* __FSL_DPAA2_FD_H */
Codebase Browser
linux