[linux-2.6-block.git] / drivers / staging / media / atomisp / pci / atomisp2 / css2400 / ia_css_event_public.h

/*
 * Support for Intel Camera Imaging ISP subsystem.
 * Copyright (c) 2015, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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 __IA_CSS_EVENT_PUBLIC_H
#define __IA_CSS_EVENT_PUBLIC_H

/* @file
 * This file contains CSS-API events functionality
 */

#include <type_support.h>	/* uint8_t */
#include <ia_css_err.h>		/* ia_css_err */
#include <ia_css_types.h>	/* ia_css_pipe */
#include <ia_css_timer.h>	/* ia_css_timer */

/* The event type, distinguishes the kind of events that
 * can are generated by the CSS system.
 *
 * !!!IMPORTANT!!! KEEP THE FOLLOWING IN SYNC:
 * 1) "enum ia_css_event_type"					(ia_css_event_public.h)
 * 2) "enum sh_css_sp_event_type"				(sh_css_internal.h)
 * 3) "enum ia_css_event_type event_id_2_event_mask"		(event_handler.sp.c)
 * 4) "enum ia_css_event_type convert_event_sp_to_host_domain"	(sh_css.c)
 */
enum ia_css_event_type {
	IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE		= 1 << 0,
	/** Output frame ready. */
	IA_CSS_EVENT_TYPE_SECOND_OUTPUT_FRAME_DONE	= 1 << 1,
	/** Second output frame ready. */
	IA_CSS_EVENT_TYPE_VF_OUTPUT_FRAME_DONE		= 1 << 2,
	/** Viewfinder Output frame ready. */
	IA_CSS_EVENT_TYPE_SECOND_VF_OUTPUT_FRAME_DONE	= 1 << 3,
	/** Second viewfinder Output frame ready. */
	IA_CSS_EVENT_TYPE_3A_STATISTICS_DONE		= 1 << 4,
	/** Indication that 3A statistics are available. */
	IA_CSS_EVENT_TYPE_DIS_STATISTICS_DONE		= 1 << 5,
	/** Indication that DIS statistics are available. */
	IA_CSS_EVENT_TYPE_PIPELINE_DONE			= 1 << 6,
	/** Pipeline Done event, sent after last pipeline stage. */
	IA_CSS_EVENT_TYPE_FRAME_TAGGED			= 1 << 7,
	/** Frame tagged. */
	IA_CSS_EVENT_TYPE_INPUT_FRAME_DONE		= 1 << 8,
	/** Input frame ready. */
	IA_CSS_EVENT_TYPE_METADATA_DONE			= 1 << 9,
	/** Metadata ready. */
	IA_CSS_EVENT_TYPE_LACE_STATISTICS_DONE		= 1 << 10,
	/** Indication that LACE statistics are available. */
	IA_CSS_EVENT_TYPE_ACC_STAGE_COMPLETE		= 1 << 11,
	/** Extension stage complete. */
	IA_CSS_EVENT_TYPE_TIMER				= 1 << 12,
	/** Timer event for measuring the SP side latencies. It contains the
             32-bit timer value from the SP */
	IA_CSS_EVENT_TYPE_PORT_EOF			= 1 << 13,
	/** End Of Frame event, sent when in buffered sensor mode. */
	IA_CSS_EVENT_TYPE_FW_WARNING			= 1 << 14,
	/** Performance warning encounter by FW */
	IA_CSS_EVENT_TYPE_FW_ASSERT			= 1 << 15,
	/** Assertion hit by FW */
};

#define IA_CSS_EVENT_TYPE_NONE 0

/* IA_CSS_EVENT_TYPE_ALL is a mask for all pipe related events.
 * The other events (such as PORT_EOF) cannot be enabled/disabled
 * and are hence excluded from this macro.
 */
