1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * (C) COPYRIGHT 2018 ARM Limited. All rights reserved.
4  * Author: James.Qian.Wang <james.qian.wang@arm.com>
5  *
6  */
7 #ifndef _KOMEDA_DEV_H_
8 #define _KOMEDA_DEV_H_
9 
10 #include <linux/device.h>
11 #include <linux/clk.h>
12 #include "komeda_pipeline.h"
13 #include "malidp_product.h"
14 #include "komeda_format_caps.h"
15 
16 #define KOMEDA_EVENT_VSYNC		BIT_ULL(0)
17 #define KOMEDA_EVENT_FLIP		BIT_ULL(1)
18 #define KOMEDA_EVENT_URUN		BIT_ULL(2)
19 #define KOMEDA_EVENT_IBSY		BIT_ULL(3)
20 #define KOMEDA_EVENT_OVR		BIT_ULL(4)
21 #define KOMEDA_EVENT_EOW		BIT_ULL(5)
22 #define KOMEDA_EVENT_MODE		BIT_ULL(6)
23 
24 #define KOMEDA_ERR_TETO			BIT_ULL(14)
25 #define KOMEDA_ERR_TEMR			BIT_ULL(15)
26 #define KOMEDA_ERR_TITR			BIT_ULL(16)
27 #define KOMEDA_ERR_CPE			BIT_ULL(17)
28 #define KOMEDA_ERR_CFGE			BIT_ULL(18)
29 #define KOMEDA_ERR_AXIE			BIT_ULL(19)
30 #define KOMEDA_ERR_ACE0			BIT_ULL(20)
31 #define KOMEDA_ERR_ACE1			BIT_ULL(21)
32 #define KOMEDA_ERR_ACE2			BIT_ULL(22)
33 #define KOMEDA_ERR_ACE3			BIT_ULL(23)
34 #define KOMEDA_ERR_DRIFTTO		BIT_ULL(24)
35 #define KOMEDA_ERR_FRAMETO		BIT_ULL(25)
36 #define KOMEDA_ERR_CSCE			BIT_ULL(26)
37 #define KOMEDA_ERR_ZME			BIT_ULL(27)
38 #define KOMEDA_ERR_MERR			BIT_ULL(28)
39 #define KOMEDA_ERR_TCF			BIT_ULL(29)
40 #define KOMEDA_ERR_TTNG			BIT_ULL(30)
41 #define KOMEDA_ERR_TTF			BIT_ULL(31)
42 
43 /* malidp device id */
44 enum {
45 	MALI_D71 = 0,
46 };
47 
48 /* pipeline DT ports */
49 enum {
50 	KOMEDA_OF_PORT_OUTPUT		= 0,
51 	KOMEDA_OF_PORT_COPROC		= 1,
52 };
53 
54 struct komeda_chip_info {
55 	u32 arch_id;
56 	u32 core_id;
57 	u32 core_info;
58 	u32 bus_width;
59 };
60 
61 struct komeda_product_data {
62 	u32 product_id;
63 	struct komeda_dev_funcs *(*identify)(u32 __iomem *reg,
64 					     struct komeda_chip_info *info);
65 };
66 
67 struct komeda_dev;
68 
69 struct komeda_events {
70 	u64 global;
71 	u64 pipes[KOMEDA_MAX_PIPELINES];
72 };
73 
74 /**
75  * struct komeda_dev_funcs
76  *
77  * Supplied by chip level and returned by the chip entry function xxx_identify,
78  */
79 struct komeda_dev_funcs {
80 	/**
81 	 * @init_format_table:
82 	 *
83 	 * initialize &komeda_dev->format_table, this function should be called
84 	 * before the &enum_resource
85 	 */
86 	void (*init_format_table)(struct komeda_dev *mdev);
87 	/**
88 	 * @enum_resources:
89 	 *
90 	 * for CHIP to report or add pipeline and component resources to CORE
91 	 */
92 	int (*enum_resources)(struct komeda_dev *mdev);
93 	/** @cleanup: call to chip to cleanup komeda_dev->chip data */
94 	void (*cleanup)(struct komeda_dev *mdev);
95 	/**
96 	 * @irq_handler:
97 	 *
98 	 * for CORE to get the HW event from the CHIP when interrupt happened.
99 	 */
100 	irqreturn_t (*irq_handler)(struct komeda_dev *mdev,
101 				   struct komeda_events *events);
102 	/** @enable_irq: enable irq */
103 	int (*enable_irq)(struct komeda_dev *mdev);
104 	/** @disable_irq: disable irq */
105 	int (*disable_irq)(struct komeda_dev *mdev);
106 
107 	/** @dump_register: Optional, dump registers to seq_file */
108 	void (*dump_register)(struct komeda_dev *mdev, struct seq_file *seq);
109 };
110 
111 /**
112  * struct komeda_dev
113  *
114  * Pipeline and component are used to describe how to handle the pixel data.
115  * komeda_device is for describing the whole view of the device, and the
116  * control-abilites of device.
117  */
118 struct komeda_dev {
119 	struct device *dev;
120 	u32 __iomem   *reg_base;
121 
122 	struct komeda_chip_info chip;
123 	/** @fmt_tbl: initialized by &komeda_dev_funcs->init_format_table */
124 	struct komeda_format_caps_table fmt_tbl;
125 	/** @pclk: APB clock for register access */
126 	struct clk *pclk;
127 	/** @mck: HW main engine clk */
128 	struct clk *mclk;
129 
130 	/** @irq: irq number */
131 	int irq;
132 
133 	int n_pipelines;
134 	struct komeda_pipeline *pipelines[KOMEDA_MAX_PIPELINES];
135 
136 	/** @funcs: chip funcs to access to HW */
137 	struct komeda_dev_funcs *funcs;
138 	/**
139 	 * @chip_data:
140 	 *
141 	 * chip data will be added by &komeda_dev_funcs.enum_resources() and
142 	 * destroyed by &komeda_dev_funcs.cleanup()
143 	 */
144 	void *chip_data;
145 
146 	struct dentry *debugfs_root;
147 };
148 
149 static inline bool
150 komeda_product_match(struct komeda_dev *mdev, u32 target)
151 {
152 	return MALIDP_CORE_ID_PRODUCT_ID(mdev->chip.core_id) == target;
153 }
154 
155 struct komeda_dev_funcs *
156 d71_identify(u32 __iomem *reg, struct komeda_chip_info *chip);
157 
158 struct komeda_dev *komeda_dev_create(struct device *dev);
159 void komeda_dev_destroy(struct komeda_dev *mdev);
160 
161 #endif /*_KOMEDA_DEV_H_*/
162