msm: camera: MSM FD face detection driver

* Qualcomm MSM FD

Face detection hardware block.

The Face Detection Hardware Block will offload processing

on the host and also reduce power consumption.

Supports:

Front and back camera face detection concurrently.

Sizes: QVGA, VGA, WQVGA, WVGA at 20 pix minimum face size.

Required properties:

- compatible:

    - "qcom,face-detection"

- reg: offset and length of the register set for the device.

- reg-names: should specify relevant names to each reg property defined.

    - "fd_core" - FD CORE hardware register set.

    - "fd_misc" - FD MISC hardware register set.

    - "fd_vbif" - FD VBIF hardware register set.

- interrupts: should contain the fd interrupts.

- interrupt-names: should specify relevant names to each interrupts

  property defined.

- vdd-supply: phandle to GDSC regulator controlling face detection hw.

- clocks: list of entries each of which contains:

    - phandle to the clock controller.

    - macro containing clock's name in hardware.

- clock-names: should specify relevant names to each clocks

  property defined.

Optional properties:

- clock-rates: should specify clock rates in Hz to each clocks

  property defined.

Example:

    qcom,fd@fd878000 {

        compatible = "qcom,face-detection";

        reg = <0xfd878000 0x800>,

              <0xfd87c000 0x800>,

              <0xfd860000 0x1000>;

        reg-names = "fd_core", "fd_misc", "fd_vbif";

        interrupts = <0 316 0>;

        interrupt-names = "fd";

        vdd-supply = <&gdsc_fd>;

        clocks = <&clock_mmss clk_fd_core_clk>,

                 <&clock_mmss clk_fd_ahb_clk>,

                 <&clock_mmss clk_fd_axi_clk>,

                 <&clock_mmss clk_fd_core_uar_clk>;

        clock-names = "fd_core_clk", "fd_core_uar_clk",

                      "fd_axi_clk", "fd_ahb_clk";

        clock-rates = <400 400 334 80 240>;

    };

GCC_VERSION      := $(shell $(CONFIG_SHELL) $(PWD)/scripts/gcc-version.sh $(CROSS_COMPILE)gcc)

ccflags-y += -Idrivers/media/video/msm

obj-$(CONFIG_MSM_FD) += msm_fd_dev.o msm_fd_hw.o

/* Copyright (c) 2014, The Linux Foundation. All rights reserved.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 and

 * only version 2 as published by the Free Software Foundation.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 */

#ifndef __MSM_FD_DEV_H__

#define __MSM_FD_DEV_H__

#include <media/v4l2-device.h>

#include <media/v4l2-fh.h>

#include <media/v4l2-ctrls.h>

#include <media/msm_fd.h>

/* Maximum number of result buffers */

#define MSM_FD_MAX_RESULT_BUFS 5

/* Max number of clocks defined in device tree */

#define MSM_FD_MAX_CLK_NUM 10

/* Max number of clock rates defined in device tree */

#define MSM_FD_MAX_CLK_RATES 5

/* Max number of faces which can be detected in one hw processing */

#define MSM_FD_MAX_FACES_DETECTED 32

/*

 * struct msm_fd_size - Structure contain FD size related values.

 * @width: Image width.

 * @height: Image height.

 * @reg_val: Register value for this size.

 * @work_size: Working buffer size in bytes for this size.

 */

struct msm_fd_size {

	int width;

	int height;

	u32 reg_val;

	int work_size;

};

/*

 * struct msm_fd_setings - Structure contain FD settings values.

 * @min_size_index: Minimum face size array index.

 * @angle_index: Face detection angle array index.

 * @direction_index: Face detection direction array index.

 * @threshold: Face detection threshold value.

 * @speed: Face detection speed value (it should match with clock rate index).

 */

struct msm_fd_setings {

	unsigned int min_size_index;

	unsigned int angle_index;

	unsigned int direction_index;

	unsigned int threshold;

	unsigned int speed;

};

/*

 * struct msm_fd_format - Structure contain FD format settings.

 * @size: Pointer to fd size struct used for this format.

 * @crop: V4l2 crop structure.

 * @bytesperline: Bytes per line of input image buffer.

 * @sizeimage: Size of input image buffer.

 * @pixelformat: Pixel format of input image buffer.

 */

struct msm_fd_format {

	struct msm_fd_size *size;

	struct v4l2_rect crop;

	int bytesperline;

	int sizeimage;

	u32 pixelformat;

};

/*

 * struct msm_fd_mem_pool - Structure contain FD memory pool information.

 * @client: Pointer to ion client.

 * @domain_num: Domain number associated with FD hw.

 */

struct msm_fd_mem_pool {

	struct ion_client *client;

	int domain_num;

};

/*

 * struct msm_fd_buf_handle - Structure contain FD buffer handle information.

 * @fd: ion FD from which this buffer is imported.

 * @pool: Pointer to FD memory pool struct.

 * @handle: Pointer to ion handle.

 * @size: Size of the buffer.

 * @addr: Adders of FD mmu mapped buffer. This address should be set to FD hw.

 */

struct msm_fd_buf_handle {

	int fd;

	struct msm_fd_mem_pool *pool;

	void *handle;

	unsigned long size;

	ion_phys_addr_t addr;

};

