/* SPDX-License-Identifier: GPL-2.0-only */ /* * Copyright (c) 2011 - 2012 Samsung Electronics Co., Ltd. * http://www.samsung.com * * header file for Samsung EXYNOS5 SoC series G-Scaler driver */ #ifndef GSC_CORE_H_ #define GSC_CORE_H_ #include <linux/delay.h> #include <linux/sched.h> #include <linux/spinlock.h> #include <linux/types.h> #include <linux/videodev2.h> #include <linux/io.h> #include <linux/pm_runtime.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/videobuf2-dma-contig.h> #include "gsc-regs.h" #define GSC_MODULE_NAME … #define GSC_SHUTDOWN_TIMEOUT … #define GSC_MAX_DEVS … #define GSC_MAX_CLOCKS … #define GSC_M2M_BUF_NUM … #define GSC_MAX_CTRL_NUM … #define GSC_SC_ALIGN_4 … #define GSC_SC_ALIGN_2 … #define DEFAULT_CSC_EQ … #define DEFAULT_CSC_RANGE … #define GSC_PARAMS … #define GSC_SRC_FMT … #define GSC_DST_FMT … #define GSC_CTX_M2M … #define GSC_CTX_STOP_REQ … #define GSC_CTX_ABORT … enum gsc_dev_flags { … }; enum gsc_irq { … }; /** * enum gsc_datapath - the path of data used for G-Scaler * @GSC_CAMERA: from camera * @GSC_DMA: from/to DMA * @GSC_WRITEBACK: from FIMD */ enum gsc_datapath { … }; enum gsc_color_fmt { … }; enum gsc_yuv_fmt { … }; #define fh_to_ctx(__fh) … #define is_rgb(x) … #define is_yuv420(x) … #define is_yuv422(x) … #define gsc_m2m_active(dev) … #define gsc_m2m_pending(dev) … #define gsc_m2m_opened(dev) … #define ctrl_to_ctx(__ctrl) … /** * struct gsc_fmt - the driver's internal color format data * @mbus_code: Media Bus pixel code, -1 if not applicable * @pixelformat: the fourcc code for this format, 0 if not applicable * @color: color encoding * @yorder: Y/C order * @corder: Chrominance order control * @num_planes: number of physically non-contiguous data planes * @num_comp: number of physically contiguous data planes * @depth: per plane driver's private 'number of bits per pixel' * @flags: flags indicating which operation mode format applies to */ struct gsc_fmt { … }; /** * struct gsc_input_buf - the driver's video buffer * @vb: videobuf2 buffer * @list : linked list structure for buffer queue * @idx : index of G-Scaler input buffer */ struct gsc_input_buf { … }; /** * struct gsc_addr - the G-Scaler physical address set * @y: luminance plane address * @cb: Cb plane address * @cr: Cr plane address */ struct gsc_addr { … }; /* struct gsc_ctrls - the G-Scaler control set * @rotate: rotation degree * @hflip: horizontal flip * @vflip: vertical flip * @global_alpha: the alpha value of current frame */ struct gsc_ctrls { … }; /** * struct gsc_scaler - the configuration data for G-Scaler inetrnal scaler * @pre_shfactor: pre sclaer shift factor * @pre_hratio: horizontal ratio of the prescaler * @pre_vratio: vertical ratio of the prescaler * @main_hratio: the main scaler's horizontal ratio * @main_vratio: the main scaler's vertical ratio */ struct gsc_scaler { … }; struct gsc_dev; struct gsc_ctx; /** * struct gsc_frame - source/target frame properties * @f_width: SRC : SRCIMG_WIDTH, DST : OUTPUTDMA_WHOLE_IMG_WIDTH * @f_height: SRC : SRCIMG_HEIGHT, DST : OUTPUTDMA_WHOLE_IMG_HEIGHT * @crop: cropped(source)/scaled(destination) size * @payload: image size in bytes (w x h x bpp) * @addr: image frame buffer physical addresses * @fmt: G-Scaler color format pointer * @colorspace: value indicating v4l2_colorspace * @alpha: frame's alpha value */ struct gsc_frame { … }; /** * struct gsc_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 gsc_m2m_device { … }; /** * struct gsc_pix_max - image pixel size limits in various IP configurations * * @org_scaler_bypass_w: max pixel width when the scaler is disabled * @org_scaler_bypass_h: max pixel height when the scaler is disabled * @org_scaler_input_w: max pixel width when the scaler is enabled * @org_scaler_input_h: max pixel height when the scaler is enabled * @real_rot_dis_w: max pixel src cropped height with the rotator is off * @real_rot_dis_h: max pixel src cropped width with the rotator is off * @real_rot_en_w: max pixel src cropped width with the rotator is on * @real_rot_en_h: max pixel src cropped height with the rotator is on * @target_rot_dis_w: max pixel dst scaled width with the rotator is off * @target_rot_dis_h: max pixel dst scaled height with the rotator is off * @target_rot_en_w: max pixel dst scaled width with the rotator is on * @target_rot_en_h: max pixel dst scaled height with the rotator is on */ struct gsc_pix_max { … }; /** * struct gsc_pix_min - image pixel size limits in various IP configurations * * @org_w: minimum source pixel width * @org_h: minimum source pixel height * @real_w: minimum input crop pixel width * @real_h: minimum input crop pixel height * @target_rot_dis_w: minimum output scaled pixel height when rotator is off * @target_rot_dis_h: minimum output scaled pixel height when rotator is off * @target_rot_en_w: minimum output scaled pixel height when rotator is on * @target_rot_en_h: minimum output scaled pixel height when rotator is on */ struct gsc_pix_min { … }; struct gsc_pix_align { … }; /* * struct gsc_variant - G-Scaler variant information */ struct gsc_variant { … }; /** * struct gsc_driverdata - per device type driver data for init time. * * @variant: the variant information for this driver. * @num_entities: the number of g-scalers * @clk_names: clock names * @num_clocks: the number of clocks in @clk_names * @num_entities: the number of g-scalers */ struct gsc_driverdata { … }; /** * struct gsc_dev - abstraction for G-Scaler entity * @slock: the spinlock protecting this data structure * @lock: the mutex protecting this data structure * @pdev: pointer to the G-Scaler platform device * @variant: the IP variant information * @id: G-Scaler device index (0..GSC_MAX_DEVS) * @num_clocks: number of clocks required for G-Scaler operation * @clock: clocks required for G-Scaler operation * @regs: the mapped hardware registers * @irq_queue: interrupt handler waitqueue * @m2m: memory-to-memory V4L2 device information * @state: flags used to synchronize m2m and capture mode operation * @vdev: video device for G-Scaler instance * @v4l2_dev: v4l2_device for G-Scaler instance */ struct gsc_dev { … }; /** * struct gsc_ctx - the device context data * @s_frame: source frame properties * @d_frame: destination frame properties * @in_path: input mode (DMA or camera) * @out_path: output mode (DMA or FIFO) * @scaler: image scaler properties * @flags: additional flags for image conversion * @state: flags to keep track of user configuration * @rotation: rotation * @hflip: horizontal flip * @vflip: vertical flip * @gsc_dev: the G-Scaler device this context applies to * @m2m_ctx: memory-to-memory device context * @fh: v4l2 file handle * @ctrl_handler: v4l2 controls handler * @gsc_ctrls: G-Scaler control set * @ctrls_rdy: true if the control handler is initialized * @out_colorspace: the colorspace of the OUTPUT queue */ struct gsc_ctx { … }; void gsc_set_prefbuf(struct gsc_dev *gsc, struct gsc_frame *frm); int gsc_register_m2m_device(struct gsc_dev *gsc); void gsc_unregister_m2m_device(struct gsc_dev *gsc); void gsc_m2m_job_finish(struct gsc_ctx *ctx, int vb_state); u32 get_plane_size(struct gsc_frame *fr, unsigned int plane); const struct gsc_fmt *get_format(int index); const struct gsc_fmt *find_fmt(u32 *pixelformat, u32 *mbus_code, u32 index); int gsc_enum_fmt(struct v4l2_fmtdesc *f); int gsc_try_fmt_mplane(struct gsc_ctx *ctx, struct v4l2_format *f); void gsc_set_frame_size(struct gsc_frame *frame, int width, int height); int gsc_g_fmt_mplane(struct gsc_ctx *ctx, struct v4l2_format *f); void gsc_check_crop_change(u32 tmp_w, u32 tmp_h, u32 *w, u32 *h); int gsc_try_selection(struct gsc_ctx *ctx, struct v4l2_selection *s); int gsc_cal_prescaler_ratio(struct gsc_variant *var, u32 src, u32 dst, u32 *ratio); void gsc_get_prescaler_shfactor(u32 hratio, u32 vratio, u32 *sh); void gsc_check_src_scale_info(struct gsc_variant *var, struct gsc_frame *s_frame, u32 *wratio, u32 tx, u32 ty, u32 *hratio); int gsc_check_scaler_ratio(struct gsc_variant *var, int sw, int sh, int dw, int dh, int rot, int out_path); int gsc_set_scaler_info(struct gsc_ctx *ctx); int gsc_ctrls_create(struct gsc_ctx *ctx); void gsc_ctrls_delete(struct gsc_ctx *ctx); int gsc_prepare_addr(struct gsc_ctx *ctx, struct vb2_buffer *vb, struct gsc_frame *frame, struct gsc_addr *addr); static inline void gsc_ctx_state_lock_set(u32 state, struct gsc_ctx *ctx) { … } static inline void gsc_ctx_state_lock_clear(u32 state, struct gsc_ctx *ctx) { … } static inline int is_tiled(const struct gsc_fmt *fmt) { … } static inline void gsc_hw_enable_control(struct gsc_dev *dev, bool on) { … } static inline int gsc_hw_get_irq_status(struct gsc_dev *dev) { … } static inline void gsc_hw_clear_irq(struct gsc_dev *dev, int irq) { … } static inline bool gsc_ctx_state_is_set(u32 mask, struct gsc_ctx *ctx) { … } static inline struct gsc_frame *ctx_get_frame(struct gsc_ctx *ctx, enum v4l2_buf_type type) { … } void gsc_hw_set_sw_reset(struct gsc_dev *dev); int gsc_wait_reset(struct gsc_dev *dev); void gsc_hw_set_frm_done_irq_mask(struct gsc_dev *dev, bool mask); void gsc_hw_set_gsc_irq_enable(struct gsc_dev *dev, bool mask); void gsc_hw_set_input_buf_masking(struct gsc_dev *dev, u32 shift, bool enable); void gsc_hw_set_output_buf_masking(struct gsc_dev *dev, u32 shift, bool enable); void gsc_hw_set_input_addr(struct gsc_dev *dev, struct gsc_addr *addr, int index); void gsc_hw_set_output_addr(struct gsc_dev *dev, struct gsc_addr *addr, int index); void gsc_hw_set_input_path(struct gsc_ctx *ctx); void gsc_hw_set_in_size(struct gsc_ctx *ctx); void gsc_hw_set_in_image_rgb(struct gsc_ctx *ctx); void gsc_hw_set_in_image_format(struct gsc_ctx *ctx); void gsc_hw_set_output_path(struct gsc_ctx *ctx); void gsc_hw_set_out_size(struct gsc_ctx *ctx); void gsc_hw_set_out_image_rgb(struct gsc_ctx *ctx); void gsc_hw_set_out_image_format(struct gsc_ctx *ctx); void gsc_hw_set_prescaler(struct gsc_ctx *ctx); void gsc_hw_set_mainscaler(struct gsc_ctx *ctx); void gsc_hw_set_rotation(struct gsc_ctx *ctx); void gsc_hw_set_global_alpha(struct gsc_ctx *ctx); void gsc_hw_set_sfr_update(struct gsc_ctx *ctx); #endif /* GSC_CORE_H_ */