[media] v4l2-dv-timings: add callback to handle exceptions

[cascardo/linux.git] / include / media / v4l2-dv-timings.h

diff --git a/include/media/v4l2-dv-timings.h b/include/media/v4l2-dv-timings.h
index bd59df8..4becc67 100644 (file)
--- a/include/media/v4l2-dv-timings.h
+++ b/include/media/v4l2-dv-timings.h
@@ -27,46 +27,68 @@
  */
 extern const struct v4l2_dv_timings v4l2_dv_timings_presets[];
 
+/** v4l2_check_dv_timings_fnc - timings check callback
+ * @t: the v4l2_dv_timings struct.
+ * @handle: a handle from the driver.
+ *
+ * Returns true if the given timings are valid.
+ */
+typedef bool v4l2_check_dv_timings_fnc(const struct v4l2_dv_timings *t, void *handle);
+
 /** v4l2_valid_dv_timings() - are these timings valid?
   * @t:          the v4l2_dv_timings struct.
   * @cap: the v4l2_dv_timings_cap capabilities.
+  * @fnc: callback to check if this timing is OK. May be NULL.
+  * @fnc_handle: a handle that is passed on to @fnc.
   *
   * Returns true if the given dv_timings struct is supported by the
-  * hardware capabilities, returns false otherwise.
+  * hardware capabilities and the callback function (if non-NULL), returns
+  * false otherwise.
   */
 bool v4l2_valid_dv_timings(const struct v4l2_dv_timings *t,
-                          const struct v4l2_dv_timings_cap *cap);
+                          const struct v4l2_dv_timings_cap *cap,
+                          v4l2_check_dv_timings_fnc fnc,
+                          void *fnc_handle);
 
 /** v4l2_enum_dv_timings_cap() - Helper function to enumerate possible DV timings based on capabilities
   * @t:          the v4l2_enum_dv_timings struct.
   * @cap: the v4l2_dv_timings_cap capabilities.
+  * @fnc: callback to check if this timing is OK. May be NULL.
+  * @fnc_handle: a handle that is passed on to @fnc.
   *
   * This enumerates dv_timings using the full list of possible CEA-861 and DMT
   * timings, filtering out any timings that are not supported based on the
-  * hardware capabilities.
+  * hardware capabilities and the callback function (if non-NULL).
   *
   * If a valid timing for the given index is found, it will fill in @t and
   * return 0, otherwise it returns -EINVAL.
   */
 int v4l2_enum_dv_timings_cap(struct v4l2_enum_dv_timings *t,
-                            const struct v4l2_dv_timings_cap *cap);
+                            const struct v4l2_dv_timings_cap *cap,
+                            v4l2_check_dv_timings_fnc fnc,
+                            void *fnc_handle);
 
 /** v4l2_find_dv_timings_cap() - Find the closest timings struct
   * @t:          the v4l2_enum_dv_timings struct.
   * @cap: the v4l2_dv_timings_cap capabilities.
   * @pclock_delta: maximum delta between t->pixelclock and the timing struct
   *            under consideration.
+  * @fnc: callback to check if a given timings struct is OK. May be NULL.
+  * @fnc_handle: a handle that is passed on to @fnc.
   *
   * This function tries to map the given timings to an entry in the
   * full list of possible CEA-861 and DMT timings, filtering out any timings
-  * that are not supported based on the hardware capabilities.
+  * that are not supported based on the hardware capabilities and the callback
+  * function (if non-NULL).
   *
   * On success it will fill in @t with the found timings and it returns true.
   * On failure it will return false.
   */
 bool v4l2_find_dv_timings_cap(struct v4l2_dv_timings *t,
                              const struct v4l2_dv_timings_cap *cap,
-                             unsigned pclock_delta);
+                             unsigned pclock_delta,
+                             v4l2_check_dv_timings_fnc fnc,
+                             void *fnc_handle);
 
 /** v4l2_match_dv_timings() - do two timings match?
   * @measured:   the measured timings data.