[deliverable/linux.git] / drivers / gpu / drm / msm / msm_gpu.h

/*
 * Copyright (C) 2013 Red Hat
 * Author: Rob Clark <robdclark@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __MSM_GPU_H__
#define __MSM_GPU_H__

#include <linux/clk.h>
#include <linux/regulator/consumer.h>

#include "msm_drv.h"
#include "msm_ringbuffer.h"

struct msm_gem_submit;
struct msm_gpu_perfcntr;

/* So far, with hardware that I've seen to date, we can have:
 *  + zero, one, or two z180 2d cores
 *  + a3xx or a2xx 3d core, which share a common CP (the firmware
 *    for the CP seems to implement some different PM4 packet types
 *    but the basics of cmdstream submission are the same)
 *
 * Which means that the eventual complete "class" hierarchy, once
 * support for all past and present hw is in place, becomes:
 *  + msm_gpu
 *    + adreno_gpu
 *      + a3xx_gpu
 *      + a2xx_gpu
 *    + z180_gpu
 */
struct msm_gpu_funcs {
	int (*get_param)(struct msm_gpu *gpu, uint32_t param, uint64_t *value);
	int (*hw_init)(struct msm_gpu *gpu);
	int (*pm_suspend)(struct msm_gpu *gpu);
	int (*pm_resume)(struct msm_gpu *gpu);
	int (*submit)(struct msm_gpu *gpu, struct msm_gem_submit *submit,
			struct msm_file_private *ctx);
	void (*flush)(struct msm_gpu *gpu);
	void (*idle)(struct msm_gpu *gpu);
	irqreturn_t (*irq)(struct msm_gpu *irq);
	uint32_t (*last_fence)(struct msm_gpu *gpu);
	void (*recover)(struct msm_gpu *gpu);
	void (*destroy)(struct msm_gpu *gpu);
#ifdef CONFIG_DEBUG_FS
	/* show GPU status in debugfs: */
	void (*show)(struct msm_gpu *gpu, struct seq_file *m);
#endif
};

struct msm_gpu {
	const char *name;
	struct drm_device *dev;
	const struct msm_gpu_funcs *funcs;

	/* performance counters (hw & sw): */
	spinlock_t perf_lock;
	bool perfcntr_active;
	struct {
		bool active;
		ktime_t time;
	} last_sample;
	uint32_t totaltime, activetime;    /* sw counters */
	uint32_t last_cntrs[5];            /* hw counters */
	const struct msm_gpu_perfcntr *perfcntrs;
	uint32_t num_perfcntrs;

	struct msm_ringbuffer *rb;
	uint32_t rb_iova;

	/* list of GEM active objects: */
	struct list_head active_list;

	uint32_t submitted_fence;

	/* is gpu powered/active? */
	int active_cnt;
	bool inactive;

	/* worker for handling active-list retiring: */
	struct work_struct retire_work;

	void __iomem *mmio;
	int irq;

	struct msm_mmu *mmu;
	int id;

	/* Power Control: */
	struct regulator *gpu_reg, *gpu_cx;
	struct clk *ebi1_clk, *grp_clks[6];
	uint32_t fast_rate, slow_rate, bus_freq;

#ifdef DOWNSTREAM_CONFIG_MSM_BUS_SCALING
	struct msm_bus_scale_pdata *bus_scale_table;
	uint32_t bsc;
#endif

	/* Hang and Inactivity Detection:
	 */
#define DRM_MSM_INACTIVE_PERIOD   66 /* in ms (roughly four frames) */
#define DRM_MSM_INACTIVE_JIFFIES  msecs_to_jiffies(DRM_MSM_INACTIVE_PERIOD)
	struct timer_list inactive_timer;
	struct work_struct inactive_work;
#define DRM_MSM_HANGCHECK_PERIOD 500 /* in ms */
#define DRM_MSM_HANGCHECK_JIFFIES msecs_to_jiffies(DRM_MSM_HANGCHECK_PERIOD)
	struct timer_list hangcheck_timer;
	uint32_t hangcheck_fence;
	struct work_struct recover_work;

	struct list_head submit_list;
};

static inline bool msm_gpu_active(struct msm_gpu *gpu)
{
	return gpu->submitted_fence > gpu->funcs->last_fence(gpu);
}

/* Perf-Counters:
 * The select_reg and select_val are just there for the benefit of the child
 * class that actually enables the perf counter..  but msm_gpu base class
 * will handle sampling/displaying the counters.
 */

struct msm_gpu_perfcntr {
	uint32_t select_reg;
	uint32_t sample_reg;
	uint32_t select_val;
	const char *name;
};