#define IA_CSS_EVENT_TYPE_ALL \
	(IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE		| \
	 IA_CSS_EVENT_TYPE_SECOND_OUTPUT_FRAME_DONE	| \
	 IA_CSS_EVENT_TYPE_VF_OUTPUT_FRAME_DONE		| \
	 IA_CSS_EVENT_TYPE_SECOND_VF_OUTPUT_FRAME_DONE	| \
	 IA_CSS_EVENT_TYPE_3A_STATISTICS_DONE		| \
	 IA_CSS_EVENT_TYPE_DIS_STATISTICS_DONE		| \
	 IA_CSS_EVENT_TYPE_PIPELINE_DONE		| \
	 IA_CSS_EVENT_TYPE_FRAME_TAGGED			| \
	 IA_CSS_EVENT_TYPE_INPUT_FRAME_DONE		| \
	 IA_CSS_EVENT_TYPE_METADATA_DONE		| \
	 IA_CSS_EVENT_TYPE_LACE_STATISTICS_DONE		| \
	 IA_CSS_EVENT_TYPE_ACC_STAGE_COMPLETE)

/* The event struct, container for the event type and its related values.
 * Depending on the event type, either pipe or port will be filled.
 * Pipeline related events (like buffer/frame events) will return a valid and filled pipe handle.
 * For non pipeline related events (but i.e. stream specific, like EOF event), the port will be
 * filled.
 */
struct ia_css_event {
	struct ia_css_pipe    *pipe;
	/** Pipe handle on which event happened, NULL for non pipe related
	     events. */
	enum ia_css_event_type type;
	/** Type of Event, always valid/filled. */
	uint8_t                port;
	/** Port number for EOF event (not valid for other events). */
	uint8_t                exp_id;
	/** Exposure id for EOF/FRAME_TAGGED/FW_WARNING event (not valid for other events)
	     The exposure ID is unique only within a logical stream and it is
	     only generated on systems that have an input system (such as 2400
	     and 2401).
	     Most outputs produced by the CSS are tagged with an exposure ID.
	     This allows users of the CSS API to keep track of which buffer
	     was generated from which sensor output frame. This includes:
	     EOF event, output frames, 3A statistics, DVS statistics and
	     sensor metadata.
	     Exposure IDs start at IA_CSS_MIN_EXPOSURE_ID, increment by one
	     until IA_CSS_MAX_EXPOSURE_ID is reached, after that they wrap
	     around to IA_CSS_MIN_EXPOSURE_ID again.
	     Note that in case frames are dropped, this will not be reflected
	     in the exposure IDs. Therefor applications should not use this
	     to detect frame drops. */
	uint32_t               fw_handle;
	/** Firmware Handle for ACC_STAGE_COMPLETE event (not valid for other
	     events). */
	enum ia_css_fw_warning fw_warning;
	/** Firmware warning code, only for WARNING events. */
	uint8_t                fw_assert_module_id;
	/** Firmware module id, only for ASSERT events, should be logged by driver. */
	uint16_t               fw_assert_line_no;
	/** Firmware line number, only for ASSERT events, should be logged by driver. */
	clock_value_t	       timer_data;
	/** For storing the full 32-bit of the timer value. Valid only for TIMER
	     event */
	uint8_t                timer_code;
	/** For storing the code of the TIMER event. Valid only for
	     TIMER event */
	uint8_t                timer_subcode;
	/** For storing the subcode of the TIMER event. Valid only
	     for TIMER event */
};

/* @brief Dequeue a PSYS event from the CSS system.
 *
 * @param[out]	event   Pointer to the event struct which will be filled by
 *                      this function if an event is available.
 * @return		IA_CSS_ERR_QUEUE_IS_EMPTY if no events are
 *			available or
 *			IA_CSS_SUCCESS otherwise.
 *
 * This function dequeues an event from the PSYS event queue. The queue is
 * between the Host CPU and the CSS system. This function can be
 * called after an interrupt has been generated that signalled that a new event
 * was available and can be used in a polling-like situation where the NO_EVENT
 * return value is used to determine whether an event was available or not.
 */
enum ia_css_err
ia_css_dequeue_psys_event(struct ia_css_event *event);

/* @brief Dequeue an event from the CSS system.
 *
 * @param[out]	event   Pointer to the event struct which will be filled by
 *                      this function if an event is available.
 * @return		IA_CSS_ERR_QUEUE_IS_EMPTY if no events are
 *			available or
 *			IA_CSS_SUCCESS otherwise.
 *
 * deprecated{Use ia_css_dequeue_psys_event instead}.
 * Unless the isys event queue is explicitly enabled, this function will
 * dequeue both isys (EOF) and psys events (all others).
 */
