/* SPDX-License-Identifier: GPL-2.0 */ /* * 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_PIPE_PUBLIC_H #define __IA_CSS_PIPE_PUBLIC_H /* @file * This file contains the public interface for CSS pipes. */ #include <type_support.h> #include <ia_css_err.h> #include <ia_css_types.h> #include <ia_css_frame_public.h> #include <ia_css_buffer.h> /* ISP2401 */ #include <ia_css_acc_types.h> enum { … }; /* Enumeration of pipe modes. This mode can be used to create * an image pipe for this mode. These pipes can be combined * to configure and run streams on the ISP. * * For example, one can create a preview and capture pipe to * create a continuous capture stream. */ enum ia_css_pipe_mode { … }; /* Temporary define */ #define IA_CSS_PIPE_MODE_NUM … /** * Enumeration of pipe versions. * the order should match with definition in sh_css_defs.h */ enum ia_css_pipe_version { … }; /** * Pipe configuration structure. * Resolution properties are filled by Driver, kernel configurations are * set by AIC */ struct ia_css_pipe_config { … }; /** * Default settings for newly created pipe configurations. */ #define DEFAULT_PIPE_CONFIG … /* Pipe info, this struct describes properties of a pipe after it's stream has * been created. * ~~~** DO NOT ADD NEW FIELD **~~~ This structure will be deprecated. * - On the Behalf of CSS-API Committee. */ struct ia_css_pipe_info { … }; /** * Defaults for ia_css_pipe_info structs. */ #define DEFAULT_PIPE_INFO … /* @brief Load default pipe configuration * @param[out] pipe_config The pipe configuration. * @return None * * This function will load the default pipe configuration: @code struct ia_css_pipe_config def_config = { IA_CSS_PIPE_MODE_PREVIEW, // mode 1, // isp_pipe_version {0, 0}, // bayer_ds_out_res {0, 0}, // capt_pp_in_res {0, 0}, // vf_pp_in_res {0, 0}, // dvs_crop_out_res {{0, 0}, 0, 0, 0, 0}, // output_info {{0, 0}, 0, 0, 0, 0}, // second_output_info {{0, 0}, 0, 0, 0, 0}, // vf_output_info {{0, 0}, 0, 0, 0, 0}, // second_vf_output_info { IA_CSS_CAPTURE_MODE_RAW, // mode false, // enable_xnr false // enable_raw_output }, // default_capture_config {0, 0}, // dvs_envelope 1, // dvs_frame_delay true, // enable_dz NULL, // p_isp_config }; @endcode */ void ia_css_pipe_config_defaults(struct ia_css_pipe_config *pipe_config); /* @brief Create a pipe * @param[in] config The pipe configuration. * @param[out] pipe The pipe. * @return 0 or the error code. * * This function will create a pipe with the given * configuration. */ int ia_css_pipe_create(const struct ia_css_pipe_config *config, struct ia_css_pipe **pipe); /* @brief Destroy a pipe * @param[in] pipe The pipe. * @return 0 or the error code. * * This function will destroy a given pipe. */ int ia_css_pipe_destroy(struct ia_css_pipe *pipe); /* @brief Provides information about a pipe * @param[in] pipe The pipe. * @param[out] pipe_info The pipe information. * @return 0 or -EINVAL. * * This function will provide information about a given pipe. */ int ia_css_pipe_get_info(const struct ia_css_pipe *pipe, struct ia_css_pipe_info *pipe_info); /* @brief Configure a pipe with filter coefficients. * @param[in] pipe The pipe. * @param[in] config The pointer to ISP configuration. * @return 0 or error code upon error. * * This function configures the filter coefficients for an image * pipe. */ int ia_css_pipe_set_isp_config(struct ia_css_pipe *pipe, struct ia_css_isp_config *config); /* @brief Controls when the Event generator raises an IRQ to the Host. * * @param[in] pipe The pipe. * @param[in] or_mask Binary or of enum ia_css_event_irq_mask_type. Each pipe related event that is part of this mask will directly raise an IRQ to the Host when the event occurs in the CSS. * @param[in] and_mask Binary or of enum ia_css_event_irq_mask_type. An event IRQ for the Host is only raised after all pipe related events have occurred at least once for all the active pipes. Events are remembered and don't need to occurred at the same moment in time. There is no control over the order of these events. Once an IRQ has been raised all remembered events are reset. * @return 0. * Controls when the Event generator in the CSS raises an IRQ to the Host. The main purpose of this function is to reduce the amount of interrupts between the CSS and the Host. This will help saving power as it wakes up the Host less often. In case both or_mask and and_mask are IA_CSS_EVENT_TYPE_NONE for all pipes, no event IRQ's will be raised. An exception holds for IA_CSS_EVENT_TYPE_PORT_EOF, for this event an IRQ is always raised. Note that events are still queued and the Host can poll for them. The or_mask and and_mask may be active at the same time\n \n Default values, for all pipe id's, after ia_css_init:\n or_mask = IA_CSS_EVENT_TYPE_ALL\n and_mask = IA_CSS_EVENT_TYPE_NONE\n \n Examples\n \code ia_css_pipe_set_irq_mask(h_pipe, IA_CSS_EVENT_TYPE_3A_STATISTICS_DONE | IA_CSS_EVENT_TYPE_DIS_STATISTICS_DONE , IA_CSS_EVENT_TYPE_NONE); \endcode The event generator will only raise an interrupt to the Host when there are 3A or DIS statistics available from the preview pipe. It will not generate an interrupt for any other event of the preview pipe e.g when there is an output frame available. \code ia_css_pipe_set_irq_mask(h_pipe_preview, IA_CSS_EVENT_TYPE_NONE, IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE | IA_CSS_EVENT_TYPE_3A_STATISTICS_DONE ); ia_css_pipe_set_irq_mask(h_pipe_capture, IA_CSS_EVENT_TYPE_NONE, IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE ); \endcode The event generator will only raise an interrupt to the Host when there is both a frame done and 3A event available from the preview pipe AND when there is a frame done available from the capture pipe. Note that these events may occur at different moments in time. Also the order of the events is not relevant. \code ia_css_pipe_set_irq_mask(h_pipe_preview, IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE, IA_CSS_EVENT_TYPE_ALL ); ia_css_pipe_set_irq_mask(h_pipe_capture, IA_CSS_EVENT_TYPE_OUTPUT_FRAME_DONE, IA_CSS_EVENT_TYPE_ALL ); \endcode The event generator will only raise an interrupt to the Host when there is an output frame from the preview pipe OR an output frame from the capture pipe. All other events (3A, VF output, pipeline done) will not raise an interrupt to the Host. These events are not lost but always stored in the event queue. */ int ia_css_pipe_set_irq_mask(struct ia_css_pipe *pipe, unsigned int or_mask, unsigned int and_mask); /* @brief Reads the current event IRQ mask from the CSS. * * @param[in] pipe The pipe. * @param[out] or_mask Current or_mask. The bits in this mask are a binary or of enum ia_css_event_irq_mask_type. Pointer may be NULL. * @param[out] and_mask Current and_mask.The bits in this mask are a binary or of enum ia_css_event_irq_mask_type. Pointer may be NULL. * @return 0. * Reads the current event IRQ mask from the CSS. Reading returns the actual values as used by the SP and not any mirrored values stored at the Host.\n \n Precondition:\n SP must be running.\n */ int ia_css_event_get_irq_mask(const struct ia_css_pipe *pipe, unsigned int *or_mask, unsigned int *and_mask); /* @brief Queue a buffer for an image pipe. * * @param[in] pipe The pipe that will own the buffer. * @param[in] buffer Pointer to the buffer. * Note that the caller remains owner of the buffer * structure. Only the data pointer within it will * be passed into the internal queues. * @return IA_CSS_INTERNAL_ERROR in case of unexpected errors, * 0 otherwise. * * This function adds a buffer (which has a certain buffer type) to the queue * for this type. This queue is owned by the image pipe. After this function * completes successfully, the buffer is now owned by the image pipe and should * no longer be accessed by any other code until it gets dequeued. The image * pipe will dequeue buffers from this queue, use them and return them to the * host code via an interrupt. Buffers will be consumed in the same order they * get queued, but may be returned to the host out of order. */ int ia_css_pipe_enqueue_buffer(struct ia_css_pipe *pipe, const struct ia_css_buffer *buffer); /* @brief Dequeue a buffer from an image pipe. * * @param[in] pipe The pipeline that the buffer queue belongs to. * @param[in,out] buffer The buffer is used to lookup the type which determines * which internal queue to use. * The resulting buffer pointer is written into the dta * field. * @return IA_CSS_ERR_NO_BUFFER if the queue is empty or * 0 otherwise. * * This function dequeues a buffer from a buffer queue. The queue is indicated * by the buffer type argument. This function can be called after an interrupt * has been generated that signalled that a new buffer was available and can * be used in a polling-like situation where the NO_BUFFER return value is used * to determine whether a buffer was available or not. */ int ia_css_pipe_dequeue_buffer(struct ia_css_pipe *pipe, struct ia_css_buffer *buffer); /* @brief Get selected configuration settings * @param[in] pipe The pipe. * @param[out] config Configuration settings. * @return None */ void ia_css_pipe_get_isp_config(struct ia_css_pipe *pipe, struct ia_css_isp_config *config); /* @brief Set the scaler lut on this pipe. A copy of lut is made in the inuit * address space. So the LUT can be freed by caller. * @param[in] pipe Pipe handle. * @param[in] lut Look up tabel * * @return * 0 : Success * -EINVAL : Invalid Parameters * * Note: * 1) Note that both GDC's are programmed with the same table. * 2) Current implementation ignores the pipe and overrides the * global lut. This will be fixed in the future * 3) This function must be called before stream start * */ int ia_css_pipe_set_bci_scaler_lut(struct ia_css_pipe *pipe, const void *lut); /* @brief Checking of DVS statistics ability * @param[in] pipe_info The pipe info. * @return true - has DVS statistics ability * false - otherwise */ bool ia_css_pipe_has_dvs_stats(struct ia_css_pipe_info *pipe_info); /* ISP2401 */ /* @brief Override the frameformat set on the output pins. * @param[in] pipe Pipe handle. * @param[in] output_pin Pin index to set the format on * 0 - main output pin * 1 - display output pin * @param[in] format Format to set * * @return * 0 : Success * -EINVAL : Invalid Parameters * -EINVAL : Pipe misses binary info * * Note: * 1) This is an optional function to override the formats set in the pipe. * 2) Only overriding with IA_CSS_FRAME_FORMAT_NV12_TILEY is currently allowed. * 3) This function is only to be used on pipes that use the output system. * 4) If this function is used, it MUST be called after ia_css_pipe_create. * 5) If this function is used, this function MUST be called before ia_css_stream_start. */ int ia_css_pipe_override_frame_format(struct ia_css_pipe *pipe, int output_pin, enum ia_css_frame_format format); #endif /* __IA_CSS_PIPE_PUBLIC_H */
Codebase Browser
linux