1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PLATFORM_X86_INTEL_SCU_IPC_H_
3 #define __PLATFORM_X86_INTEL_SCU_IPC_H_
4 
5 #include <linux/ioport.h>
6 
7 struct device;
8 struct intel_scu_ipc_dev;
9 
10 /**
11  * struct intel_scu_ipc_data - Data used to configure SCU IPC
12  * @mem: Base address of SCU IPC MMIO registers
13  * @irq: The IRQ number used for SCU (optional)
14  */
15 struct intel_scu_ipc_data {
16 	struct resource mem;
17 	int irq;
18 };
19 
20 struct intel_scu_ipc_dev *
21 __intel_scu_ipc_register(struct device *parent,
22 			 const struct intel_scu_ipc_data *scu_data,
23 			 struct module *owner);
24 
25 #define intel_scu_ipc_register(parent, scu_data)  \
26 	__intel_scu_ipc_register(parent, scu_data, THIS_MODULE)
27 
28 void intel_scu_ipc_unregister(struct intel_scu_ipc_dev *scu);
29 
30 struct intel_scu_ipc_dev *
31 __devm_intel_scu_ipc_register(struct device *parent,
32 			      const struct intel_scu_ipc_data *scu_data,
33 			      struct module *owner);
34 
35 #define devm_intel_scu_ipc_register(parent, scu_data)  \
36 	__devm_intel_scu_ipc_register(parent, scu_data, THIS_MODULE)
37 
38 struct intel_scu_ipc_dev *intel_scu_ipc_dev_get(void);
39 void intel_scu_ipc_dev_put(struct intel_scu_ipc_dev *scu);
40 struct intel_scu_ipc_dev *devm_intel_scu_ipc_dev_get(struct device *dev);
41 
42 int intel_scu_ipc_dev_ioread8(struct intel_scu_ipc_dev *scu, u16 addr,
43 			      u8 *data);
44 int intel_scu_ipc_dev_iowrite8(struct intel_scu_ipc_dev *scu, u16 addr,
45 			       u8 data);
46 int intel_scu_ipc_dev_readv(struct intel_scu_ipc_dev *scu, u16 *addr,
47 			    u8 *data, size_t len);
48 int intel_scu_ipc_dev_writev(struct intel_scu_ipc_dev *scu, u16 *addr,
49 			     u8 *data, size_t len);
50 
51 int intel_scu_ipc_dev_update(struct intel_scu_ipc_dev *scu, u16 addr,
52 			     u8 data, u8 mask);
53 
54 int intel_scu_ipc_dev_simple_command(struct intel_scu_ipc_dev *scu, int cmd,
55 				     int sub);
56 int intel_scu_ipc_dev_command_with_size(struct intel_scu_ipc_dev *scu, int cmd,
57 					int sub, const void *in, size_t inlen,
58 					size_t size, void *out, size_t outlen);
59 
intel_scu_ipc_dev_command(struct intel_scu_ipc_dev * scu,int cmd,int sub,const void * in,size_t inlen,void * out,size_t outlen)60 static inline int intel_scu_ipc_dev_command(struct intel_scu_ipc_dev *scu, int cmd,
61 					    int sub, const void *in, size_t inlen,
62 					    void *out, size_t outlen)
63 {
64 	return intel_scu_ipc_dev_command_with_size(scu, cmd, sub, in, inlen,
65 						   inlen, out, outlen);
66 }
67 
68 #endif
69