enum ia_css_err
ia_css_dequeue_event(struct ia_css_event *event);

/* @brief Dequeue an ISYS event from the CSS system.
 *
 * @param[out]	event   Pointer to the event struct which will be filled by
 *                      this function if an event is available.
 * @return		IA_CSS_ERR_QUEUE_IS_EMPTY if no events are
 *			available or
 *			IA_CSS_SUCCESS otherwise.
 *
 * This function dequeues an event from the ISYS event queue. The queue is
 * between host and the CSS system.
 * Unlike the ia_css_dequeue_event() function, this function can be called
 * directly from an interrupt service routine (ISR) and it is safe to call
 * this function in parallel with other CSS API functions (but only one
 * call to this function should be in flight at any point in time).
 *
 * The reason for having the ISYS events separate is to prevent them from
 * incurring additional latency due to locks being held by other CSS API
 * functions.
 */
enum ia_css_err
ia_css_dequeue_isys_event(struct ia_css_event *event);

#endif /* __IA_CSS_EVENT_PUBLIC_H */
Commit	Line	Data
a49d2536 AC	1	/*
	2	* Support for Intel Camera Imaging ISP subsystem.
	3	* Copyright (c) 2015, Intel Corporation.
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms and conditions of the GNU General Public License,
	7	* version 2, as published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*/
	14
	15	#ifndef __IA_CSS_EVENT_PUBLIC_H
	16	#define __IA_CSS_EVENT_PUBLIC_H
	17
d929fb4e	18	/* @file
a49d2536 AC	19	* This file contains CSS-API events functionality
	20	*/
	21
	22	#include <type_support.h> /* uint8_t */
	23	#include <ia_css_err.h> /* ia_css_err */
	24	#include <ia_css_types.h> /* ia_css_pipe */
	25	#include <ia_css_timer.h> /* ia_css_timer */
	26
d929fb4e	27	/* The event type, distinguishes the kind of events that
a49d2536 AC	28	* can are generated by the CSS system.
	29	*
	30	* !!!IMPORTANT!!! KEEP THE FOLLOWING IN SYNC:
	31	* 1) "enum ia_css_event_type" (ia_css_event_public.h)
	32	* 2) "enum sh_css_sp_event_type" (sh_css_internal.h)
	33	* 3) "enum ia_css_event_type event_id_2_event_mask" (event_handler.sp.c)
	34	* 4) "enum ia_css_event_type convert_event_sp_to_host_domain" (sh_css.c)
	35	*/
	36	enum ia_css_event_type {
	37	IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE = 1 << 0,
d929fb4e	38	/** Output frame ready. */
a49d2536	39	IA_CSS_EVENT_TYPE_SECOND_OUTPUT_FRAME_DONE = 1 << 1,
d929fb4e	40	/** Second output frame ready. */
a49d2536	41	IA_CSS_EVENT_TYPE_VF_OUTPUT_FRAME_DONE = 1 << 2,
d929fb4e	42	/** Viewfinder Output frame ready. */
a49d2536	43	IA_CSS_EVENT_TYPE_SECOND_VF_OUTPUT_FRAME_DONE = 1 << 3,
d929fb4e	44	/** Second viewfinder Output frame ready. */
a49d2536	45	IA_CSS_EVENT_TYPE_3A_STATISTICS_DONE = 1 << 4,
d929fb4e	46	/** Indication that 3A statistics are available. */
a49d2536	47	IA_CSS_EVENT_TYPE_DIS_STATISTICS_DONE = 1 << 5,
d929fb4e	48	/** Indication that DIS statistics are available. */
a49d2536	49	IA_CSS_EVENT_TYPE_PIPELINE_DONE = 1 << 6,
d929fb4e	50	/** Pipeline Done event, sent after last pipeline stage. */
a49d2536	51	IA_CSS_EVENT_TYPE_FRAME_TAGGED = 1 << 7,
d929fb4e	52	/** Frame tagged. */
a49d2536	53	IA_CSS_EVENT_TYPE_INPUT_FRAME_DONE = 1 << 8,
d929fb4e	54	/** Input frame ready. */
a49d2536	55	IA_CSS_EVENT_TYPE_METADATA_DONE = 1 << 9,
d929fb4e	56	/** Metadata ready. */
a49d2536	57	IA_CSS_EVENT_TYPE_LACE_STATISTICS_DONE = 1 << 10,
d929fb4e	58	/** Indication that LACE statistics are available. */
a49d2536	59	IA_CSS_EVENT_TYPE_ACC_STAGE_COMPLETE = 1 << 11,
d929fb4e	60	/** Extension stage complete. */
a49d2536	61	IA_CSS_EVENT_TYPE_TIMER = 1 << 12,
d929fb4e	62	/** Timer event for measuring the SP side latencies. It contains the
a49d2536 AC	63	32-bit timer value from the SP */
a49d2536 AC	64	IA_CSS_EVENT_TYPE_PORT_EOF = 1 << 13,
d929fb4e	65	/** End Of Frame event, sent when in buffered sensor mode. */
a49d2536	66	IA_CSS_EVENT_TYPE_FW_WARNING = 1 << 14,
d929fb4e	67	/** Performance warning encounter by FW */
a49d2536	68	IA_CSS_EVENT_TYPE_FW_ASSERT = 1 << 15,
d929fb4e	69	/** Assertion hit by FW */
a49d2536 AC	70	};
	71
	72	#define IA_CSS_EVENT_TYPE_NONE 0
	73
