xref: /linux/drivers/infiniband/hw/hfi1/sdma_txreq.h (revision 52990390f91c1c39ca742fc8f390b29891d95127)
1 /* SPDX-License-Identifier: GPL-2.0 or BSD-3-Clause */
2 /*
3  * Copyright(c) 2016 Intel Corporation.
4  */
5 
6 #ifndef HFI1_SDMA_TXREQ_H
7 #define HFI1_SDMA_TXREQ_H
8 
9 /* increased for AHG */
10 #define NUM_DESC 6
11 
12 /*
13  * struct sdma_desc - canonical fragment descriptor
14  *
15  * This is the descriptor carried in the tx request
16  * corresponding to each fragment.
17  *
18  */
19 struct sdma_desc {
20 	/* private:  don't use directly */
21 	u64 qw[2];
22 	void *pinning_ctx;
23 };
24 
25 /**
26  * struct sdma_txreq - the sdma_txreq structure (one per packet)
27  * @list: for use by user and by queuing for wait
28  *
29  * This is the representation of a packet which consists of some
30  * number of fragments.   Storage is provided to within the structure.
31  * for all fragments.
32  *
33  * The storage for the descriptors are automatically extended as needed
34  * when the currently allocation is exceeded.
35  *
36  * The user (Verbs or PSM) may overload this structure with fields
37  * specific to their use by putting this struct first in their struct.
38  * The method of allocation of the overloaded structure is user dependent
39  *
40  * The list is the only public field in the structure.
41  *
42  */
43 
44 #define SDMA_TXREQ_S_OK        0
45 #define SDMA_TXREQ_S_SENDERROR 1
46 #define SDMA_TXREQ_S_ABORTED   2
47 #define SDMA_TXREQ_S_SHUTDOWN  3
48 
49 /* flags bits */
50 #define SDMA_TXREQ_F_URGENT       0x0001
51 #define SDMA_TXREQ_F_AHG_COPY     0x0002
52 #define SDMA_TXREQ_F_USE_AHG      0x0004
53 #define SDMA_TXREQ_F_VIP          0x0010
54 
55 struct sdma_txreq;
56 typedef void (*callback_t)(struct sdma_txreq *, int);
57 
58 struct iowait;
59 struct sdma_txreq {
60 	struct list_head list;
61 	/* private: */
62 	struct sdma_desc *descp;
63 	/* private: */
64 	void *coalesce_buf;
65 	/* private: */
66 	struct iowait *wait;
67 	/* private: */
68 	callback_t                  complete;
69 #ifdef CONFIG_HFI1_DEBUG_SDMA_ORDER
70 	u64 sn;
71 #endif
72 	/* private: - used in coalesce/pad processing */
73 	u16                         packet_len;
74 	/* private: - down-counted to trigger last */
75 	u16                         tlen;
76 	/* private: */
77 	u16                         num_desc;
78 	/* private: */
79 	u16                         desc_limit;
80 	/* private: */
81 	u16                         next_descq_idx;
82 	/* private: */
83 	u16 coalesce_idx;
84 	/* private: flags */
85 	u16                         flags;
86 	/* private: */
87 	struct sdma_desc descs[NUM_DESC];
88 };
89 
90 static inline int sdma_txreq_built(struct sdma_txreq *tx)
91 {
92 	return tx->num_desc;
93 }
94 
95 #endif                          /* HFI1_SDMA_TXREQ_H */
96