/*
 * drivers/video/tegra/host/nvhost_intr.h
 *
 * Tegra Graphics Host Interrupt Management
 *
 * Copyright (c) 2010-2017, NVIDIA Corporation.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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 __NVHOST_INTR_H
#define __NVHOST_INTR_H

#include <linux/kthread.h>
#include <linux/semaphore.h>
#include <linux/interrupt.h>
#include <linux/workqueue.h>
#include <linux/spinlock.h>
#include <linux/version.h>
#if LINUX_VERSION_CODE > KERNEL_VERSION(4, 13, 0)
#include <linux/wait.h>
#endif

#include "nvhost_ktime.h"

struct nvhost_channel;
struct platform_device;

enum nvhost_intr_action {
	/**
	 * Signal a nvhost_sync_pt.
	 * 'data' points to a nvhost_sync_pt
	 */
	NVHOST_INTR_ACTION_SIGNAL_SYNC_PT = 0,

	/**
	 * Wake up a  task.
	 * 'data' points to a wait_queue_head_t
	 */
	NVHOST_INTR_ACTION_WAKEUP,

	/**
	 * Wake up a interruptible task.
	 * 'data' points to a wait_queue_head_t
	 */
	NVHOST_INTR_ACTION_WAKEUP_INTERRUPTIBLE,

	/**
	 * Fast notifier event
	 * 'data' points to a callback and private data through internal
	 * structure
	 */
	NVHOST_INTR_ACTION_FAST_NOTIFY,

	/**
	 * Perform cleanup after a submit has completed.
	 * 'data' points to a channel
	 */
	NVHOST_INTR_ACTION_SUBMIT_COMPLETE,

	/**
	 * Notify some external function about completion
	 * 'data' holds pointer to an internal structure that holds a
	 * function pointer and the stored private data
	 */
	NVHOST_INTR_ACTION_NOTIFY,

	NVHOST_INTR_ACTION_COUNT
};

#define NVHOST_INTR_HIGH_PRIO_COUNT NVHOST_INTR_ACTION_SUBMIT_COMPLETE
#define NVHOST_INTR_LOW_PRIO_COUNT \
	(NVHOST_INTR_ACTION_COUNT - NVHOST_INTR_HIGH_PRIO_COUNT)

struct nvhost_intr;

struct nvhost_waitlist {
	struct nvhost_master *host;
	struct list_head list;
	struct kref refcount;
	u32 thresh;
	enum nvhost_intr_action action;
	atomic_t state;
	struct nvhost_timespec isr_recv;
	void *data;
	int count;
	wait_queue_head_t wq;
};

struct nvhost_waitlist_external_notifier {
	struct nvhost_master *master;
	void (*callback)(void *, int);
	void *private_data;
	bool reuse;
};

struct nvhost_intr_syncpt {
	struct nvhost_intr *intr;
	u32 id;
	spinlock_t lock;
	struct list_head wait_head;
	char thresh_irq_name[12];
	struct nvhost_timespec isr_recv;
	struct work_struct low_prio_work;
	struct list_head low_prio_handlers[NVHOST_INTR_LOW_PRIO_COUNT];
};

struct nvhost_intr {
	struct nvhost_intr_syncpt *syncpt;
	struct mutex mutex;
	int general_irq;
	int syncpt_irq;
	u32 intstatus;
	void (*host_isr[32])(u32, void*);
	void *host_isr_priv[32];
	struct workqueue_struct *low_prio_wq;
};
#define intr_to_dev(x) container_of(x, struct nvhost_master, intr)
#define intr_syncpt_to_intr(is) (is->intr)

/**
 * Schedule an action to be taken when a sync point reaches the given threshold.
 *
 * @id the sync point
 * @thresh the threshold
 * @action the action to take
 * @data a pointer to extra data depending on action, see above
 * @waiter waiter allocated with nvhost_intr_alloc_waiter - assumes ownership
 * @ref must be passed if cancellation is possible, else NULL
 *
 * This is a non-blocking api.
 */
int nvhost_intr_add_action(struct nvhost_intr *intr, u32 id, u32 thresh,
			enum nvhost_intr_action action, void *data,
			void *waiter,
			void **ref);

bool nvhost_intr_has_pending_jobs(struct nvhost_intr *intr, u32 id,
			void *exlude_data);

/**
 * Allocate a waiter.
 */
void *nvhost_intr_alloc_waiter(void);

/**
 * Unreference an action submitted to nvhost_intr_add_action().
 * You must call this if you passed non-NULL as ref.
 * @ref the ref returned from nvhost_intr_add_action()
 */
void nvhost_intr_put_ref(struct nvhost_intr *intr, u32 id, void *ref);

int nvhost_intr_init(struct nvhost_intr *intr, u32 irq_gen, u32 irq_sync);
void nvhost_intr_deinit(struct nvhost_intr *intr);
int nvhost_intr_start(struct nvhost_intr *intr, u32 hz);
int nvhost_intr_stop(struct nvhost_intr *intr);
int nvhost_intr_release_time(void *ref, struct nvhost_timespec *ts);
void nvhost_intr_enable_host_irq(struct nvhost_intr *intr, int irq,
				 void (*host_isr)(u32, void *),
				 void *priv);
void nvhost_intr_disable_host_irq(struct nvhost_intr *intr, int irq);
void nvhost_intr_enable_module_intr(struct nvhost_intr *intr, int module_irq);
void nvhost_intr_disable_module_intr(struct nvhost_intr *intr, int module_irq);

void nvhost_syncpt_thresh_fn(void *dev_id);
irqreturn_t nvhost_intr_irq_fn(int irq, void *dev_id);
#if defined(CONFIG_TEGRA_GRHOST_SCALE)
void nvhost_scale_actmon_irq(struct platform_device *pdev, int type);
#else
static inline void nvhost_scale_actmon_irq(struct platform_device *pdev,
					   int type) { }
#endif
#endif