d929fb4e	74	/* IA_CSS_EVENT_TYPE_ALL is a mask for all pipe related events.
a49d2536 AC	75	* The other events (such as PORT_EOF) cannot be enabled/disabled
	76	* and are hence excluded from this macro.
	77	*/
	78	#define IA_CSS_EVENT_TYPE_ALL \
	79	(IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE \| \
	80	IA_CSS_EVENT_TYPE_SECOND_OUTPUT_FRAME_DONE \| \
	81	IA_CSS_EVENT_TYPE_VF_OUTPUT_FRAME_DONE \| \
	82	IA_CSS_EVENT_TYPE_SECOND_VF_OUTPUT_FRAME_DONE \| \
	83	IA_CSS_EVENT_TYPE_3A_STATISTICS_DONE \| \
	84	IA_CSS_EVENT_TYPE_DIS_STATISTICS_DONE \| \
	85	IA_CSS_EVENT_TYPE_PIPELINE_DONE \| \
	86	IA_CSS_EVENT_TYPE_FRAME_TAGGED \| \
	87	IA_CSS_EVENT_TYPE_INPUT_FRAME_DONE \| \
	88	IA_CSS_EVENT_TYPE_METADATA_DONE \| \
	89	IA_CSS_EVENT_TYPE_LACE_STATISTICS_DONE \| \
	90	IA_CSS_EVENT_TYPE_ACC_STAGE_COMPLETE)
	91
