1 /* linux/drivers/media/platform/s5p-jpeg/jpeg-core.h 2 * 3 * Copyright (c) 2011 Samsung Electronics Co., Ltd. 4 * http://www.samsung.com 5 * 6 * Author: Andrzej Pietrasiewicz <andrzej.p@samsung.com> 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License version 2 as 10 * published by the Free Software Foundation. 11 */ 12 13 #ifndef JPEG_CORE_H_ 14 #define JPEG_CORE_H_ 15 16 #include <linux/interrupt.h> 17 #include <media/v4l2-device.h> 18 #include <media/v4l2-fh.h> 19 #include <media/v4l2-ctrls.h> 20 21 #define S5P_JPEG_M2M_NAME "s5p-jpeg" 22 23 #define JPEG_MAX_CLOCKS 4 24 25 /* JPEG compression quality setting */ 26 #define S5P_JPEG_COMPR_QUAL_BEST 0 27 #define S5P_JPEG_COMPR_QUAL_WORST 3 28 29 /* JPEG RGB to YCbCr conversion matrix coefficients */ 30 #define S5P_JPEG_COEF11 0x4d 31 #define S5P_JPEG_COEF12 0x97 32 #define S5P_JPEG_COEF13 0x1e 33 #define S5P_JPEG_COEF21 0x2c 34 #define S5P_JPEG_COEF22 0x57 35 #define S5P_JPEG_COEF23 0x83 36 #define S5P_JPEG_COEF31 0x83 37 #define S5P_JPEG_COEF32 0x6e 38 #define S5P_JPEG_COEF33 0x13 39 40 #define EXYNOS3250_IRQ_TIMEOUT 0x10000000 41 42 /* a selection of JPEG markers */ 43 #define TEM 0x01 44 #define SOF0 0xc0 45 #define DHT 0xc4 46 #define RST 0xd0 47 #define SOI 0xd8 48 #define EOI 0xd9 49 #define SOS 0xda 50 #define DQT 0xdb 51 #define DHP 0xde 52 53 /* Flags that indicate a format can be used for capture/output */ 54 #define SJPEG_FMT_FLAG_ENC_CAPTURE (1 << 0) 55 #define SJPEG_FMT_FLAG_ENC_OUTPUT (1 << 1) 56 #define SJPEG_FMT_FLAG_DEC_CAPTURE (1 << 2) 57 #define SJPEG_FMT_FLAG_DEC_OUTPUT (1 << 3) 58 #define SJPEG_FMT_FLAG_S5P (1 << 4) 59 #define SJPEG_FMT_FLAG_EXYNOS3250 (1 << 5) 60 #define SJPEG_FMT_FLAG_EXYNOS4 (1 << 6) 61 #define SJPEG_FMT_RGB (1 << 7) 62 #define SJPEG_FMT_NON_RGB (1 << 8) 63 64 #define S5P_JPEG_ENCODE 0 65 #define S5P_JPEG_DECODE 1 66 67 #define FMT_TYPE_OUTPUT 0 68 #define FMT_TYPE_CAPTURE 1 69 70 #define SJPEG_SUBSAMPLING_444 0x11 71 #define SJPEG_SUBSAMPLING_422 0x21 72 #define SJPEG_SUBSAMPLING_420 0x22 73 74 #define S5P_JPEG_MAX_MARKER 4 75 76 /* Version numbers */ 77 enum sjpeg_version { 78 SJPEG_S5P, 79 SJPEG_EXYNOS3250, 80 SJPEG_EXYNOS4, 81 SJPEG_EXYNOS5420, 82 SJPEG_EXYNOS5433, 83 }; 84 85 enum exynos4_jpeg_result { 86 OK_ENC_OR_DEC, 87 ERR_PROT, 88 ERR_DEC_INVALID_FORMAT, 89 ERR_MULTI_SCAN, 90 ERR_FRAME, 91 ERR_UNKNOWN, 92 }; 93 94 enum exynos4_jpeg_img_quality_level { 95 QUALITY_LEVEL_1 = 0, /* high */ 96 QUALITY_LEVEL_2, 97 QUALITY_LEVEL_3, 98 QUALITY_LEVEL_4, /* low */ 99 }; 100 101 /** 102 * struct s5p_jpeg - JPEG IP abstraction 103 * @lock: the mutex protecting this structure 104 * @slock: spinlock protecting the device contexts 105 * @v4l2_dev: v4l2 device for mem2mem mode 106 * @vfd_encoder: video device node for encoder mem2mem mode 107 * @vfd_decoder: video device node for decoder mem2mem mode 108 * @m2m_dev: v4l2 mem2mem device data 109 * @regs: JPEG IP registers mapping 110 * @irq: JPEG IP irq 111 * @clocks: JPEG IP clock(s) 112 * @dev: JPEG IP struct device 113 * @alloc_ctx: videobuf2 memory allocator's context 114 * @variant: driver variant to be used 115 * @irq_status interrupt flags set during single encode/decode 116 operation 117 118 */ 119 struct s5p_jpeg { 120 struct mutex lock; 121 spinlock_t slock; 122 123 struct v4l2_device v4l2_dev; 124 struct video_device *vfd_encoder; 125 struct video_device *vfd_decoder; 126 struct v4l2_m2m_dev *m2m_dev; 127 128 void __iomem *regs; 129 unsigned int irq; 130 enum exynos4_jpeg_result irq_ret; 131 struct clk *clocks[JPEG_MAX_CLOCKS]; 132 struct device *dev; 133 void *alloc_ctx; 134 struct s5p_jpeg_variant *variant; 135 u32 irq_status; 136 }; 137 138 struct s5p_jpeg_variant { 139 unsigned int version; 140 unsigned int fmt_ver_flag; 141 unsigned int hw3250_compat:1; 142 unsigned int htbl_reinit:1; 143 unsigned int hw_ex4_compat:1; 144 struct v4l2_m2m_ops *m2m_ops; 145 irqreturn_t (*jpeg_irq)(int irq, void *priv); 146 const char *clk_names[JPEG_MAX_CLOCKS]; 147 int num_clocks; 148 }; 149 150 /** 151 * struct jpeg_fmt - driver's internal color format data 152 * @name: format descritpion 153 * @fourcc: the fourcc code, 0 if not applicable 154 * @depth: number of bits per pixel 155 * @colplanes: number of color planes (1 for packed formats) 156 * @h_align: horizontal alignment order (align to 2^h_align) 157 * @v_align: vertical alignment order (align to 2^v_align) 158 * @flags: flags describing format applicability 159 */ 160 struct s5p_jpeg_fmt { 161 char *name; 162 u32 fourcc; 163 int depth; 164 int colplanes; 165 int memplanes; 166 int h_align; 167 int v_align; 168 int subsampling; 169 u32 flags; 170 }; 171 172 /** 173 * s5p_jpeg_marker - collection of markers from jpeg header 174 * @marker: markers' positions relative to the buffer beginning 175 * @len: markers' payload lengths (without length field) 176 * @n: number of markers in collection 177 */ 178 struct s5p_jpeg_marker { 179 u32 marker[S5P_JPEG_MAX_MARKER]; 180 u32 len[S5P_JPEG_MAX_MARKER]; 181 u32 n; 182 }; 183 184 /** 185 * s5p_jpeg_q_data - parameters of one queue 186 * @fmt: driver-specific format of this queue 187 * @w: image width 188 * @h: image height 189 * @sos: SOS marker's position relative to the buffer beginning 190 * @dht: DHT markers' positions relative to the buffer beginning 191 * @dqt: DQT markers' positions relative to the buffer beginning 192 * @sof: SOF0 marker's postition relative to the buffer beginning 193 * @sof_len: SOF0 marker's payload length (without length field itself) 194 * @components: number of image components 195 * @size: image buffer size in bytes 196 */ 197 struct s5p_jpeg_q_data { 198 struct s5p_jpeg_fmt *fmt; 199 u32 w; 200 u32 h; 201 u32 sos; 202 struct s5p_jpeg_marker dht; 203 struct s5p_jpeg_marker dqt; 204 u32 sof; 205 u32 sof_len; 206 u32 components; 207 u32 size; 208 }; 209 210 /** 211 * s5p_jpeg_ctx - the device context data 212 * @jpeg: JPEG IP device for this context 213 * @mode: compression (encode) operation or decompression (decode) 214 * @compr_quality: destination image quality in compression (encode) mode 215 * @restart_interval: JPEG restart interval for JPEG encoding 216 * @subsampling: subsampling of a raw format or a JPEG 217 * @out_q: source (output) queue information 218 * @cap_q: destination (capture) queue queue information 219 * @scale_factor: scale factor for JPEG decoding 220 * @crop_rect: a rectangle representing crop area of the output buffer 221 * @fh: V4L2 file handle 222 * @hdr_parsed: set if header has been parsed during decompression 223 * @crop_altered: set if crop rectangle has been altered by the user space 224 * @ctrl_handler: controls handler 225 */ 226 struct s5p_jpeg_ctx { 227 struct s5p_jpeg *jpeg; 228 unsigned int mode; 229 unsigned short compr_quality; 230 unsigned short restart_interval; 231 unsigned short subsampling; 232 struct s5p_jpeg_q_data out_q; 233 struct s5p_jpeg_q_data cap_q; 234 unsigned int scale_factor; 235 struct v4l2_rect crop_rect; 236 struct v4l2_fh fh; 237 bool hdr_parsed; 238 bool crop_altered; 239 struct v4l2_ctrl_handler ctrl_handler; 240 }; 241 242 /** 243 * s5p_jpeg_buffer - description of memory containing input JPEG data 244 * @size: buffer size 245 * @curr: current position in the buffer 246 * @data: pointer to the data 247 */ 248 struct s5p_jpeg_buffer { 249 unsigned long size; 250 unsigned long curr; 251 unsigned long data; 252 }; 253 254 /** 255 * struct s5p_jpeg_addr - JPEG converter physical address set for DMA 256 * @y: luminance plane physical address 257 * @cb: Cb plane physical address 258 * @cr: Cr plane physical address 259 */ 260 struct s5p_jpeg_addr { 261 u32 y; 262 u32 cb; 263 u32 cr; 264 }; 265 266 #endif /* JPEG_CORE_H */ 267