drivers/media/platform/xilinx/xilinx-scenechange.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Xilinx Scene Change Detection driver
   4  *
   5  * Copyright (C) 2018 Xilinx, Inc.
   6  *
   7  * Authors: Anand Ashok Dumbre <anand.ashok.dumbre@xilinx.com>
   8  *          Satish Kumar Nagireddy <satish.nagireddy.nagireddy@xilinx.com>
   9  */
  10
  11 #ifndef _XILINX_SCENECHANGE_H_
  12 #define _XILINX_SCENECHANGE_H_
  13
  14 #include <linux/bitops.h>
  15 #include <linux/dmaengine.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/io.h>
  18 #include <linux/mutex.h>
  19 #include <linux/spinlock.h>
  20
  21 #include <media/v4l2-subdev.h>
  22
  23 struct clk;
  24 struct device;
  25 struct device_node;
  26 struct gpio_desc;
  27
  28 /* Register/Descriptor Offsets */
  29 #define XSCD_CTRL_OFFSET                0x000
  30 #define XSCD_CTRL_AP_START              BIT(0)
  31 #define XSCD_CTRL_AP_DONE               BIT(1)
  32 #define XSCD_CTRL_AP_IDLE               BIT(2)
  33 #define XSCD_CTRL_AP_READY              BIT(3)
  34 #define XSCD_CTRL_AUTO_RESTART          BIT(7)
  35
  36 #define XSCD_GIE_OFFSET                 0x004
  37 #define XSCD_GIE_EN                     BIT(0)
  38
  39 #define XSCD_IE_OFFSET                  0x008
  40 #define XSCD_IE_AP_DONE                 BIT(0)
  41 #define XSCD_IE_AP_READY                BIT(1)
  42
  43 #define XSCD_ISR_OFFSET                 0x00c
  44 #define XSCD_WIDTH_OFFSET               0x010
  45 #define XSCD_HEIGHT_OFFSET              0x018
  46 #define XSCD_STRIDE_OFFSET              0x020
  47 #define XSCD_VID_FMT_OFFSET             0x028
  48 #define XSCD_VID_FMT_RGB                0
  49 #define XSCD_VID_FMT_YUV_444            1
  50 #define XSCD_VID_FMT_YUV_422            2
  51 #define XSCD_VID_FMT_YUV_420            3
  52 #define XSCD_VID_FMT_Y8                 24
  53 #define XSCD_VID_FMT_Y10                25
  54
  55 #define XSCD_SUBSAMPLE_OFFSET           0x030
  56 #define XSCD_SAD_OFFSET                 0x038
  57 #define XSCD_ADDR_OFFSET                0x040
  58 #define XSCD_CHAN_OFFSET                0x100
  59 #define XSCD_CHAN_EN_OFFSET             0x780
  60
  61 #define XSCD_MAX_CHANNELS               8
  62
  63 /****************************** PROTOTYPES ************************************/
  64
  65 struct xscd_device;
  66
  67 /**
  68  * struct xscd_dma_desc - DMA channel
  69  * @luma_plane_addr: Luma plane buffer address
  70  * @vsize: width of the luma frame
  71  * @hsize: height of the luma frame
  72  * @stride: stride of the luma frame
  73  */
  74 struct xscd_dma_desc {
  75         dma_addr_t luma_plane_addr;
  76         u32 vsize;
  77         u32 hsize;
  78         u32 stride;
  79 };
  80
  81 /**
  82  * struct xscd_dma_tx_descriptor - Per Transaction structure
  83  * @async_tx: Async transaction descriptor
  84  * @sw: Software Descriptor
  85  * @node: Node in the channel descriptor list
  86  */
  87 struct xscd_dma_tx_descriptor {
  88         struct dma_async_tx_descriptor async_tx;
  89         struct xscd_dma_desc sw;
  90         struct list_head node;
  91 };
  92
  93 static inline struct xscd_dma_tx_descriptor *
  94 to_xscd_dma_tx_descriptor(struct dma_async_tx_descriptor *tx)
  95 {
  96         return container_of(tx, struct xscd_dma_tx_descriptor, async_tx);
  97 }
  98
  99 /**
 100  * struct xscd_dma_chan - DMA Channel structure
 101  * @xscd: SCD device
 102  * @iomem: I/O memory address of the channel registers
 103  * @id: scene change channel ID
 104  * @common: DMA common channel
 105  * @tasklet: Cleanup work after irq
 106  * @lock: Descriptor operation lock
 107  * @pending_list: Descriptors waiting
 108  * @done_list: Complete descriptors
 109  * @staged_desc: Next buffer to be programmed
 110  * @active_desc: Currently active buffer being read/written to
 111  * @idle: Channel idle state
 112  * @enabled: Channel is enabled
 113  * @valid_interrupt: Valid interrupt for the channel
 114  */
 115 struct xscd_dma_chan {
 116         struct xscd_device *xscd;
 117         void __iomem *iomem;
 118         unsigned int id;
 119
 120         struct dma_chan common;
 121         struct tasklet_struct tasklet;
 122
 123         /* Descriptor operation Lock */
 124         spinlock_t lock;
 125         struct list_head pending_list;
 126         struct list_head done_list;
 127         struct xscd_dma_tx_descriptor *staged_desc;
 128         struct xscd_dma_tx_descriptor *active_desc;
 129         bool idle;
 130         unsigned int enabled;
 131         bool valid_interrupt;
 132 };
 133
 134 static inline struct xscd_dma_chan *to_xscd_dma_chan(struct dma_chan *chan)
 135 {
 136         return container_of(chan, struct xscd_dma_chan, common);
 137 }
 138
 139 /**
 140  * struct xscd_chan - Video Stream structure
 141  * @id: scene change channel ID
 142  * @iomem: I/O memory address of the channel registers
 143  * @xscd: SCD device
 144  * @subdev: V4L2 subdevice
 145  * @pads: media pads
 146  * @format: active V4L2 media bus format for the pad
 147  * @event: scene change event
 148  * @dmachan: dma channel part of the scenechange stream
 149  * @lock: lock to protect active stream count variable
 150  */
 151 struct xscd_chan {
 152         int id;
 153         void __iomem *iomem;
 154         struct xscd_device *xscd;
 155         struct v4l2_subdev subdev;
 156         struct media_pad pads[2];
 157         struct v4l2_mbus_framefmt format;
 158         struct v4l2_event event;
 159         struct xscd_dma_chan dmachan;
 160
 161         /* Lock to protect active stream count */
 162         struct mutex lock;
 163 };
 164
 165 static inline struct xscd_chan *to_xscd_chan(struct v4l2_subdev *subdev)
 166 {
 167         return container_of(subdev, struct xscd_chan, subdev);
 168 }
 169
 170 /**
 171  * struct xscd_device - Xilinx Scene Change Detection device structure
 172  * @dev: (OF) device
 173  * @iomem: device I/O register space remapped to kernel virtual memory
 174  * @rst_gpio: reset GPIO
 175  * @clk: video core clock
 176  * @irq: Device IRQ
 177  * @memory_based: Flag to identify memory based mode
 178  * @num_streams: Number of streams in the design
 179  * @chans: video stream instances
 180  * @dma_device: DMA device structure
 181  * @channels: DMA channels
 182  * @active_streams: Number of active streams
 183  */
 184 struct xscd_device {
 185         struct device *dev;
 186         void __iomem *iomem;
 187         struct gpio_desc *rst_gpio;
 188         struct clk *clk;
 189         int irq;
 190
 191         u8 memory_based;
 192         int num_streams;
 193
 194         struct xscd_chan *chans;
 195
 196         struct dma_device dma_device;
 197         struct xscd_dma_chan *channels[XSCD_MAX_CHANNELS];
 198         u8 active_streams;
 199 };
 200
 201 /*
 202  * Register related operations
 203  */
 204 static inline u32 xscd_read(void __iomem *iomem, u32 addr)
 205 {
 206         return ioread32(iomem + addr);
 207 }
 208
 209 static inline void xscd_write(void __iomem *iomem, u32 addr, u32 value)
 210 {
 211         iowrite32(value, iomem + addr);
 212 }
 213
 214 static inline void xscd_clr(void __iomem *iomem, u32 addr, u32 clr)
 215 {
 216         xscd_write(iomem, addr, xscd_read(iomem, addr) & ~clr);
 217 }
 218
 219 static inline void xscd_set(void __iomem *iomem, u32 addr, u32 set)
 220 {
 221         xscd_write(iomem, addr, xscd_read(iomem, addr) | set);
 222 }
 223
 224 void xscd_dma_start_transfer(struct xscd_dma_chan *chan);
 225 void xscd_dma_start(struct xscd_dma_chan *chan);
 226 void xscd_dma_chan_enable(struct xscd_dma_chan *chan, int chan_en);
 227 void xscd_dma_reset(struct xscd_dma_chan *chan);
 228 void xscd_dma_halt(struct xscd_dma_chan *chan);
 229 void xscd_dma_irq_handler(struct xscd_device *xscd);
 230 int xscd_dma_init(struct xscd_device *xscd);
 231 void xscd_dma_cleanup(struct xscd_device *xscd);
 232
 233 void xscd_chan_irq_handler(struct xscd_chan *chan);
 234 int xscd_chan_init(struct xscd_device *xscd, unsigned int chan_id,
 235                    struct device_node *node);
 236 #endif