d929fb4e	92	/* The event struct, container for the event type and its related values.
a49d2536 AC	93	* Depending on the event type, either pipe or port will be filled.
	94	* Pipeline related events (like buffer/frame events) will return a valid and filled pipe handle.
	95	* For non pipeline related events (but i.e. stream specific, like EOF event), the port will be
	96	* filled.
	97	*/
	98	struct ia_css_event {
	99	struct ia_css_pipe *pipe;
d929fb4e	100	/** Pipe handle on which event happened, NULL for non pipe related
a49d2536 AC	101	events. */
a49d2536 AC	102	enum ia_css_event_type type;
d929fb4e	103	/** Type of Event, always valid/filled. */
a49d2536	104	uint8_t port;
d929fb4e	105	/** Port number for EOF event (not valid for other events). */
a49d2536	106	uint8_t exp_id;
d929fb4e	107	/** Exposure id for EOF/FRAME_TAGGED/FW_WARNING event (not valid for other events)
a49d2536 AC	108	The exposure ID is unique only within a logical stream and it is
	109	only generated on systems that have an input system (such as 2400
	110	and 2401).
	111	Most outputs produced by the CSS are tagged with an exposure ID.
	112	This allows users of the CSS API to keep track of which buffer
	113	was generated from which sensor output frame. This includes:
	114	EOF event, output frames, 3A statistics, DVS statistics and
	115	sensor metadata.
	116	Exposure IDs start at IA_CSS_MIN_EXPOSURE_ID, increment by one
	117	until IA_CSS_MAX_EXPOSURE_ID is reached, after that they wrap
	118	around to IA_CSS_MIN_EXPOSURE_ID again.
	119	Note that in case frames are dropped, this will not be reflected
	120	in the exposure IDs. Therefor applications should not use this
	121	to detect frame drops. */
	122	uint32_t fw_handle;
d929fb4e	123	/** Firmware Handle for ACC_STAGE_COMPLETE event (not valid for other
a49d2536 AC	124	events). */
a49d2536 AC	125	enum ia_css_fw_warning fw_warning;
d929fb4e	126	/** Firmware warning code, only for WARNING events. */
a49d2536	127	uint8_t fw_assert_module_id;
d929fb4e	128	/** Firmware module id, only for ASSERT events, should be logged by driver. */
a49d2536	129	uint16_t fw_assert_line_no;
d929fb4e	130	/** Firmware line number, only for ASSERT events, should be logged by driver. */
a49d2536	131	clock_value_t timer_data;
d929fb4e	132	/** For storing the full 32-bit of the timer value. Valid only for TIMER
a49d2536 AC	133	event */
a49d2536 AC	134	uint8_t timer_code;
d929fb4e	135	/** For storing the code of the TIMER event. Valid only for
a49d2536 AC	136	TIMER event */
a49d2536 AC	137	uint8_t timer_subcode;
d929fb4e	138	/** For storing the subcode of the TIMER event. Valid only
a49d2536 AC	139	for TIMER event */
	140	};
	141
d929fb4e	142	/* @brief Dequeue a PSYS event from the CSS system.
a49d2536 AC	143	*
	144	* @param[out] event Pointer to the event struct which will be filled by
	145	* this function if an event is available.
	146	* @return IA_CSS_ERR_QUEUE_IS_EMPTY if no events are
	147	* available or
	148	* IA_CSS_SUCCESS otherwise.
	149	*
	150	* This function dequeues an event from the PSYS event queue. The queue is
	151	* between the Host CPU and the CSS system. This function can be
	152	* called after an interrupt has been generated that signalled that a new event
	153	* was available and can be used in a polling-like situation where the NO_EVENT
	154	* return value is used to determine whether an event was available or not.
	155	*/
	156	enum ia_css_err
	157	ia_css_dequeue_psys_event(struct ia_css_event *event);
	158
d929fb4e	159	/* @brief Dequeue an event from the CSS system.
a49d2536 AC	160	*
	161	* @param[out] event Pointer to the event struct which will be filled by
	162	* this function if an event is available.
	163	* @return IA_CSS_ERR_QUEUE_IS_EMPTY if no events are
	164	* available or
	165	* IA_CSS_SUCCESS otherwise.
	166	*
	167	* deprecated{Use ia_css_dequeue_psys_event instead}.
	168	* Unless the isys event queue is explicitly enabled, this function will
	169	* dequeue both isys (EOF) and psys events (all others).
	170	*/
	171	enum ia_css_err
	172	ia_css_dequeue_event(struct ia_css_event *event);
	173
d929fb4e	174	/* @brief Dequeue an ISYS event from the CSS system.
a49d2536 AC	175	*
	176	* @param[out] event Pointer to the event struct which will be filled by
	177	* this function if an event is available.
	178	* @return IA_CSS_ERR_QUEUE_IS_EMPTY if no events are
	179	* available or
	180	* IA_CSS_SUCCESS otherwise.
	181	*
	182	* This function dequeues an event from the ISYS event queue. The queue is
	183	* between host and the CSS system.
	184	* Unlike the ia_css_dequeue_event() function, this function can be called
	185	* directly from an interrupt service routine (ISR) and it is safe to call
	186	* this function in parallel with other CSS API functions (but only one
	187	* call to this function should be in flight at any point in time).
	188	*
	189	* The reason for having the ISYS events separate is to prevent them from
	190	* incurring additional latency due to locks being held by other CSS API
	191	* functions.
	192	*/
	193	enum ia_css_err
	194	ia_css_dequeue_isys_event(struct ia_css_event *event);
	195
	196	#endif /* __IA_CSS_EVENT_PUBLIC_H */