intel_scu_ipc.h

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