drivers/media/platform/s5p-jpeg/jpeg-core.h

   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 /* JPEG compression quality setting */
  24 #define S5P_JPEG_COMPR_QUAL_BEST        0
  25 #define S5P_JPEG_COMPR_QUAL_WORST       3
  26
  27 /* JPEG RGB to YCbCr conversion matrix coefficients */
  28 #define S5P_JPEG_COEF11                 0x4d
  29 #define S5P_JPEG_COEF12                 0x97
  30 #define S5P_JPEG_COEF13                 0x1e
  31 #define S5P_JPEG_COEF21                 0x2c
  32 #define S5P_JPEG_COEF22                 0x57
  33 #define S5P_JPEG_COEF23                 0x83
  34 #define S5P_JPEG_COEF31                 0x83
  35 #define S5P_JPEG_COEF32                 0x6e
  36 #define S5P_JPEG_COEF33                 0x13
  37
  38 /* a selection of JPEG markers */
  39 #define TEM                             0x01
  40 #define SOF0                            0xc0
  41 #define RST                             0xd0
  42 #define SOI                             0xd8
  43 #define EOI                             0xd9
  44 #define DHP                             0xde
  45
  46 /* Flags that indicate a format can be used for capture/output */
  47 #define SJPEG_FMT_FLAG_ENC_CAPTURE      (1 << 0)
  48 #define SJPEG_FMT_FLAG_ENC_OUTPUT       (1 << 1)
  49 #define SJPEG_FMT_FLAG_DEC_CAPTURE      (1 << 2)
  50 #define SJPEG_FMT_FLAG_DEC_OUTPUT       (1 << 3)
  51 #define SJPEG_FMT_FLAG_S5P              (1 << 4)
  52 #define SJPEG_FMT_FLAG_EXYNOS4          (1 << 5)
  53 #define SJPEG_FMT_RGB                   (1 << 6)
  54 #define SJPEG_FMT_NON_RGB               (1 << 7)
  55
  56 #define S5P_JPEG_ENCODE         0
  57 #define S5P_JPEG_DECODE         1
  58
  59 #define FMT_TYPE_OUTPUT         0
  60 #define FMT_TYPE_CAPTURE        1
  61
  62 #define SJPEG_SUBSAMPLING_444   0x11
  63 #define SJPEG_SUBSAMPLING_422   0x21
  64 #define SJPEG_SUBSAMPLING_420   0x22
  65
  66 /* Version numbers */
  67
  68 #define SJPEG_S5P       1
  69 #define SJPEG_EXYNOS4   2
  70
  71 enum exynos4_jpeg_result {
  72         OK_ENC_OR_DEC,
  73         ERR_PROT,
  74         ERR_DEC_INVALID_FORMAT,
  75         ERR_MULTI_SCAN,
  76         ERR_FRAME,
  77         ERR_UNKNOWN,
  78 };
  79
  80 enum  exynos4_jpeg_img_quality_level {
  81         QUALITY_LEVEL_1 = 0,    /* high */
  82         QUALITY_LEVEL_2,
  83         QUALITY_LEVEL_3,
  84         QUALITY_LEVEL_4,        /* low */
  85 };
  86
  87 /**
  88  * struct s5p_jpeg - JPEG IP abstraction
  89  * @lock:               the mutex protecting this structure
  90  * @slock:              spinlock protecting the device contexts
  91  * @v4l2_dev:           v4l2 device for mem2mem mode
  92  * @vfd_encoder:        video device node for encoder mem2mem mode
  93  * @vfd_decoder:        video device node for decoder mem2mem mode
  94  * @m2m_dev:            v4l2 mem2mem device data
  95  * @regs:               JPEG IP registers mapping
  96  * @irq:                JPEG IP irq
  97  * @clk:                JPEG IP clock
  98  * @dev:                JPEG IP struct device
  99  * @alloc_ctx:          videobuf2 memory allocator's context
 100  */
 101 struct s5p_jpeg {
 102         struct mutex            lock;
 103         spinlock_t              slock;
 104
 105         struct v4l2_device      v4l2_dev;
 106         struct video_device     *vfd_encoder;
 107         struct video_device     *vfd_decoder;
 108         struct v4l2_m2m_dev     *m2m_dev;
 109
 110         void __iomem            *regs;
 111         unsigned int            irq;
 112         enum exynos4_jpeg_result irq_ret;
 113         struct clk              *clk;
 114         struct device           *dev;
 115         void                    *alloc_ctx;
 116         struct s5p_jpeg_variant *variant;
 117 };
 118
 119 struct s5p_jpeg_variant {
 120         unsigned int    version;
 121         irqreturn_t     (*jpeg_irq)(int irq, void *priv);
 122 };
 123
 124 /**
 125  * struct jpeg_fmt - driver's internal color format data
 126  * @name:       format descritpion
 127  * @fourcc:     the fourcc code, 0 if not applicable
 128  * @depth:      number of bits per pixel
 129  * @colplanes:  number of color planes (1 for packed formats)
 130  * @h_align:    horizontal alignment order (align to 2^h_align)
 131  * @v_align:    vertical alignment order (align to 2^v_align)
 132  * @flags:      flags describing format applicability
 133  */
 134 struct s5p_jpeg_fmt {
 135         char    *name;
 136         u32     fourcc;
 137         int     depth;
 138         int     colplanes;
 139         int     memplanes;
 140         int     h_align;
 141         int     v_align;
 142         int     subsampling;
 143         u32     flags;
 144 };
 145
 146 /**
 147  * s5p_jpeg_q_data - parameters of one queue
 148  * @fmt:        driver-specific format of this queue
 149  * @w:          image width
 150  * @h:          image height
 151  * @size:       image buffer size in bytes
 152  */
 153 struct s5p_jpeg_q_data {
 154         struct s5p_jpeg_fmt     *fmt;
 155         u32                     w;
 156         u32                     h;
 157         u32                     size;
 158 };
 159
 160 /**
 161  * s5p_jpeg_ctx - the device context data
 162  * @jpeg:               JPEG IP device for this context
 163  * @mode:               compression (encode) operation or decompression (decode)
 164  * @compr_quality:      destination image quality in compression (encode) mode
 165  * @out_q:              source (output) queue information
 166  * @cap_fmt:            destination (capture) queue queue information
 167  * @hdr_parsed:         set if header has been parsed during decompression
 168  * @ctrl_handler:       controls handler
 169  */
 170 struct s5p_jpeg_ctx {
 171         struct s5p_jpeg         *jpeg;
 172         unsigned int            mode;
 173         unsigned short          compr_quality;
 174         unsigned short          restart_interval;
 175         unsigned short          subsampling;
 176         struct s5p_jpeg_q_data  out_q;
 177         struct s5p_jpeg_q_data  cap_q;
 178         struct v4l2_fh          fh;
 179         bool                    hdr_parsed;
 180         struct v4l2_ctrl_handler ctrl_handler;
 181 };
 182
 183 /**
 184  * s5p_jpeg_buffer - description of memory containing input JPEG data
 185  * @size:       buffer size
 186  * @curr:       current position in the buffer
 187  * @data:       pointer to the data
 188  */
 189 struct s5p_jpeg_buffer {
 190         unsigned long size;
 191         unsigned long curr;
 192         unsigned long data;
 193 };
 194
 195 /**
 196  * struct s5p_jpeg_addr - JPEG converter physical address set for DMA
 197  * @y:   luminance plane physical address
 198  * @cb:  Cb plane physical address
 199  * @cr:  Cr plane physical address
 200  */
 201 struct s5p_jpeg_addr {
 202         u32     y;
 203         u32     cb;
 204         u32     cr;
 205 };
 206
 207 #endif /* JPEG_CORE_H */