diff options
| author | Thierry Reding <treding@nvidia.com> | 2014-08-05 10:41:13 +0200 |
|---|---|---|
| committer | Thierry Reding <treding@nvidia.com> | 2014-11-13 13:55:57 +0100 |
| commit | 009081e0874d28b504ffa1842f6ddfafd2dd36fc (patch) | |
| tree | 5457fbed8f4636ffaa10455f0d60189642669404 /drivers/gpu/drm/drm_mipi_dsi.c | |
| parent | 42fe1e755d08b80c8be8eec5120946142950b931 (diff) | |
drm/dsi: Add to DocBook documentation
Integrate the MIPI DSI helpers into DocBook and clean up various
kerneldoc warnings. Also add a brief DOC section and clarify some
aspects of the mipi_dsi_host struct's .transfer() operation.
Acked-by: Andrzej Hajda <a.hajda@samsung.com>
Reviewed-by: Sean Paul <seanpaul@chromium.org>
Signed-off-by: Thierry Reding <treding@nvidia.com>
Diffstat (limited to 'drivers/gpu/drm/drm_mipi_dsi.c')
| -rw-r--r-- | drivers/gpu/drm/drm_mipi_dsi.c | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/drivers/gpu/drm/drm_mipi_dsi.c b/drivers/gpu/drm/drm_mipi_dsi.c index c7cc8fa23b58..431e96f19288 100644 --- a/drivers/gpu/drm/drm_mipi_dsi.c +++ b/drivers/gpu/drm/drm_mipi_dsi.c @@ -35,6 +35,16 @@ #include <video/mipi_display.h> +/** + * DOC: dsi helpers + * + * These functions contain some common logic and helpers to deal with MIPI DSI + * peripherals. + * + * Helpers are provided for a number of standard MIPI DSI command as well as a + * subset of the MIPI DCS command set. + */ + static int mipi_dsi_device_match(struct device *dev, struct device_driver *drv) { return of_driver_match_device(dev, drv); @@ -699,8 +709,10 @@ static void mipi_dsi_drv_shutdown(struct device *dev) } /** - * mipi_dsi_driver_register - register a driver for DSI devices + * mipi_dsi_driver_register() - register a driver for DSI devices * @drv: DSI driver structure + * + * Return: 0 on success or a negative error code on failure. */ int mipi_dsi_driver_register(struct mipi_dsi_driver *drv) { @@ -717,8 +729,10 @@ int mipi_dsi_driver_register(struct mipi_dsi_driver *drv) EXPORT_SYMBOL(mipi_dsi_driver_register); /** - * mipi_dsi_driver_unregister - unregister a driver for DSI devices + * mipi_dsi_driver_unregister() - unregister a driver for DSI devices * @drv: DSI driver structure + * + * Return: 0 on success or a negative error code on failure. */ void mipi_dsi_driver_unregister(struct mipi_dsi_driver *drv) { |