xref: /OK3568_Linux_fs/kernel/include/soc/qcom/ocmem.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * The On Chip Memory (OCMEM) allocator allows various clients to allocate
4*4882a593Smuzhiyun  * memory from OCMEM based on performance, latency and power requirements.
5*4882a593Smuzhiyun  * This is typically used by the GPU, camera/video, and audio components on
6*4882a593Smuzhiyun  * some Snapdragon SoCs.
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * Copyright (C) 2019 Brian Masney <masneyb@onstation.org>
9*4882a593Smuzhiyun  * Copyright (C) 2015 Red Hat. Author: Rob Clark <robdclark@gmail.com>
10*4882a593Smuzhiyun  */
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <linux/device.h>
13*4882a593Smuzhiyun #include <linux/err.h>
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #ifndef __OCMEM_H__
16*4882a593Smuzhiyun #define __OCMEM_H__
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun enum ocmem_client {
19*4882a593Smuzhiyun 	/* GMEM clients */
20*4882a593Smuzhiyun 	OCMEM_GRAPHICS = 0x0,
21*4882a593Smuzhiyun 	/*
22*4882a593Smuzhiyun 	 * TODO add more once ocmem_allocate() is clever enough to
23*4882a593Smuzhiyun 	 * deal with multiple clients.
24*4882a593Smuzhiyun 	 */
25*4882a593Smuzhiyun 	OCMEM_CLIENT_MAX,
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun struct ocmem;
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun struct ocmem_buf {
31*4882a593Smuzhiyun 	unsigned long offset;
32*4882a593Smuzhiyun 	unsigned long addr;
33*4882a593Smuzhiyun 	unsigned long len;
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun #if IS_ENABLED(CONFIG_QCOM_OCMEM)
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun struct ocmem *of_get_ocmem(struct device *dev);
39*4882a593Smuzhiyun struct ocmem_buf *ocmem_allocate(struct ocmem *ocmem, enum ocmem_client client,
40*4882a593Smuzhiyun 				 unsigned long size);
41*4882a593Smuzhiyun void ocmem_free(struct ocmem *ocmem, enum ocmem_client client,
42*4882a593Smuzhiyun 		struct ocmem_buf *buf);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #else /* IS_ENABLED(CONFIG_QCOM_OCMEM) */
45*4882a593Smuzhiyun 
of_get_ocmem(struct device * dev)46*4882a593Smuzhiyun static inline struct ocmem *of_get_ocmem(struct device *dev)
47*4882a593Smuzhiyun {
48*4882a593Smuzhiyun 	return ERR_PTR(-ENODEV);
49*4882a593Smuzhiyun }
50*4882a593Smuzhiyun 
ocmem_allocate(struct ocmem * ocmem,enum ocmem_client client,unsigned long size)51*4882a593Smuzhiyun static inline struct ocmem_buf *ocmem_allocate(struct ocmem *ocmem,
52*4882a593Smuzhiyun 					       enum ocmem_client client,
53*4882a593Smuzhiyun 					       unsigned long size)
54*4882a593Smuzhiyun {
55*4882a593Smuzhiyun 	return ERR_PTR(-ENODEV);
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun 
ocmem_free(struct ocmem * ocmem,enum ocmem_client client,struct ocmem_buf * buf)58*4882a593Smuzhiyun static inline void ocmem_free(struct ocmem *ocmem, enum ocmem_client client,
59*4882a593Smuzhiyun 			      struct ocmem_buf *buf)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun #endif /* IS_ENABLED(CONFIG_QCOM_OCMEM) */
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #endif /* __OCMEM_H__ */
66