/* SPDX-License-Identifier: GPL-2.0 */
/*
 * DRM Driver for DSI output on Raspberry Pi RP1
 *
 * Copyright (c) 2023 Raspberry Pi Limited.
 */

#include <linux/types.h>
#include <linux/io.h>
#include <linux/clk.h>
#include <drm/drm_device.h>
#include <drm/drm_simple_kms_helper.h>

#define MODULE_NAME "drm-rp1-vec"
#define DRIVER_NAME "drm-rp1-vec"

/* ---------------------------------------------------------------------- */

#define RP1VEC_HW_BLOCK_VEC   0
#define RP1VEC_HW_BLOCK_CFG   1
#define RP1VEC_NUM_HW_BLOCKS  2

#define RP1VEC_SUPPORTED_TV_MODES	  \
	(BIT(DRM_MODE_TV_MODE_NTSC)	| \
	 BIT(DRM_MODE_TV_MODE_NTSC_443) | \
	 BIT(DRM_MODE_TV_MODE_NTSC_J)	| \
	 BIT(DRM_MODE_TV_MODE_PAL)	| \
	 BIT(DRM_MODE_TV_MODE_PAL_M)	| \
	 BIT(DRM_MODE_TV_MODE_PAL_N)	| \
	 BIT(DRM_MODE_TV_MODE_MONOCHROME))

#define RP1VEC_VDAC_KHZ 108000

/* ---------------------------------------------------------------------- */

struct rp1_vec {
	/* DRM base and platform device pointer */
	struct drm_device drm;
	struct platform_device *pdev;

	/* Framework and helper objects */
	struct drm_simple_display_pipe pipe;
	struct drm_connector connector;

	/* Clock. We assume this is always at 108 MHz. */
	struct clk *vec_clock;

	/* Block (VCC, CFG) base addresses, and current state */
	void __iomem *hw_base[RP1VEC_NUM_HW_BLOCKS];
	u32 cur_fmt;
	bool fake_31khz, vec_running, pipe_enabled;
	struct completion finished;

	spinlock_t hw_lock; /* the following are used in line-match ISR */
	dma_addr_t last_dma_addr;
	u32 last_stride;
	bool field_flip;
	bool lower_field_flag;
};

/* ---------------------------------------------------------------------- */
/* Functions to control the VEC/DMA block				  */

void rp1vec_hw_setup(struct rp1_vec *vec,
		     u32 in_format,
		     struct drm_display_mode const *mode,
		     int tvstd);
void rp1vec_hw_update(struct rp1_vec *vec, dma_addr_t addr, u32 offset, u32 stride);
void rp1vec_hw_stop(struct rp1_vec *vec);
int rp1vec_hw_busy(struct rp1_vec *vec);
irqreturn_t rp1vec_hw_isr(int irq, void *dev);
void rp1vec_hw_vblank_ctrl(struct rp1_vec *vec, int enable);

/* ---------------------------------------------------------------------- */
/* Functions to control the VIDEO OUT CFG block and check RP1 platform	  */

void rp1vec_vidout_setup(struct rp1_vec *vec);
void rp1vec_vidout_poweroff(struct rp1_vec *vec);