drm/tegra: dc: Document tegra_dc_state_setup_clock()
authorThierry Reding <treding@nvidia.com>
Wed, 28 Jan 2015 14:25:54 +0000 (15:25 +0100)
committerThierry Reding <treding@nvidia.com>
Thu, 2 Apr 2015 16:49:22 +0000 (18:49 +0200)
This function is called by output drivers so should be documented. While
at it, move it to a more appropriate location.

Signed-off-by: Thierry Reding <treding@nvidia.com>
drivers/gpu/drm/tegra/dc.c

index 1ec24c37d310ed6bfad142e9356f5bf77a455657..076769aba42edbe611d73b976a46c105a0f18e17 100644 (file)
@@ -1164,6 +1164,18 @@ static int tegra_dc_set_timings(struct tegra_dc *dc,
        return 0;
 }
 
+/**
+ * tegra_dc_state_setup_clock - check clock settings and store them in atomic
+ *     state
+ * @dc: display controller
+ * @crtc_state: CRTC atomic state
+ * @clk: parent clock for display controller
+ * @pclk: pixel clock
+ * @div: shift clock divider
+ *
+ * Returns:
+ * 0 on success or a negative error-code on failure.
+ */
 int tegra_dc_state_setup_clock(struct tegra_dc *dc,
                               struct drm_crtc_state *crtc_state,
                               struct clk *clk, unsigned long pclk,