/*

 * struct msm_fd_buffer - Vb2 buffer wrapper structure.

 * @vb: Videobuf 2 buffer structure.

 * @active: Flag indicating if buffer currently used by FD hw.

 * @completion: Completion need to wait on, if buffer is used by FD hw.

 * @format: Format information of this buffer.

 * @settings: Settings value of this buffer.

 * @work_addr: Working buffer address need to be used when for this buffer.

 * @list: Buffer is part of FD device processing queue

 */

struct msm_fd_buffer {

	struct vb2_buffer vb;

	atomic_t active;

	struct completion completion;

	struct msm_fd_format format;

	struct msm_fd_setings settings;

	ion_phys_addr_t work_addr;

	struct list_head list;

};

/*

 * struct msm_fd_stats - Structure contains FD result statistic information.

 * @frame_id: Frame id for which statistic corresponds to.

 * @face_cnt: Number of faces detected and included in face data.

 * @face_data: Structure containing detected face data information.

 */

struct msm_fd_stats {

	atomic_t frame_id;

	u32 face_cnt;

	struct msm_fd_face_data face_data[MSM_FD_MAX_FACES_DETECTED];

};

/*

 * struct fd_ctx - Structure contains per open file handle context.

 * @fd_device: Pointer to fd device.

 * @fh: V4l2 file handle.

 * @vb2_q: Videobuf 2 queue.

 * @sequence: Sequence number for this statistic.

 * @format: Current format.

 * @settings: Current settings.

 * @mem_pool: FD hw memory pool.

 * @stats: Pointer to statistic buffers.

 * @work_buf: Working memory buffer handle.

 * @wait_stop_stream: Pointer to completion to wait on stop stream.

 */

struct fd_ctx {

	struct msm_fd_device *fd_device;

	struct v4l2_fh fh;

	struct vb2_queue vb2_q;

	unsigned int sequence;

	atomic_t subscribed_for_event;

	struct msm_fd_format format;

	struct msm_fd_setings settings;

	struct msm_fd_mem_pool mem_pool;

	struct msm_fd_stats *stats;

	struct msm_fd_buf_handle work_buf;

	struct completion *wait_stop_stream;

};

/*

 * enum msm_fd_device_state - FD device state.

 * @MSM_FD_DEVICE_IDLE: Device is idle, we can start with processing.

 * @MSM_FD_DEVICE_RUNNING: Device is running, next processing will be

 * scheduled from fd irq.

 */

enum msm_fd_device_state {

	MSM_FD_DEVICE_IDLE,

	MSM_FD_DEVICE_RUNNING,

};

/*

 * enum msm_fd_mem_resources - FD device iomem resources.

 * @MSM_FD_IOMEM_CORE: Index of fd core registers.

 * @MSM_FD_IOMEM_MISC: Index of fd misc registers.

 * @MSM_FD_IOMEM_VBIF: Index of fd vbif registers.

 * @MSM_FD_IOMEM_LAST: Not valid.

 */

enum msm_fd_mem_resources {

	MSM_FD_IOMEM_CORE,

	MSM_FD_IOMEM_MISC,

	MSM_FD_IOMEM_VBIF,

	MSM_FD_IOMEM_LAST

};

/*

 * struct msm_fd_device - FD device structure.

 * @lock: Lock used for reference count.

 * @slock: Spinlock used to protect FD device struct.

 * @ref_count: Device reference count.

 * @res_mem: Array of memory resources used by FD device.

 * @iomem_base: Array of register mappings used by FD device.

 * @vdd: Pointer to vdd regulator.

 * @clk_num: Number of clocks attached to the device.

 * @clk: Array of clock resources used by fd device.

 * @clk_rates: Array of clock rates set.

 * @iommu_domain: Pointer to FD device iommu domain handler.

 * @iommu_domain_num: FD device iommu domain number.

 * @iommu_dev: Pointer to Ion iommu device.

 * @dev: Pointer to device struct.

 * @v4l2_dev: V4l2 device.

 * @video: Video device.

 * @state: FD device state.

 * @buf_queue: FD device processing queue.

 * @work_queue: Pointer to FD device IRQ bottom half workqueue.

 * @work: IRQ bottom half work struct.

 */

struct msm_fd_device {

	struct mutex lock;

	spinlock_t slock;

	int ref_count;

	int irq_num;

	struct resource *res_mem[MSM_FD_IOMEM_LAST];

	void __iomem *iomem_base[MSM_FD_IOMEM_LAST];

	struct resource *ioarea[MSM_FD_IOMEM_LAST];

	struct regulator *vdd;

	unsigned int clk_num;

	struct clk *clk[MSM_FD_MAX_CLK_NUM];

	unsigned int clk_rates_num;

	unsigned int clk_rates[MSM_FD_MAX_CLK_RATES][MSM_FD_MAX_CLK_NUM];

	struct iommu_domain *iommu_domain;

	int iommu_domain_num;

	struct device *iommu_dev;

	struct device *dev;

	struct v4l2_device v4l2_dev;

	struct video_device video;

	enum msm_fd_device_state state;

	struct list_head buf_queue;

	struct workqueue_struct *work_queue;

	struct work_struct work;

};

#endif /* __MSM_FD_DEV_H__ */