static inline void gpu_write(struct msm_gpu *gpu, u32 reg, u32 data)
{
	msm_writel(data, gpu->mmio + (reg << 2));
}

static inline u32 gpu_read(struct msm_gpu *gpu, u32 reg)
{
	return msm_readl(gpu->mmio + (reg << 2));
}

int msm_gpu_pm_suspend(struct msm_gpu *gpu);
int msm_gpu_pm_resume(struct msm_gpu *gpu);

void msm_gpu_perfcntr_start(struct msm_gpu *gpu);
void msm_gpu_perfcntr_stop(struct msm_gpu *gpu);
int msm_gpu_perfcntr_sample(struct msm_gpu *gpu, uint32_t *activetime,
		uint32_t *totaltime, uint32_t ncntrs, uint32_t *cntrs);

void msm_gpu_retire(struct msm_gpu *gpu);
int msm_gpu_submit(struct msm_gpu *gpu, struct msm_gem_submit *submit,
		struct msm_file_private *ctx);

int msm_gpu_init(struct drm_device *drm, struct platform_device *pdev,
		struct msm_gpu *gpu, const struct msm_gpu_funcs *funcs,
		const char *name, const char *ioname, const char *irqname, int ringsz);
void msm_gpu_cleanup(struct msm_gpu *gpu);

struct msm_gpu *adreno_load_gpu(struct drm_device *dev);
void __init adreno_register(void);
void __exit adreno_unregister(void);

#endif /* __MSM_GPU_H__ */
Commit	Line	Data
7198e6b0 RC	1	/*
	2	* Copyright (C) 2013 Red Hat
	3	* Author: Rob Clark <robdclark@gmail.com>
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License version 2 as published by
	7	* the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	* You should have received a copy of the GNU General Public License along with
	15	* this program. If not, see <http://www.gnu.org/licenses/>.
	16	*/
	17
	18	#ifndef __MSM_GPU_H__
	19	#define __MSM_GPU_H__
	20
	21	#include <linux/clk.h>
	22	#include <linux/regulator/consumer.h>
	23
	24	#include "msm_drv.h"
	25	#include "msm_ringbuffer.h"
	26
	27	struct msm_gem_submit;
70c70f09	28	struct msm_gpu_perfcntr;
7198e6b0 RC	29
	30	/* So far, with hardware that I've seen to date, we can have:
	31	* + zero, one, or two z180 2d cores
	32	* + a3xx or a2xx 3d core, which share a common CP (the firmware
	33	* for the CP seems to implement some different PM4 packet types
	34	* but the basics of cmdstream submission are the same)
	35	*
	36	* Which means that the eventual complete "class" hierarchy, once
	37	* support for all past and present hw is in place, becomes:
	38	* + msm_gpu
	39	* + adreno_gpu
	40	* + a3xx_gpu
	41	* + a2xx_gpu
	42	* + z180_gpu
	43	*/
	44	struct msm_gpu_funcs {
	45	int (get_param)(struct msm_gpu gpu, uint32_t param, uint64_t *value);
	46	int (hw_init)(struct msm_gpu gpu);
	47	int (pm_suspend)(struct msm_gpu gpu);
	48	int (pm_resume)(struct msm_gpu gpu);
	49	int (submit)(struct msm_gpu gpu, struct msm_gem_submit *submit,
	50	struct msm_file_private *ctx);
	51	void (flush)(struct msm_gpu gpu);
	52	void (idle)(struct msm_gpu gpu);
	53	irqreturn_t (irq)(struct msm_gpu irq);
	54	uint32_t (last_fence)(struct msm_gpu gpu);
bd6f82d8	55	void (recover)(struct msm_gpu gpu);
7198e6b0 RC	56	void (destroy)(struct msm_gpu gpu);
	57	#ifdef CONFIG_DEBUG_FS
	58	/* show GPU status in debugfs: */
	59	void (show)(struct msm_gpu gpu, struct seq_file *m);
	60	#endif
	61	};
	62
	63	struct msm_gpu {
	64	const char *name;
	65	struct drm_device *dev;
	66	const struct msm_gpu_funcs *funcs;
	67
70c70f09 RC	68	/* performance counters (hw & sw): */
	69	spinlock_t perf_lock;
	70	bool perfcntr_active;
	71	struct {
	72	bool active;
	73	ktime_t time;
	74	} last_sample;
	75	uint32_t totaltime, activetime; /* sw counters */
	76	uint32_t last_cntrs[5]; /* hw counters */
	77	const struct msm_gpu_perfcntr *perfcntrs;
	78	uint32_t num_perfcntrs;
	79
7198e6b0 RC	80	struct msm_ringbuffer *rb;
	81	uint32_t rb_iova;
	82
	83	/* list of GEM active objects: */
	84	struct list_head active_list;
	85
bd6f82d8 RC	86	uint32_t submitted_fence;
bd6f82d8 RC	87
37d77c3a RC	88	/* is gpu powered/active? */
	89	int active_cnt;
	90	bool inactive;
	91
7198e6b0 RC	92	/* worker for handling active-list retiring: */
	93	struct work_struct retire_work;
	94
	95	void __iomem *mmio;
	96	int irq;
	97
871d812a	98	struct msm_mmu *mmu;
7198e6b0 RC	99	int id;
	100
	101	/* Power Control: */
	102	struct regulator gpu_reg, gpu_cx;
de558cd2	103	struct clk ebi1_clk, grp_clks[6];
7198e6b0	104	uint32_t fast_rate, slow_rate, bus_freq;
bf2b33af	105
6490ad47	106	#ifdef DOWNSTREAM_CONFIG_MSM_BUS_SCALING
bf2b33af	107	struct msm_bus_scale_pdata *bus_scale_table;
7198e6b0	108	uint32_t bsc;
bf2b33af	109	#endif
bd6f82d8	110
37d77c3a RC	111	/* Hang and Inactivity Detection:
	112	*/
	113	#define DRM_MSM_INACTIVE_PERIOD 66 /* in ms (roughly four frames) */
	114	#define DRM_MSM_INACTIVE_JIFFIES msecs_to_jiffies(DRM_MSM_INACTIVE_PERIOD)
	115	struct timer_list inactive_timer;
	116	struct work_struct inactive_work;
bd6f82d8 RC	117	#define DRM_MSM_HANGCHECK_PERIOD 500 /* in ms */
	118	#define DRM_MSM_HANGCHECK_JIFFIES msecs_to_jiffies(DRM_MSM_HANGCHECK_PERIOD)
	119	struct timer_list hangcheck_timer;
	120	uint32_t hangcheck_fence;
	121	struct work_struct recover_work;
1a370be9 RC	122
1a370be9 RC	123	struct list_head submit_list;
7198e6b0 RC	124	};
7198e6b0 RC	125
37d77c3a RC	126	static inline bool msm_gpu_active(struct msm_gpu *gpu)
	127	{
	128	return gpu->submitted_fence > gpu->funcs->last_fence(gpu);
	129	}
	130
