1060 lines · 33.1 KB · C
RawDownload
/* SPDX-License-Identifier: GPL-2.0 *//* * CPPI5 descriptors interface * * Copyright (C) 2019 Texas Instruments Incorporated - https://www.ti.com */ #ifndef __TI_CPPI5_H__#define __TI_CPPI5_H__ #include <linux/bitops.h>#include <linux/printk.h>#include <linux/bug.h> /** * struct cppi5_desc_hdr_t - Descriptor header, present in all types of *			     descriptors * @pkt_info0:		Packet info word 0 (n/a in Buffer desc) * @pkt_info0:		Packet info word 1 (n/a in Buffer desc) * @pkt_info0:		Packet info word 2 (n/a in Buffer desc) * @src_dst_tag:	Packet info word 3 (n/a in Buffer desc) */struct cppi5_desc_hdr_t {	u32 pkt_info0;	u32 pkt_info1;	u32 pkt_info2;	u32 src_dst_tag;} __packed; /** * struct cppi5_host_desc_t - Host-mode packet and buffer descriptor definition * @hdr:		Descriptor header * @next_desc:		word 4/5: Linking word * @buf_ptr:		word 6/7: Buffer pointer * @buf_info1:		word 8: Buffer valid data length * @org_buf_len:	word 9: Original buffer length * @org_buf_ptr:	word 10/11: Original buffer pointer * @epib[0]:		Extended Packet Info Data (optional, 4 words), and/or *			Protocol Specific Data (optional, 0-128 bytes in *			multiples of 4), and/or *			Other Software Data (0-N bytes, optional) */struct cppi5_host_desc_t {	struct cppi5_desc_hdr_t hdr;	u64 next_desc;	u64 buf_ptr;	u32 buf_info1;	u32 org_buf_len;	u64 org_buf_ptr;	u32 epib[];} __packed; #define CPPI5_DESC_MIN_ALIGN			(16U) #define CPPI5_INFO0_HDESC_EPIB_SIZE		(16U)#define CPPI5_INFO0_HDESC_PSDATA_MAX_SIZE	(128U) #define CPPI5_INFO0_HDESC_TYPE_SHIFT		(30U)#define CPPI5_INFO0_HDESC_TYPE_MASK		GENMASK(31, 30)#define   CPPI5_INFO0_DESC_TYPE_VAL_HOST	(1U)#define   CPPI5_INFO0_DESC_TYPE_VAL_MONO	(2U)#define   CPPI5_INFO0_DESC_TYPE_VAL_TR		(3U)#define CPPI5_INFO0_HDESC_EPIB_PRESENT		BIT(29)/* * Protocol Specific Words location: * 0 - located in the descriptor, * 1 = located in the SOP Buffer immediately prior to the data. */#define CPPI5_INFO0_HDESC_PSINFO_LOCATION	BIT(28)#define CPPI5_INFO0_HDESC_PSINFO_SIZE_SHIFT	(22U)#define CPPI5_INFO0_HDESC_PSINFO_SIZE_MASK	GENMASK(27, 22)#define CPPI5_INFO0_HDESC_PKTLEN_SHIFT		(0)#define CPPI5_INFO0_HDESC_PKTLEN_MASK		GENMASK(21, 0) #define CPPI5_INFO1_DESC_PKTERROR_SHIFT		(28U)#define CPPI5_INFO1_DESC_PKTERROR_MASK		GENMASK(31, 28)#define CPPI5_INFO1_HDESC_PSFLGS_SHIFT		(24U)#define CPPI5_INFO1_HDESC_PSFLGS_MASK		GENMASK(27, 24)#define CPPI5_INFO1_DESC_PKTID_SHIFT		(14U)#define CPPI5_INFO1_DESC_PKTID_MASK		GENMASK(23, 14)#define CPPI5_INFO1_DESC_FLOWID_SHIFT		(0)#define CPPI5_INFO1_DESC_FLOWID_MASK		GENMASK(13, 0)#define CPPI5_INFO1_DESC_FLOWID_DEFAULT		CPPI5_INFO1_DESC_FLOWID_MASK #define CPPI5_INFO2_HDESC_PKTTYPE_SHIFT		(27U)#define CPPI5_INFO2_HDESC_PKTTYPE_MASK		GENMASK(31, 27)/* Return Policy: 0 - Entire packet 1 - Each buffer */#define CPPI5_INFO2_HDESC_RETPOLICY		BIT(18)/* * Early Return: * 0 = desc pointers should be returned after all reads have been completed * 1 = desc pointers should be returned immediately upon fetching * the descriptor and beginning to transfer data. */#define CPPI5_INFO2_HDESC_EARLYRET		BIT(17)/* * Return Push Policy: * 0 = Descriptor must be returned to tail of queue * 1 = Descriptor must be returned to head of queue */#define CPPI5_INFO2_DESC_RETPUSHPOLICY		BIT(16)#define CPPI5_INFO2_DESC_RETP_MASK		GENMASK(18, 16) #define CPPI5_INFO2_DESC_RETQ_SHIFT		(0)#define CPPI5_INFO2_DESC_RETQ_MASK		GENMASK(15, 0) #define CPPI5_INFO3_DESC_SRCTAG_SHIFT		(16U)#define CPPI5_INFO3_DESC_SRCTAG_MASK		GENMASK(31, 16)#define CPPI5_INFO3_DESC_DSTTAG_SHIFT		(0)#define CPPI5_INFO3_DESC_DSTTAG_MASK		GENMASK(15, 0) #define CPPI5_BUFINFO1_HDESC_DATA_LEN_SHIFT	(0)#define CPPI5_BUFINFO1_HDESC_DATA_LEN_MASK	GENMASK(27, 0) #define CPPI5_OBUFINFO0_HDESC_BUF_LEN_SHIFT	(0)#define CPPI5_OBUFINFO0_HDESC_BUF_LEN_MASK	GENMASK(27, 0) /** * struct cppi5_desc_epib_t - Host Packet Descriptor Extended Packet Info Block * @timestamp:		word 0: application specific timestamp * @sw_info0:		word 1: Software Info 0 * @sw_info1:		word 1: Software Info 1 * @sw_info2:		word 1: Software Info 2 */struct cppi5_desc_epib_t {	u32 timestamp;	/* w0: application specific timestamp */	u32 sw_info0;	/* w1: Software Info 0 */	u32 sw_info1;	/* w2: Software Info 1 */	u32 sw_info2;	/* w3: Software Info 2 */}; /** * struct cppi5_monolithic_desc_t - Monolithic-mode packet descriptor * @hdr:		Descriptor header * @epib[0]:		Extended Packet Info Data (optional, 4 words), and/or *			Protocol Specific Data (optional, 0-128 bytes in *			multiples of 4), and/or *			Other Software Data (0-N bytes, optional) */struct cppi5_monolithic_desc_t {	struct cppi5_desc_hdr_t hdr;	u32 epib[];}; #define CPPI5_INFO2_MDESC_DATA_OFFSET_SHIFT	(18U)#define CPPI5_INFO2_MDESC_DATA_OFFSET_MASK	GENMASK(26, 18) /* * Reload Count: * 0 = Finish the packet and place the descriptor back on the return queue * 1-0x1ff = Vector to the Reload Index and resume processing * 0x1ff indicates perpetual loop, infinite reload until the channel is stopped */#define CPPI5_INFO0_TRDESC_RLDCNT_SHIFT		(20U)#define CPPI5_INFO0_TRDESC_RLDCNT_MASK		GENMASK(28, 20)#define CPPI5_INFO0_TRDESC_RLDCNT_MAX		(0x1ff)#define CPPI5_INFO0_TRDESC_RLDCNT_INFINITE	CPPI5_INFO0_TRDESC_RLDCNT_MAX#define CPPI5_INFO0_TRDESC_RLDIDX_SHIFT		(14U)#define CPPI5_INFO0_TRDESC_RLDIDX_MASK		GENMASK(19, 14)#define CPPI5_INFO0_TRDESC_RLDIDX_MAX		(0x3f)#define CPPI5_INFO0_TRDESC_LASTIDX_SHIFT	(0)#define CPPI5_INFO0_TRDESC_LASTIDX_MASK		GENMASK(13, 0) #define CPPI5_INFO1_TRDESC_RECSIZE_SHIFT	(24U)#define CPPI5_INFO1_TRDESC_RECSIZE_MASK		GENMASK(26, 24)#define   CPPI5_INFO1_TRDESC_RECSIZE_VAL_16B	(0)#define   CPPI5_INFO1_TRDESC_RECSIZE_VAL_32B	(1U)#define   CPPI5_INFO1_TRDESC_RECSIZE_VAL_64B	(2U)#define   CPPI5_INFO1_TRDESC_RECSIZE_VAL_128B	(3U) static inline void cppi5_desc_dump(void *desc, u32 size){	print_hex_dump(KERN_ERR, "dump udmap_desc: ", DUMP_PREFIX_NONE,		       32, 4, desc, size, false);} #define CPPI5_TDCM_MARKER			(0x1)/** * cppi5_desc_is_tdcm - check if the paddr indicates Teardown Complete Message * @paddr: Physical address of the packet popped from the ring * * Returns true if the address indicates TDCM */static inline bool cppi5_desc_is_tdcm(dma_addr_t paddr){	return (paddr & CPPI5_TDCM_MARKER) ? true : false;} /** * cppi5_desc_get_type - get descriptor type * @desc_hdr: packet descriptor/TR header * * Returns descriptor type: * CPPI5_INFO0_DESC_TYPE_VAL_HOST * CPPI5_INFO0_DESC_TYPE_VAL_MONO * CPPI5_INFO0_DESC_TYPE_VAL_TR */static inline u32 cppi5_desc_get_type(struct cppi5_desc_hdr_t *desc_hdr){	return (desc_hdr->pkt_info0 & CPPI5_INFO0_HDESC_TYPE_MASK) >>		CPPI5_INFO0_HDESC_TYPE_SHIFT;} /** * cppi5_desc_get_errflags - get Error Flags from Desc * @desc_hdr: packet/TR descriptor header * * Returns Error Flags from Packet/TR Descriptor */static inline u32 cppi5_desc_get_errflags(struct cppi5_desc_hdr_t *desc_hdr){	return (desc_hdr->pkt_info1 & CPPI5_INFO1_DESC_PKTERROR_MASK) >>		CPPI5_INFO1_DESC_PKTERROR_SHIFT;} /** * cppi5_desc_get_pktids - get Packet and Flow ids from Desc * @desc_hdr: packet/TR descriptor header * @pkt_id: Packet ID * @flow_id: Flow ID * * Returns Packet and Flow ids from packet/TR descriptor */static inline void cppi5_desc_get_pktids(struct cppi5_desc_hdr_t *desc_hdr,					 u32 *pkt_id, u32 *flow_id){	*pkt_id = (desc_hdr->pkt_info1 & CPPI5_INFO1_DESC_PKTID_MASK) >>		   CPPI5_INFO1_DESC_PKTID_SHIFT;	*flow_id = (desc_hdr->pkt_info1 & CPPI5_INFO1_DESC_FLOWID_MASK) >>		    CPPI5_INFO1_DESC_FLOWID_SHIFT;} /** * cppi5_desc_set_pktids - set Packet and Flow ids in Desc * @desc_hdr: packet/TR descriptor header * @pkt_id: Packet ID * @flow_id: Flow ID */static inline void cppi5_desc_set_pktids(struct cppi5_desc_hdr_t *desc_hdr,					 u32 pkt_id, u32 flow_id){	desc_hdr->pkt_info1 &= ~(CPPI5_INFO1_DESC_PKTID_MASK |				 CPPI5_INFO1_DESC_FLOWID_MASK);	desc_hdr->pkt_info1 |= (pkt_id << CPPI5_INFO1_DESC_PKTID_SHIFT) &				CPPI5_INFO1_DESC_PKTID_MASK;	desc_hdr->pkt_info1 |= (flow_id << CPPI5_INFO1_DESC_FLOWID_SHIFT) &				CPPI5_INFO1_DESC_FLOWID_MASK;} /** * cppi5_desc_set_retpolicy - set Packet Return Policy in Desc * @desc_hdr: packet/TR descriptor header * @flags: fags, supported values *  CPPI5_INFO2_HDESC_RETPOLICY *  CPPI5_INFO2_HDESC_EARLYRET *  CPPI5_INFO2_DESC_RETPUSHPOLICY * @return_ring_id: Packet Return Queue/Ring id, value 0xFFFF reserved */static inline void cppi5_desc_set_retpolicy(struct cppi5_desc_hdr_t *desc_hdr,					    u32 flags, u32 return_ring_id){	desc_hdr->pkt_info2 &= ~(CPPI5_INFO2_DESC_RETP_MASK |				 CPPI5_INFO2_DESC_RETQ_MASK);	desc_hdr->pkt_info2 |= flags & CPPI5_INFO2_DESC_RETP_MASK;	desc_hdr->pkt_info2 |= return_ring_id & CPPI5_INFO2_DESC_RETQ_MASK;} /** * cppi5_desc_get_tags_ids - get Packet Src/Dst Tags from Desc * @desc_hdr: packet/TR descriptor header * @src_tag_id: Source Tag * @dst_tag_id: Dest Tag * * Returns Packet Src/Dst Tags from packet/TR descriptor */static inline void cppi5_desc_get_tags_ids(struct cppi5_desc_hdr_t *desc_hdr,					   u32 *src_tag_id, u32 *dst_tag_id){	if (src_tag_id)		*src_tag_id = (desc_hdr->src_dst_tag &			      CPPI5_INFO3_DESC_SRCTAG_MASK) >>			      CPPI5_INFO3_DESC_SRCTAG_SHIFT;	if (dst_tag_id)		*dst_tag_id = desc_hdr->src_dst_tag &			      CPPI5_INFO3_DESC_DSTTAG_MASK;} /** * cppi5_desc_set_tags_ids - set Packet Src/Dst Tags in HDesc * @desc_hdr: packet/TR descriptor header * @src_tag_id: Source Tag * @dst_tag_id: Dest Tag * * Returns Packet Src/Dst Tags from packet/TR descriptor */static inline void cppi5_desc_set_tags_ids(struct cppi5_desc_hdr_t *desc_hdr,					   u32 src_tag_id, u32 dst_tag_id){	desc_hdr->src_dst_tag = (src_tag_id << CPPI5_INFO3_DESC_SRCTAG_SHIFT) &				CPPI5_INFO3_DESC_SRCTAG_MASK;	desc_hdr->src_dst_tag |= dst_tag_id & CPPI5_INFO3_DESC_DSTTAG_MASK;} /** * cppi5_hdesc_calc_size - Calculate Host Packet Descriptor size * @epib: is EPIB present * @psdata_size: PSDATA size * @sw_data_size: SWDATA size * * Returns required Host Packet Descriptor size * 0 - if PSDATA > CPPI5_INFO0_HDESC_PSDATA_MAX_SIZE */static inline u32 cppi5_hdesc_calc_size(bool epib, u32 psdata_size,					u32 sw_data_size){	u32 desc_size; 	if (psdata_size > CPPI5_INFO0_HDESC_PSDATA_MAX_SIZE)		return 0; 	desc_size = sizeof(struct cppi5_host_desc_t) + psdata_size +		    sw_data_size; 	if (epib)		desc_size += CPPI5_INFO0_HDESC_EPIB_SIZE; 	return ALIGN(desc_size, CPPI5_DESC_MIN_ALIGN);} /** * cppi5_hdesc_init - Init Host Packet Descriptor size * @desc: Host packet descriptor * @flags: supported values *	CPPI5_INFO0_HDESC_EPIB_PRESENT *	CPPI5_INFO0_HDESC_PSINFO_LOCATION * @psdata_size: PSDATA size * * Returns required Host Packet Descriptor size * 0 - if PSDATA > CPPI5_INFO0_HDESC_PSDATA_MAX_SIZE */static inline void cppi5_hdesc_init(struct cppi5_host_desc_t *desc, u32 flags,				    u32 psdata_size){	desc->hdr.pkt_info0 = (CPPI5_INFO0_DESC_TYPE_VAL_HOST <<			       CPPI5_INFO0_HDESC_TYPE_SHIFT) | (flags);	desc->hdr.pkt_info0 |= ((psdata_size >> 2) <<				CPPI5_INFO0_HDESC_PSINFO_SIZE_SHIFT) &				CPPI5_INFO0_HDESC_PSINFO_SIZE_MASK;	desc->next_desc = 0;} /** * cppi5_hdesc_update_flags - Replace descriptor flags * @desc: Host packet descriptor * @flags: supported values *	CPPI5_INFO0_HDESC_EPIB_PRESENT *	CPPI5_INFO0_HDESC_PSINFO_LOCATION */static inline void cppi5_hdesc_update_flags(struct cppi5_host_desc_t *desc,					    u32 flags){	desc->hdr.pkt_info0 &= ~(CPPI5_INFO0_HDESC_EPIB_PRESENT |				 CPPI5_INFO0_HDESC_PSINFO_LOCATION);	desc->hdr.pkt_info0 |= flags;} /** * cppi5_hdesc_update_psdata_size - Replace PSdata size * @desc: Host packet descriptor * @psdata_size: PSDATA size */static inline voidcppi5_hdesc_update_psdata_size(struct cppi5_host_desc_t *desc, u32 psdata_size){	desc->hdr.pkt_info0 &= ~CPPI5_INFO0_HDESC_PSINFO_SIZE_MASK;	desc->hdr.pkt_info0 |= ((psdata_size >> 2) <<				CPPI5_INFO0_HDESC_PSINFO_SIZE_SHIFT) &				CPPI5_INFO0_HDESC_PSINFO_SIZE_MASK;} /** * cppi5_hdesc_get_psdata_size - get PSdata size in bytes * @desc: Host packet descriptor */static inline u32 cppi5_hdesc_get_psdata_size(struct cppi5_host_desc_t *desc){	u32 psdata_size = 0; 	if (!(desc->hdr.pkt_info0 & CPPI5_INFO0_HDESC_PSINFO_LOCATION))		psdata_size = (desc->hdr.pkt_info0 &			       CPPI5_INFO0_HDESC_PSINFO_SIZE_MASK) >>			       CPPI5_INFO0_HDESC_PSINFO_SIZE_SHIFT; 	return (psdata_size << 2);} /** * cppi5_hdesc_get_pktlen - get Packet Length from HDesc * @desc: Host packet descriptor * * Returns Packet Length from Host Packet Descriptor */static inline u32 cppi5_hdesc_get_pktlen(struct cppi5_host_desc_t *desc){	return (desc->hdr.pkt_info0 & CPPI5_INFO0_HDESC_PKTLEN_MASK);} /** * cppi5_hdesc_set_pktlen - set Packet Length in HDesc * @desc: Host packet descriptor */static inline void cppi5_hdesc_set_pktlen(struct cppi5_host_desc_t *desc,					  u32 pkt_len){	desc->hdr.pkt_info0 &= ~CPPI5_INFO0_HDESC_PKTLEN_MASK;	desc->hdr.pkt_info0 |= (pkt_len & CPPI5_INFO0_HDESC_PKTLEN_MASK);} /** * cppi5_hdesc_get_psflags - get Protocol Specific Flags from HDesc * @desc: Host packet descriptor * * Returns Protocol Specific Flags from Host Packet Descriptor */static inline u32 cppi5_hdesc_get_psflags(struct cppi5_host_desc_t *desc){	return (desc->hdr.pkt_info1 & CPPI5_INFO1_HDESC_PSFLGS_MASK) >>		CPPI5_INFO1_HDESC_PSFLGS_SHIFT;} /** * cppi5_hdesc_set_psflags - set Protocol Specific Flags in HDesc * @desc: Host packet descriptor */static inline void cppi5_hdesc_set_psflags(struct cppi5_host_desc_t *desc,					   u32 ps_flags){	desc->hdr.pkt_info1 &= ~CPPI5_INFO1_HDESC_PSFLGS_MASK;	desc->hdr.pkt_info1 |= (ps_flags <<				CPPI5_INFO1_HDESC_PSFLGS_SHIFT) &				CPPI5_INFO1_HDESC_PSFLGS_MASK;} /** * cppi5_hdesc_get_errflags - get Packet Type from HDesc * @desc: Host packet descriptor */static inline u32 cppi5_hdesc_get_pkttype(struct cppi5_host_desc_t *desc){	return (desc->hdr.pkt_info2 & CPPI5_INFO2_HDESC_PKTTYPE_MASK) >>		CPPI5_INFO2_HDESC_PKTTYPE_SHIFT;} /** * cppi5_hdesc_get_errflags - set Packet Type in HDesc * @desc: Host packet descriptor * @pkt_type: Packet Type */static inline void cppi5_hdesc_set_pkttype(struct cppi5_host_desc_t *desc,					   u32 pkt_type){	desc->hdr.pkt_info2 &= ~CPPI5_INFO2_HDESC_PKTTYPE_MASK;	desc->hdr.pkt_info2 |=			(pkt_type << CPPI5_INFO2_HDESC_PKTTYPE_SHIFT) &			 CPPI5_INFO2_HDESC_PKTTYPE_MASK;} /** * cppi5_hdesc_attach_buf - attach buffer to HDesc * @desc: Host packet descriptor * @buf: Buffer physical address * @buf_data_len: Buffer length * @obuf: Original Buffer physical address * @obuf_len: Original Buffer length * * Attaches buffer to Host Packet Descriptor */static inline void cppi5_hdesc_attach_buf(struct cppi5_host_desc_t *desc,					  dma_addr_t buf, u32 buf_data_len,					  dma_addr_t obuf, u32 obuf_len){	desc->buf_ptr = buf;	desc->buf_info1 = buf_data_len & CPPI5_BUFINFO1_HDESC_DATA_LEN_MASK;	desc->org_buf_ptr = obuf;	desc->org_buf_len = obuf_len & CPPI5_OBUFINFO0_HDESC_BUF_LEN_MASK;} static inline void cppi5_hdesc_get_obuf(struct cppi5_host_desc_t *desc,					dma_addr_t *obuf, u32 *obuf_len){	*obuf = desc->org_buf_ptr;	*obuf_len = desc->org_buf_len & CPPI5_OBUFINFO0_HDESC_BUF_LEN_MASK;} static inline void cppi5_hdesc_reset_to_original(struct cppi5_host_desc_t *desc){	desc->buf_ptr = desc->org_buf_ptr;	desc->buf_info1 = desc->org_buf_len;} 

Lines 1–500 of 1060.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t