Browse Source

drm/irq: Document return values more consistently

Some of the functions are documented inconsistently. Add Returns:
sections where missing and use consistent style to describe the return
value.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Thierry Reding 10 years ago
parent
commit
c30e11fc66
1 changed files with 5 additions and 2 deletions
  1. 5 2
      drivers/gpu/drm/drm_irq.c

+ 5 - 2
drivers/gpu/drm/drm_irq.c

@@ -1006,6 +1006,9 @@ EXPORT_SYMBOL(drm_crtc_send_vblank_event);
  * drm_vblank_enable - enable the vblank interrupt on a CRTC
  * drm_vblank_enable - enable the vblank interrupt on a CRTC
  * @dev: DRM device
  * @dev: DRM device
  * @pipe: CRTC index
  * @pipe: CRTC index
+ *
+ * Returns:
+ * Zero on success or a negative error code on failure.
  */
  */
 static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
 static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
 {
 {
@@ -1050,7 +1053,7 @@ static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
  * This is the legacy version of drm_crtc_vblank_get().
  * This is the legacy version of drm_crtc_vblank_get().
  *
  *
  * Returns:
  * Returns:
- * Zero on success, nonzero on failure.
+ * Zero on success or a negative error code on failure.
  */
  */
 int drm_vblank_get(struct drm_device *dev, unsigned int pipe)
 int drm_vblank_get(struct drm_device *dev, unsigned int pipe)
 {
 {
@@ -1090,7 +1093,7 @@ EXPORT_SYMBOL(drm_vblank_get);
  * This is the native kms version of drm_vblank_get().
  * This is the native kms version of drm_vblank_get().
  *
  *
  * Returns:
  * Returns:
- * Zero on success, nonzero on failure.
+ * Zero on success or a negative error code on failure.
  */
  */
 int drm_crtc_vblank_get(struct drm_crtc *crtc)
 int drm_crtc_vblank_get(struct drm_crtc *crtc)
 {
 {