/* SPDX-License-Identifier: GPL-2.0-only */ /* * Copyright (C) 2010 - 2012 Samsung Electronics Co., Ltd. */ #ifndef FIMC_CORE_H_ #define FIMC_CORE_H_ /*#define DEBUG*/ #include <linux/platform_device.h> #include <linux/regmap.h> #include <linux/sched.h> #include <linux/spinlock.h> #include <linux/mfd/syscon.h> #include <linux/types.h> #include <linux/videodev2.h> #include <linux/io.h> #include <linux/sizes.h> #include <media/media-entity.h> #include <media/videobuf2-v4l2.h> #include <media/v4l2-ctrls.h> #include <media/v4l2-device.h> #include <media/v4l2-mem2mem.h> #include <media/v4l2-mediabus.h> #include <media/drv-intf/exynos-fimc.h> #define dbg(fmt, args...) … /* Time to wait for next frame VSYNC interrupt while stopping operation. */ #define FIMC_SHUTDOWN_TIMEOUT … #define MAX_FIMC_CLOCKS … #define FIMC_DRIVER_NAME … #define FIMC_MAX_DEVS … #define FIMC_MAX_OUT_BUFS … #define SCALER_MAX_HRATIO … #define SCALER_MAX_VRATIO … #define DMA_MIN_SIZE … #define FIMC_CAMIF_MAX_HEIGHT … #define FIMC_MAX_JPEG_BUF_SIZE … #define FIMC_MAX_PLANES … #define FIMC_PIX_LIMITS_MAX … #define FIMC_DEF_MIN_SIZE … #define FIMC_DEF_HEIGHT_ALIGN … #define FIMC_DEF_HOR_OFFS_ALIGN … #define FIMC_DEFAULT_WIDTH … #define FIMC_DEFAULT_HEIGHT … /* indices to the clocks array */ enum { … }; enum fimc_dev_flags { … }; #define fimc_m2m_active(dev) … #define fimc_m2m_pending(dev) … #define fimc_capture_running(dev) … #define fimc_capture_pending(dev) … #define fimc_capture_busy(dev) … enum fimc_datapath { … }; enum fimc_color_fmt { … }; #define fimc_fmt_is_user_defined(x) … #define fimc_fmt_is_rgb(x) … #define IS_M2M(__strt) … /* The hardware context state. */ #define FIMC_PARAMS … #define FIMC_COMPOSE … #define FIMC_CTX_M2M … #define FIMC_CTX_CAP … #define FIMC_CTX_SHUT … /* Image conversion flags */ #define FIMC_IN_DMA_ACCESS_TILED … #define FIMC_IN_DMA_ACCESS_LINEAR … #define FIMC_OUT_DMA_ACCESS_TILED … #define FIMC_OUT_DMA_ACCESS_LINEAR … #define FIMC_SCAN_MODE_PROGRESSIVE … #define FIMC_SCAN_MODE_INTERLACED … /* * YCbCr data dynamic range for RGB-YUV color conversion. * Y/Cb/Cr: (0 ~ 255) */ #define FIMC_COLOR_RANGE_WIDE … /* Y (16 ~ 235), Cb/Cr (16 ~ 240) */ #define FIMC_COLOR_RANGE_NARROW … /** * struct fimc_dma_offset - pixel offset information for DMA * @y_h: y value horizontal offset * @y_v: y value vertical offset * @cb_h: cb value horizontal offset * @cb_v: cb value vertical offset * @cr_h: cr value horizontal offset * @cr_v: cr value vertical offset */ struct fimc_dma_offset { … }; /** * struct fimc_effect - color effect information * @type: effect type * @pat_cb: cr value when type is "arbitrary" * @pat_cr: cr value when type is "arbitrary" */ struct fimc_effect { … }; /** * struct fimc_scaler - the configuration data for FIMC inetrnal scaler * @scaleup_h: flag indicating scaling up horizontally * @scaleup_v: flag indicating scaling up vertically * @copy_mode: flag indicating transparent DMA transfer (no scaling * and color format conversion) * @enabled: flag indicating if the scaler is used * @hfactor: horizontal shift factor * @vfactor: vertical shift factor * @pre_hratio: horizontal ratio of the prescaler * @pre_vratio: vertical ratio of the prescaler * @pre_dst_width: the prescaler's destination width * @pre_dst_height: the prescaler's destination height * @main_hratio: the main scaler's horizontal ratio * @main_vratio: the main scaler's vertical ratio * @real_width: source pixel (width - offset) * @real_height: source pixel (height - offset) */ struct fimc_scaler { … }; /** * struct fimc_addr - the FIMC address set for DMA * @y: luminance plane address * @cb: Cb plane address * @cr: Cr plane address */ struct fimc_addr { … }; /** * struct fimc_vid_buffer - the driver's video buffer * @vb: v4l vb2 buffer * @list: linked list structure for buffer queue * @addr: precalculated DMA address set * @index: buffer index for the output DMA engine */ struct fimc_vid_buffer { … }; /** * struct fimc_frame - source/target frame properties * @f_width: image full width (virtual screen size) * @f_height: image full height (virtual screen size) * @o_width: original image width as set by S_FMT * @o_height: original image height as set by S_FMT * @offs_h: image horizontal pixel offset * @offs_v: image vertical pixel offset * @width: image pixel width * @height: image pixel weight * @payload: image size in bytes (w x h x bpp) * @bytesperline: bytesperline value for each plane * @addr: image frame buffer DMA addresses * @dma_offset: DMA offset in bytes * @fmt: fimc color format pointer * @alpha: alpha value */ struct fimc_frame { … }; /** * struct fimc_m2m_device - v4l2 memory-to-memory device data * @vfd: the video device node for v4l2 m2m mode * @m2m_dev: v4l2 memory-to-memory device data * @ctx: hardware context data * @refcnt: the reference counter */ struct fimc_m2m_device { … }; #define FIMC_SD_PAD_SINK_CAM … #define FIMC_SD_PAD_SINK_FIFO … #define FIMC_SD_PAD_SOURCE … #define FIMC_SD_PADS_NUM … /** * struct fimc_vid_cap - camera capture device information * @ctx: hardware context data * @subdev: subdev exposing the FIMC processing block * @ve: exynos video device entity structure * @vd_pad: fimc video capture node pad * @sd_pads: fimc video processing block pads * @ci_fmt: image format at the FIMC camera input (and the scaler output) * @wb_fmt: image format at the FIMC ISP Writeback input * @source_config: external image source related configuration structure * @pending_buf_q: the pending buffer queue head * @active_buf_q: the queue head of buffers scheduled in hardware * @vbq: the capture am video buffer queue * @active_buf_cnt: number of video buffers scheduled in hardware * @buf_index: index for managing the output DMA buffers * @frame_count: the frame counter for statistics * @reqbufs_count: the number of buffers requested in REQBUFS ioctl * @streaming: is streaming in progress? * @input: capture input type, grp_id of the attached subdev * @user_subdev_api: true if subdevs are not configured by the host driver */ struct fimc_vid_cap { … }; /** * struct fimc_pix_limit - image pixel size limits in various IP configurations * * @scaler_en_w: max input pixel width when the scaler is enabled * @scaler_dis_w: max input pixel width when the scaler is disabled * @in_rot_en_h: max input width with the input rotator is on * @in_rot_dis_w: max input width with the input rotator is off * @out_rot_en_w: max output width with the output rotator on * @out_rot_dis_w: max output width with the output rotator off */ struct fimc_pix_limit { … }; /** * struct fimc_variant - FIMC device variant information * @has_inp_rot: set if has input rotator * @has_out_rot: set if has output rotator * @has_mainscaler_ext: 1 if extended mainscaler ratios in CIEXTEN register * are present in this IP revision * @has_cam_if: set if this instance has a camera input interface * @has_isp_wb: set if this instance has ISP writeback input * @pix_limit: pixel size constraints for the scaler * @min_inp_pixsize: minimum input pixel size * @min_out_pixsize: minimum output pixel size * @hor_offs_align: horizontal pixel offset alignment * @min_vsize_align: minimum vertical pixel size alignment */ struct fimc_variant { … }; /** * struct fimc_drvdata - per device type driver data * @variant: variant information for this device * @num_entities: number of fimc instances available in a SoC * @lclk_frequency: local bus clock frequency * @cistatus2: 1 if the FIMC IPs have CISTATUS2 register * @dma_pix_hoff: the horizontal DMA offset unit: 1 - pixels, 0 - bytes * @alpha_color: 1 if alpha color component is supported * @out_buf_count: maximum number of output DMA buffers supported */ struct fimc_drvdata { … }; #define fimc_get_drvdata(_pdev) … struct fimc_ctx; /** * struct fimc_dev - abstraction for FIMC entity * @slock: the spinlock protecting this data structure * @lock: the mutex protecting this data structure * @pdev: pointer to the FIMC platform device * @pdata: pointer to the device platform data * @sysreg: pointer to the SYSREG regmap * @variant: the IP variant information * @drv_data: driver data * @id: FIMC device index (0..FIMC_MAX_DEVS) * @clock: clocks required for FIMC operation * @regs: the mapped hardware registers * @irq_queue: interrupt handler waitqueue * @v4l2_dev: root v4l2_device * @m2m: memory-to-memory V4L2 device information * @vid_cap: camera capture device information * @state: flags used to synchronize m2m and capture mode operation */ struct fimc_dev { … }; /** * struct fimc_ctrls - v4l2 controls structure * @handler: the control handler * @colorfx: image effect control * @colorfx_cbcr: Cb/Cr coefficients control * @rotate: image rotation control * @hflip: horizontal flip control * @vflip: vertical flip control * @alpha: RGB alpha control * @ready: true if @handler is initialized */ struct fimc_ctrls { … }; /** * struct fimc_ctx - the device context data * @s_frame: source frame properties * @d_frame: destination frame properties * @out_order_1p: output 1-plane YCBCR order * @out_order_2p: output 2-plane YCBCR order * @in_order_1p: input 1-plane YCBCR order * @in_order_2p: input 2-plane YCBCR order * @in_path: input mode (DMA or camera) * @out_path: output mode (DMA or FIFO) * @scaler: image scaler properties * @effect: image effect * @rotation: image clockwise rotation in degrees * @hflip: indicates image horizontal flip if set * @vflip: indicates image vertical flip if set * @flags: additional flags for image conversion * @state: flags to keep track of user configuration * @fimc_dev: the FIMC device this context applies to * @fh: v4l2 file handle * @ctrls: v4l2 controls structure */ struct fimc_ctx { … }; #define fh_to_ctx(__fh) … static inline void set_frame_bounds(struct fimc_frame *f, u32 width, u32 height) { … } static inline void set_frame_crop(struct fimc_frame *f, u32 left, u32 top, u32 width, u32 height) { … } static inline u32 fimc_get_format_depth(const struct fimc_fmt *ff) { … } static inline bool fimc_capture_active(struct fimc_dev *fimc) { … } static inline void fimc_ctx_state_set(u32 state, struct fimc_ctx *ctx) { … } static inline bool fimc_ctx_state_is_set(u32 mask, struct fimc_ctx *ctx) { … } static inline int tiled_fmt(const struct fimc_fmt *fmt) { … } static inline bool fimc_jpeg_fourcc(u32 pixelformat) { … } static inline bool fimc_user_defined_mbus_fmt(u32 code) { … } /* Return the alpha component bit mask */ static inline int fimc_get_alpha_mask(const struct fimc_fmt *fmt) { … } static inline struct fimc_frame *ctx_get_frame(struct fimc_ctx *ctx, enum v4l2_buf_type type) { … } /* -----------------------------------------------------*/ /* fimc-core.c */ int fimc_ctrls_create(struct fimc_ctx *ctx); void fimc_ctrls_delete(struct fimc_ctx *ctx); void fimc_ctrls_activate(struct fimc_ctx *ctx, bool active); void fimc_alpha_ctrl_update(struct fimc_ctx *ctx); void __fimc_get_format(const struct fimc_frame *frame, struct v4l2_format *f); void fimc_adjust_mplane_format(const struct fimc_fmt *fmt, u32 width, u32 height, struct v4l2_pix_format_mplane *pix); const struct fimc_fmt *fimc_find_format(const u32 *pixelformat, const u32 *mbus_code, unsigned int mask, int index); const struct fimc_fmt *fimc_get_format(unsigned int index); int fimc_check_scaler_ratio(struct fimc_ctx *ctx, int sw, int sh, int dw, int dh, int rotation); int fimc_set_scaler_info(struct fimc_ctx *ctx); int fimc_prepare_config(struct fimc_ctx *ctx, u32 flags); int fimc_prepare_addr(struct fimc_ctx *ctx, struct vb2_buffer *vb, const struct fimc_frame *frame, struct fimc_addr *addr); void fimc_prepare_dma_offset(struct fimc_ctx *ctx, struct fimc_frame *f); void fimc_set_yuv_order(struct fimc_ctx *ctx); void fimc_capture_irq_handler(struct fimc_dev *fimc, int deq_buf); int fimc_register_m2m_device(struct fimc_dev *fimc, struct v4l2_device *v4l2_dev); void fimc_unregister_m2m_device(struct fimc_dev *fimc); int fimc_register_driver(void); void fimc_unregister_driver(void); #ifdef CONFIG_MFD_SYSCON static inline struct regmap * fimc_get_sysreg_regmap(struct device_node *node) { … } #else #define fimc_get_sysreg_regmap … #endif /* -----------------------------------------------------*/ /* fimc-m2m.c */ void fimc_m2m_job_finish(struct fimc_ctx *ctx, int vb_state); /* -----------------------------------------------------*/ /* fimc-capture.c */ int fimc_initialize_capture_subdev(struct fimc_dev *fimc); void fimc_unregister_capture_subdev(struct fimc_dev *fimc); int fimc_capture_ctrls_create(struct fimc_dev *fimc); void fimc_sensor_notify(struct v4l2_subdev *sd, unsigned int notification, void *arg); int fimc_capture_suspend(struct fimc_dev *fimc); int fimc_capture_resume(struct fimc_dev *fimc); /* * Buffer list manipulation functions. Must be called with fimc.slock held. */ /** * fimc_active_queue_add - add buffer to the capture active buffers queue * @vid_cap: camera capture device information * @buf: buffer to add to the active buffers list */ static inline void fimc_active_queue_add(struct fimc_vid_cap *vid_cap, struct fimc_vid_buffer *buf) { … } /** * fimc_active_queue_pop - pop buffer from the capture active buffers queue * @vid_cap: camera capture device information * * The caller must assure the active_buf_q list is not empty. */ static inline struct fimc_vid_buffer *fimc_active_queue_pop( struct fimc_vid_cap *vid_cap) { … } /** * fimc_pending_queue_add - add buffer to the capture pending buffers queue * @vid_cap: camera capture device information * @buf: buffer to add to the pending buffers list */ static inline void fimc_pending_queue_add(struct fimc_vid_cap *vid_cap, struct fimc_vid_buffer *buf) { … } /** * fimc_pending_queue_pop - pop buffer from the capture pending buffers queue * @vid_cap: camera capture device information * * The caller must assure the pending_buf_q list is not empty. */ static inline struct fimc_vid_buffer *fimc_pending_queue_pop( struct fimc_vid_cap *vid_cap) { … } #endif /* FIMC_CORE_H_ */