pipeline/interface/ia_css_pipeline.h

69 /* Stage descriptor used to create a new stage in the pipeline */
81 /* @brief initialize the pipeline module
85  * Initializes the pipeline module. This API has to be called
86  * before any operation on the pipeline module is done
90 /* @brief initialize the pipeline structure with default values
92  * @param[out] pipeline  structure to be initialized with defaults
94  * @param[in] pipe_num Number that uniquely identifies a pipeline.
97  * Initializes the pipeline structure with a set of default values.
98  * This API is expected to be used when a pipeline structure is allocated
102     struct ia_css_pipeline *pipeline,
107 /* @brief destroy a pipeline
109  * @param[in] pipeline
113 void ia_css_pipeline_destroy(struct ia_css_pipeline *pipeline);
115 /* @brief Starts a pipeline
118  * @param[in] pipeline
123 			   struct ia_css_pipeline *pipeline);
125 /* @brief Request to stop a pipeline
127  * @param[in] pipeline
131 int ia_css_pipeline_request_stop(struct ia_css_pipeline *pipeline);
133 /* @brief Check whether pipeline has stopped
135  * @param[in] pipeline
136  * @return    true if the pipeline has stopped
141 /* @brief clean all the stages pipeline and make it as new
143  * @param[in] pipeline
147 void ia_css_pipeline_clean(struct ia_css_pipeline *pipeline);
149 /* @brief Add a stage to pipeline.
151  * @param     pipeline               Pointer to the pipeline to be added to.
156  * Add a new stage to a non-NULL pipeline.
161     struct ia_css_pipeline *pipeline,
165 /* @brief Finalize the stages in a pipeline
167  * @param     pipeline               Pointer to the pipeline to be added to.
172 void ia_css_pipeline_finalize_stages(struct ia_css_pipeline *pipeline,
175 /* @brief gets a stage from the pipeline
177  * @param[in] pipeline
181 int ia_css_pipeline_get_stage(struct ia_css_pipeline *pipeline,
185 /* @brief Gets a pipeline stage corresponding Firmware handle from the pipeline
187  * @param[in] pipeline
195 	*pipeline,
199 /* @brief Gets the Firmware handle corresponding the stage num from the pipeline
201  * @param[in] pipeline
209 	*pipeline,
213 /* @brief gets the output stage from the pipeline
215  * @param[in] pipeline
220     struct ia_css_pipeline *pipeline,
224 /* @brief Checks whether the pipeline uses params
226  * @param[in] pipeline
227  * @return    true if the pipeline uses params
230 bool ia_css_pipeline_uses_params(struct ia_css_pipeline *pipeline);
245  * @brief Get the pipeline io status
254  * @brief Map an SP thread to this pipeline
263  * @brief Checks whether the pipeline is mapped to SP threads
268  *	true, pipeline is mapped to SP threads
269  *	false, pipeline is not mapped to SP threads
274  * @brief Print pipeline thread mapping