70c70f09 RC	131	/* Perf-Counters:
	132	* The select_reg and select_val are just there for the benefit of the child
	133	* class that actually enables the perf counter.. but msm_gpu base class
	134	* will handle sampling/displaying the counters.
	135	*/
	136
	137	struct msm_gpu_perfcntr {
	138	uint32_t select_reg;
	139	uint32_t sample_reg;
	140	uint32_t select_val;
	141	const char *name;
	142	};
	143
7198e6b0 RC	144	static inline void gpu_write(struct msm_gpu *gpu, u32 reg, u32 data)
	145	{
	146	msm_writel(data, gpu->mmio + (reg << 2));
	147	}
	148
	149	static inline u32 gpu_read(struct msm_gpu *gpu, u32 reg)
	150	{
	151	return msm_readl(gpu->mmio + (reg << 2));
	152	}
	153
	154	int msm_gpu_pm_suspend(struct msm_gpu *gpu);
	155	int msm_gpu_pm_resume(struct msm_gpu *gpu);
	156
70c70f09 RC	157	void msm_gpu_perfcntr_start(struct msm_gpu *gpu);
	158	void msm_gpu_perfcntr_stop(struct msm_gpu *gpu);
	159	int msm_gpu_perfcntr_sample(struct msm_gpu gpu, uint32_t activetime,
	160	uint32_t totaltime, uint32_t ncntrs, uint32_t cntrs);
	161
7198e6b0 RC	162	void msm_gpu_retire(struct msm_gpu *gpu);
	163	int msm_gpu_submit(struct msm_gpu gpu, struct msm_gem_submit submit,
	164	struct msm_file_private *ctx);
	165
	166	int msm_gpu_init(struct drm_device drm, struct platform_device pdev,
	167	struct msm_gpu gpu, const struct msm_gpu_funcs funcs,
	168	const char name, const char ioname, const char *irqname, int ringsz);
	169	void msm_gpu_cleanup(struct msm_gpu *gpu);
	170
e2550b7a	171	struct msm_gpu adreno_load_gpu(struct drm_device dev);
bfd28b13 RC	172	void __init adreno_register(void);
bfd28b13 RC	173	void __exit adreno_unregister(void);
7198e6b0 RC	174
7198e6b0 RC	175	#endif /* __MSM_GPU_H__ */