18148baabSPratyush Yadav /* SPDX-License-Identifier: GPL-2.0-only */
28148baabSPratyush Yadav /*
38148baabSPratyush Yadav * TI Camera Access Layer (CAL)
48148baabSPratyush Yadav *
58148baabSPratyush Yadav * Copyright (c) 2015-2020 Texas Instruments Inc.
68148baabSPratyush Yadav *
78148baabSPratyush Yadav * Authors:
88148baabSPratyush Yadav * Benoit Parrot <bparrot@ti.com>
98148baabSPratyush Yadav * Laurent Pinchart <laurent.pinchart@ideasonboard.com>
108148baabSPratyush Yadav */
118148baabSPratyush Yadav #ifndef __TI_CAL_H__
128148baabSPratyush Yadav #define __TI_CAL_H__
138148baabSPratyush Yadav
148148baabSPratyush Yadav #include <linux/bitfield.h>
158148baabSPratyush Yadav #include <linux/io.h>
168148baabSPratyush Yadav #include <linux/list.h>
178148baabSPratyush Yadav #include <linux/mutex.h>
188148baabSPratyush Yadav #include <linux/spinlock.h>
198148baabSPratyush Yadav #include <linux/videodev2.h>
208148baabSPratyush Yadav #include <linux/wait.h>
218148baabSPratyush Yadav
228148baabSPratyush Yadav #include <media/media-device.h>
238148baabSPratyush Yadav #include <media/v4l2-async.h>
248148baabSPratyush Yadav #include <media/v4l2-ctrls.h>
258148baabSPratyush Yadav #include <media/v4l2-dev.h>
268148baabSPratyush Yadav #include <media/v4l2-device.h>
278148baabSPratyush Yadav #include <media/v4l2-fwnode.h>
288148baabSPratyush Yadav #include <media/v4l2-subdev.h>
298148baabSPratyush Yadav #include <media/videobuf2-v4l2.h>
308148baabSPratyush Yadav
318148baabSPratyush Yadav #define CAL_MODULE_NAME "cal"
328148baabSPratyush Yadav #define CAL_MAX_NUM_CONTEXT 8
338148baabSPratyush Yadav #define CAL_NUM_CSI2_PORTS 2
348148baabSPratyush Yadav
358148baabSPratyush Yadav /*
368148baabSPratyush Yadav * The width is limited by the size of the CAL_WR_DMA_XSIZE_j.XSIZE field,
378148baabSPratyush Yadav * expressed in multiples of 64 bits. The height is limited by the size of the
388148baabSPratyush Yadav * CAL_CSI2_CTXi_j.CTXi_LINES and CAL_WR_DMA_CTRL_j.YSIZE fields, expressed in
398148baabSPratyush Yadav * lines.
408148baabSPratyush Yadav */
418148baabSPratyush Yadav #define CAL_MIN_WIDTH_BYTES 16
428148baabSPratyush Yadav #define CAL_MAX_WIDTH_BYTES (8192 * 8)
438148baabSPratyush Yadav #define CAL_MIN_HEIGHT_LINES 1
448148baabSPratyush Yadav #define CAL_MAX_HEIGHT_LINES 16383
458148baabSPratyush Yadav
468148baabSPratyush Yadav #define CAL_CAMERARX_PAD_SINK 0
478148baabSPratyush Yadav #define CAL_CAMERARX_PAD_FIRST_SOURCE 1
488148baabSPratyush Yadav #define CAL_CAMERARX_NUM_SOURCE_PADS 1
498148baabSPratyush Yadav #define CAL_CAMERARX_NUM_PADS (1 + CAL_CAMERARX_NUM_SOURCE_PADS)
508148baabSPratyush Yadav
cal_rx_pad_is_sink(u32 pad)518148baabSPratyush Yadav static inline bool cal_rx_pad_is_sink(u32 pad)
528148baabSPratyush Yadav {
538148baabSPratyush Yadav /* Camera RX has 1 sink pad, and N source pads */
548148baabSPratyush Yadav return pad == 0;
558148baabSPratyush Yadav }
568148baabSPratyush Yadav
cal_rx_pad_is_source(u32 pad)578148baabSPratyush Yadav static inline bool cal_rx_pad_is_source(u32 pad)
588148baabSPratyush Yadav {
598148baabSPratyush Yadav /* Camera RX has 1 sink pad, and N source pads */
608148baabSPratyush Yadav return pad >= CAL_CAMERARX_PAD_FIRST_SOURCE &&
618148baabSPratyush Yadav pad <= CAL_CAMERARX_NUM_SOURCE_PADS;
628148baabSPratyush Yadav }
638148baabSPratyush Yadav
648148baabSPratyush Yadav struct device;
658148baabSPratyush Yadav struct device_node;
668148baabSPratyush Yadav struct resource;
678148baabSPratyush Yadav struct regmap;
688148baabSPratyush Yadav struct regmap_fied;
698148baabSPratyush Yadav
708148baabSPratyush Yadav /* CTRL_CORE_CAMERRX_CONTROL register field id */
718148baabSPratyush Yadav enum cal_camerarx_field {
728148baabSPratyush Yadav F_CTRLCLKEN,
738148baabSPratyush Yadav F_CAMMODE,
748148baabSPratyush Yadav F_LANEENABLE,
758148baabSPratyush Yadav F_CSI_MODE,
768148baabSPratyush Yadav F_MAX_FIELDS,
778148baabSPratyush Yadav };
788148baabSPratyush Yadav
798148baabSPratyush Yadav enum cal_dma_state {
808148baabSPratyush Yadav CAL_DMA_RUNNING,
818148baabSPratyush Yadav CAL_DMA_STOP_REQUESTED,
828148baabSPratyush Yadav CAL_DMA_STOP_PENDING,
838148baabSPratyush Yadav CAL_DMA_STOPPED,
848148baabSPratyush Yadav };
858148baabSPratyush Yadav
868148baabSPratyush Yadav struct cal_format_info {
878148baabSPratyush Yadav u32 fourcc;
888148baabSPratyush Yadav u32 code;
898148baabSPratyush Yadav /* Bits per pixel */
908148baabSPratyush Yadav u8 bpp;
918148baabSPratyush Yadav bool meta;
928148baabSPratyush Yadav };
938148baabSPratyush Yadav
948148baabSPratyush Yadav /* buffer for one video frame */
958148baabSPratyush Yadav struct cal_buffer {
968148baabSPratyush Yadav /* common v4l buffer stuff -- must be first */
978148baabSPratyush Yadav struct vb2_v4l2_buffer vb;
988148baabSPratyush Yadav struct list_head list;
998148baabSPratyush Yadav };
1008148baabSPratyush Yadav
1018148baabSPratyush Yadav /**
1028148baabSPratyush Yadav * struct cal_dmaqueue - Queue of DMA buffers
1038148baabSPratyush Yadav */
1048148baabSPratyush Yadav struct cal_dmaqueue {
1058148baabSPratyush Yadav /**
1068148baabSPratyush Yadav * @lock: Protects all fields in the cal_dmaqueue.
1078148baabSPratyush Yadav */
1088148baabSPratyush Yadav spinlock_t lock;
1098148baabSPratyush Yadav
1108148baabSPratyush Yadav /**
1118148baabSPratyush Yadav * @queue: Buffers queued to the driver and waiting for DMA processing.
1128148baabSPratyush Yadav * Buffers are added to the list by the vb2 .buffer_queue() operation,
1138148baabSPratyush Yadav * and move to @pending when they are scheduled for the next frame.
1148148baabSPratyush Yadav */
1158148baabSPratyush Yadav struct list_head queue;
1168148baabSPratyush Yadav /**
1178148baabSPratyush Yadav * @pending: Buffer provided to the hardware to DMA the next frame.
1188148baabSPratyush Yadav * Will move to @active at the end of the current frame.
1198148baabSPratyush Yadav */
1208148baabSPratyush Yadav struct cal_buffer *pending;
1218148baabSPratyush Yadav /**
1228148baabSPratyush Yadav * @active: Buffer being DMA'ed to for the current frame. Will be
1238148baabSPratyush Yadav * retired and given back to vb2 at the end of the current frame if
1248148baabSPratyush Yadav * a @pending buffer has been scheduled to replace it.
1258148baabSPratyush Yadav */
1268148baabSPratyush Yadav struct cal_buffer *active;
1278148baabSPratyush Yadav
1288148baabSPratyush Yadav /** @state: State of the DMA engine. */
1298148baabSPratyush Yadav enum cal_dma_state state;
1308148baabSPratyush Yadav /** @wait: Wait queue to signal a @state transition to CAL_DMA_STOPPED. */
1318148baabSPratyush Yadav struct wait_queue_head wait;
1328148baabSPratyush Yadav };
1338148baabSPratyush Yadav
1348148baabSPratyush Yadav struct cal_camerarx_data {
1358148baabSPratyush Yadav struct {
1368148baabSPratyush Yadav unsigned int lsb;
1378148baabSPratyush Yadav unsigned int msb;
1388148baabSPratyush Yadav } fields[F_MAX_FIELDS];
1398148baabSPratyush Yadav unsigned int num_lanes;
1408148baabSPratyush Yadav };
1418148baabSPratyush Yadav
1428148baabSPratyush Yadav struct cal_data {
1438148baabSPratyush Yadav const struct cal_camerarx_data *camerarx;
1448148baabSPratyush Yadav unsigned int num_csi2_phy;
1458148baabSPratyush Yadav unsigned int flags;
1468148baabSPratyush Yadav };
1478148baabSPratyush Yadav
1488148baabSPratyush Yadav /*
1498148baabSPratyush Yadav * The Camera Adaptation Layer (CAL) module is paired with one or more complex
1508148baabSPratyush Yadav * I/O PHYs (CAMERARX). It contains multiple instances of CSI-2, processing and
1518148baabSPratyush Yadav * DMA contexts.
1528148baabSPratyush Yadav *
1538148baabSPratyush Yadav * The cal_dev structure represents the whole subsystem, including the CAL and
1548148baabSPratyush Yadav * the CAMERARX instances. Instances of struct cal_dev are named cal through the
1558148baabSPratyush Yadav * driver.
1568148baabSPratyush Yadav *
1578148baabSPratyush Yadav * The cal_camerarx structure represents one CAMERARX instance. Instances of
1588148baabSPratyush Yadav * cal_camerarx are named phy through the driver.
1598148baabSPratyush Yadav *
1608148baabSPratyush Yadav * The cal_ctx structure represents the combination of one CSI-2 context, one
1618148baabSPratyush Yadav * processing context and one DMA context. Instance of struct cal_ctx are named
1628148baabSPratyush Yadav * ctx through the driver.
1638148baabSPratyush Yadav */
1648148baabSPratyush Yadav
1658148baabSPratyush Yadav struct cal_camerarx {
1668148baabSPratyush Yadav void __iomem *base;
1678148baabSPratyush Yadav struct resource *res;
1688148baabSPratyush Yadav struct regmap_field *fields[F_MAX_FIELDS];
1698148baabSPratyush Yadav
1708148baabSPratyush Yadav struct cal_dev *cal;
1718148baabSPratyush Yadav unsigned int instance;
1728148baabSPratyush Yadav
1738148baabSPratyush Yadav struct v4l2_fwnode_endpoint endpoint;
1748148baabSPratyush Yadav struct device_node *source_ep_node;
1758148baabSPratyush Yadav struct device_node *source_node;
1768148baabSPratyush Yadav struct v4l2_subdev *source;
1778148baabSPratyush Yadav
1788148baabSPratyush Yadav struct v4l2_subdev subdev;
1798148baabSPratyush Yadav struct media_pad pads[CAL_CAMERARX_NUM_PADS];
1808148baabSPratyush Yadav
181*ebdb28a5STomi Valkeinen /* protects the vc_* fields below */
182*ebdb28a5STomi Valkeinen spinlock_t vc_lock;
183*ebdb28a5STomi Valkeinen u8 vc_enable_count[4];
184*ebdb28a5STomi Valkeinen u16 vc_frame_number[4];
185*ebdb28a5STomi Valkeinen u32 vc_sequence[4];
186*ebdb28a5STomi Valkeinen
1878148baabSPratyush Yadav unsigned int enable_count;
1888148baabSPratyush Yadav };
1898148baabSPratyush Yadav
1908148baabSPratyush Yadav struct cal_dev {
1918148baabSPratyush Yadav struct clk *fclk;
1928148baabSPratyush Yadav int irq;
1938148baabSPratyush Yadav void __iomem *base;
1948148baabSPratyush Yadav struct resource *res;
1958148baabSPratyush Yadav struct device *dev;
1968148baabSPratyush Yadav
1978148baabSPratyush Yadav const struct cal_data *data;
1988148baabSPratyush Yadav u32 revision;
1998148baabSPratyush Yadav
2008148baabSPratyush Yadav /* Control Module handle */
2018148baabSPratyush Yadav struct regmap *syscon_camerrx;
2028148baabSPratyush Yadav u32 syscon_camerrx_offset;
2038148baabSPratyush Yadav
2048148baabSPratyush Yadav /* Camera Core Module handle */
2058148baabSPratyush Yadav struct cal_camerarx *phy[CAL_NUM_CSI2_PORTS];
2068148baabSPratyush Yadav
2078148baabSPratyush Yadav u32 num_contexts;
2088148baabSPratyush Yadav struct cal_ctx *ctx[CAL_MAX_NUM_CONTEXT];
2098148baabSPratyush Yadav
2108148baabSPratyush Yadav struct media_device mdev;
2118148baabSPratyush Yadav struct v4l2_device v4l2_dev;
2128148baabSPratyush Yadav struct v4l2_async_notifier notifier;
2138148baabSPratyush Yadav
2148148baabSPratyush Yadav unsigned long reserved_pix_proc_mask;
2158148baabSPratyush Yadav };
2168148baabSPratyush Yadav
2178148baabSPratyush Yadav /*
2188148baabSPratyush Yadav * There is one cal_ctx structure for each camera core context.
2198148baabSPratyush Yadav */
2208148baabSPratyush Yadav struct cal_ctx {
2218148baabSPratyush Yadav struct v4l2_ctrl_handler ctrl_handler;
2228148baabSPratyush Yadav struct video_device vdev;
2238148baabSPratyush Yadav struct media_pad pad;
2248148baabSPratyush Yadav
2258148baabSPratyush Yadav struct cal_dev *cal;
2268148baabSPratyush Yadav struct cal_camerarx *phy;
2278148baabSPratyush Yadav
2288148baabSPratyush Yadav /* v4l2_ioctl mutex */
2298148baabSPratyush Yadav struct mutex mutex;
2308148baabSPratyush Yadav
2318148baabSPratyush Yadav struct cal_dmaqueue dma;
2328148baabSPratyush Yadav
2338148baabSPratyush Yadav /* video capture */
2348148baabSPratyush Yadav const struct cal_format_info *fmtinfo;
2358148baabSPratyush Yadav /* Used to store current pixel format */
2368148baabSPratyush Yadav struct v4l2_format v_fmt;
2378148baabSPratyush Yadav
2388148baabSPratyush Yadav /* Current subdev enumerated format (legacy) */
2398148baabSPratyush Yadav const struct cal_format_info **active_fmt;
2408148baabSPratyush Yadav unsigned int num_active_fmt;
2418148baabSPratyush Yadav
2428148baabSPratyush Yadav struct vb2_queue vb_vidq;
2438148baabSPratyush Yadav u8 dma_ctx;
2448148baabSPratyush Yadav u8 cport;
2458148baabSPratyush Yadav u8 csi2_ctx;
2468148baabSPratyush Yadav u8 pix_proc;
2478148baabSPratyush Yadav u8 vc;
2488148baabSPratyush Yadav u8 datatype;
2498148baabSPratyush Yadav
2508148baabSPratyush Yadav bool use_pix_proc;
2518148baabSPratyush Yadav };
2528148baabSPratyush Yadav
2538148baabSPratyush Yadav extern unsigned int cal_debug;
2548148baabSPratyush Yadav extern int cal_video_nr;
2558148baabSPratyush Yadav extern bool cal_mc_api;
2568148baabSPratyush Yadav
2578148baabSPratyush Yadav #define cal_dbg(level, cal, fmt, arg...) \
2588148baabSPratyush Yadav do { \
2598148baabSPratyush Yadav if (cal_debug >= (level)) \
2608148baabSPratyush Yadav dev_printk(KERN_DEBUG, (cal)->dev, fmt, ##arg); \
2618148baabSPratyush Yadav } while (0)
2628148baabSPratyush Yadav #define cal_info(cal, fmt, arg...) \
2638148baabSPratyush Yadav dev_info((cal)->dev, fmt, ##arg)
2648148baabSPratyush Yadav #define cal_err(cal, fmt, arg...) \
2658148baabSPratyush Yadav dev_err((cal)->dev, fmt, ##arg)
2668148baabSPratyush Yadav
2678148baabSPratyush Yadav #define ctx_dbg(level, ctx, fmt, arg...) \
2688148baabSPratyush Yadav cal_dbg(level, (ctx)->cal, "ctx%u: " fmt, (ctx)->dma_ctx, ##arg)
2698148baabSPratyush Yadav #define ctx_info(ctx, fmt, arg...) \
2708148baabSPratyush Yadav cal_info((ctx)->cal, "ctx%u: " fmt, (ctx)->dma_ctx, ##arg)
2718148baabSPratyush Yadav #define ctx_err(ctx, fmt, arg...) \
2728148baabSPratyush Yadav cal_err((ctx)->cal, "ctx%u: " fmt, (ctx)->dma_ctx, ##arg)
2738148baabSPratyush Yadav
2748148baabSPratyush Yadav #define phy_dbg(level, phy, fmt, arg...) \
2758148baabSPratyush Yadav cal_dbg(level, (phy)->cal, "phy%u: " fmt, (phy)->instance, ##arg)
2768148baabSPratyush Yadav #define phy_info(phy, fmt, arg...) \
2778148baabSPratyush Yadav cal_info((phy)->cal, "phy%u: " fmt, (phy)->instance, ##arg)
2788148baabSPratyush Yadav #define phy_err(phy, fmt, arg...) \
2798148baabSPratyush Yadav cal_err((phy)->cal, "phy%u: " fmt, (phy)->instance, ##arg)
2808148baabSPratyush Yadav
cal_read(struct cal_dev * cal,u32 offset)2818148baabSPratyush Yadav static inline u32 cal_read(struct cal_dev *cal, u32 offset)
2828148baabSPratyush Yadav {
2838148baabSPratyush Yadav return ioread32(cal->base + offset);
2848148baabSPratyush Yadav }
2858148baabSPratyush Yadav
cal_write(struct cal_dev * cal,u32 offset,u32 val)2868148baabSPratyush Yadav static inline void cal_write(struct cal_dev *cal, u32 offset, u32 val)
2878148baabSPratyush Yadav {
2888148baabSPratyush Yadav iowrite32(val, cal->base + offset);
2898148baabSPratyush Yadav }
2908148baabSPratyush Yadav
cal_read_field(struct cal_dev * cal,u32 offset,u32 mask)2918148baabSPratyush Yadav static __always_inline u32 cal_read_field(struct cal_dev *cal, u32 offset, u32 mask)
2928148baabSPratyush Yadav {
2938148baabSPratyush Yadav return FIELD_GET(mask, cal_read(cal, offset));
2948148baabSPratyush Yadav }
2958148baabSPratyush Yadav
cal_write_field(struct cal_dev * cal,u32 offset,u32 value,u32 mask)2968148baabSPratyush Yadav static inline void cal_write_field(struct cal_dev *cal, u32 offset, u32 value,
2978148baabSPratyush Yadav u32 mask)
2988148baabSPratyush Yadav {
2998148baabSPratyush Yadav u32 val = cal_read(cal, offset);
3008148baabSPratyush Yadav
3018148baabSPratyush Yadav val &= ~mask;
3028148baabSPratyush Yadav val |= (value << __ffs(mask)) & mask;
3038148baabSPratyush Yadav cal_write(cal, offset, val);
3048148baabSPratyush Yadav }
3058148baabSPratyush Yadav
cal_set_field(u32 * valp,u32 field,u32 mask)3068148baabSPratyush Yadav static inline void cal_set_field(u32 *valp, u32 field, u32 mask)
3078148baabSPratyush Yadav {
3088148baabSPratyush Yadav u32 val = *valp;
3098148baabSPratyush Yadav
3108148baabSPratyush Yadav val &= ~mask;
3118148baabSPratyush Yadav val |= (field << __ffs(mask)) & mask;
3128148baabSPratyush Yadav *valp = val;
3138148baabSPratyush Yadav }
3148148baabSPratyush Yadav
3158148baabSPratyush Yadav extern const struct cal_format_info cal_formats[];
3168148baabSPratyush Yadav extern const unsigned int cal_num_formats;
3178148baabSPratyush Yadav const struct cal_format_info *cal_format_by_fourcc(u32 fourcc);
3188148baabSPratyush Yadav const struct cal_format_info *cal_format_by_code(u32 code);
3198148baabSPratyush Yadav
3208148baabSPratyush Yadav void cal_quickdump_regs(struct cal_dev *cal);
3218148baabSPratyush Yadav
3228148baabSPratyush Yadav void cal_camerarx_disable(struct cal_camerarx *phy);
3238148baabSPratyush Yadav void cal_camerarx_i913_errata(struct cal_camerarx *phy);
3248148baabSPratyush Yadav struct cal_camerarx *cal_camerarx_create(struct cal_dev *cal,
3258148baabSPratyush Yadav unsigned int instance);
3268148baabSPratyush Yadav void cal_camerarx_destroy(struct cal_camerarx *phy);
3278148baabSPratyush Yadav
3288148baabSPratyush Yadav int cal_ctx_prepare(struct cal_ctx *ctx);
3298148baabSPratyush Yadav void cal_ctx_unprepare(struct cal_ctx *ctx);
3308148baabSPratyush Yadav void cal_ctx_set_dma_addr(struct cal_ctx *ctx, dma_addr_t addr);
3318148baabSPratyush Yadav void cal_ctx_start(struct cal_ctx *ctx);
3328148baabSPratyush Yadav void cal_ctx_stop(struct cal_ctx *ctx);
3338148baabSPratyush Yadav
3348148baabSPratyush Yadav int cal_ctx_v4l2_register(struct cal_ctx *ctx);
3358148baabSPratyush Yadav void cal_ctx_v4l2_unregister(struct cal_ctx *ctx);
3368148baabSPratyush Yadav int cal_ctx_v4l2_init(struct cal_ctx *ctx);
3378148baabSPratyush Yadav void cal_ctx_v4l2_cleanup(struct cal_ctx *ctx);
3388148baabSPratyush Yadav
3398148baabSPratyush Yadav #endif /* __TI_CAL_H__ */
340