xref: /linux/drivers/cdx/controller/mcdid.h (revision 03f76ddff5b04a808ae16c06418460151e2fdd4b)
1 /* SPDX-License-Identifier: GPL-2.0
2  *
3  * Copyright 2008-2013 Solarflare Communications Inc.
4  * Copyright (C) 2022-2025, Advanced Micro Devices, Inc.
5  */
6 
7 #ifndef CDX_MCDID_H
8 #define CDX_MCDID_H
9 
10 #include <linux/mutex.h>
11 #include <linux/kref.h>
12 #include <linux/rpmsg.h>
13 
14 #include "mc_cdx_pcol.h"
15 
16 #ifdef DEBUG
17 #define CDX_WARN_ON_ONCE_PARANOID(x) WARN_ON_ONCE(x)
18 #define CDX_WARN_ON_PARANOID(x) WARN_ON(x)
19 #else
20 #define CDX_WARN_ON_ONCE_PARANOID(x) do {} while (0)
21 #define CDX_WARN_ON_PARANOID(x) do {} while (0)
22 #endif
23 
24 #define MCDI_BUF_LEN (8 + MCDI_CTL_SDU_LEN_MAX)
25 
cdx_mcdi_if(struct cdx_mcdi * cdx)26 static inline struct cdx_mcdi_iface *cdx_mcdi_if(struct cdx_mcdi *cdx)
27 {
28 	return cdx->mcdi ? &cdx->mcdi->iface : NULL;
29 }
30 
31 int cdx_mcdi_rpc_async(struct cdx_mcdi *cdx, unsigned int cmd,
32 		       const struct cdx_dword *inbuf, size_t inlen,
33 		       cdx_mcdi_async_completer *complete,
34 		       unsigned long cookie);
35 int cdx_mcdi_wait_for_quiescence(struct cdx_mcdi *cdx,
36 				 unsigned int timeout_jiffies);
37 
38 /*
39  * We expect that 16- and 32-bit fields in MCDI requests and responses
40  * are appropriately aligned, but 64-bit fields are only
41  * 32-bit-aligned.
42  */
43 #define MCDI_BYTE(_buf, _field)						\
44 	((void)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 1),	\
45 	 *MCDI_PTR(_buf, _field))
46 #define MCDI_WORD(_buf, _field)						\
47 	((void)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2),	\
48 	 le16_to_cpu(*(__force const __le16 *)MCDI_PTR(_buf, _field)))
49 #define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1)		\
50 	CDX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field),		\
51 			     MC_CMD_ ## _name1, _value1)
52 #define MCDI_SET_QWORD(_buf, _field, _value)				\
53 	do {								\
54 		CDX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0],	\
55 				     CDX_DWORD, (u32)(_value));	\
56 		CDX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1],	\
57 				     CDX_DWORD, (u64)(_value) >> 32);	\
58 	} while (0)
59 #define MCDI_QWORD(_buf, _field)					\
60 	(CDX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], CDX_DWORD) |	\
61 	(u64)CDX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], CDX_DWORD) << 32)
62 
63 #endif /* CDX_MCDID_H */
64