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