Skip to content

Commit

Permalink
drm: Pull drm_crtc.h into the kerneldoc template
Browse files Browse the repository at this point in the history
While writing atomic docs I've noticed that I don't get any errors
for my screw-ups in drm_crtc.h. Fix this immediately.

This just does the bare minimum to get starts, lots of stuff isn't
properly documented yet unfortunately.

v2: Fix adjacent spelling error Sean noticed.

Reviewed-by: Sean Paul <seanpaul@chromium.org>
Cc: Sean Paul <seanpaul@chromium.org>
Reviewed-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
  • Loading branch information
Daniel Vetter committed Nov 4, 2014
1 parent 3cb9ae4 commit 3bf0401
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
4 changes: 4 additions & 0 deletions Documentation/DocBook/drm.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -1825,6 +1825,10 @@ void intel_crt_init(struct drm_device *dev)
<sect2>
<title>KMS API Functions</title>
!Edrivers/gpu/drm/drm_crtc.c
</sect2>
<sect2>
<title>KMS Data Structures</title>
!Iinclude/drm/drm_crtc.h
</sect2>
<sect2>
<title>KMS Locking</title>
Expand Down
28 changes: 14 additions & 14 deletions include/drm/drm_crtc.h
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ struct drm_framebuffer_funcs {
int (*create_handle)(struct drm_framebuffer *fb,
struct drm_file *file_priv,
unsigned int *handle);
/**
* Optinal callback for the dirty fb ioctl.
/*
* Optional callback for the dirty fb ioctl.
*
* Userspace can notify the driver via this callback
* that a area of the framebuffer has changed and should
Expand Down Expand Up @@ -226,7 +226,7 @@ struct drm_plane;
struct drm_bridge;

/**
* drm_crtc_funcs - control CRTCs for a given device
* struct drm_crtc_funcs - control CRTCs for a given device
* @save: save CRTC state
* @restore: restore CRTC state
* @reset: reset CRTC after state has been invalidated (e.g. resume)
Expand Down Expand Up @@ -290,7 +290,7 @@ struct drm_crtc_funcs {
};

/**
* drm_crtc - central CRTC control structure
* struct drm_crtc - central CRTC control structure
* @dev: parent DRM device
* @head: list management
* @mutex: per-CRTC locking
Expand Down Expand Up @@ -322,7 +322,7 @@ struct drm_crtc {
struct device_node *port;
struct list_head head;

/**
/*
* crtc mutex
*
* This provides a read lock for the overall crtc state (mode, dpms
Expand Down Expand Up @@ -377,7 +377,7 @@ struct drm_crtc {


/**
* drm_connector_funcs - control connectors on a given device
* struct drm_connector_funcs - control connectors on a given device
* @dpms: set power state (see drm_crtc_funcs above)
* @save: save connector state
* @restore: restore connector state
Expand Down Expand Up @@ -414,7 +414,7 @@ struct drm_connector_funcs {
};

/**
* drm_encoder_funcs - encoder controls
* struct drm_encoder_funcs - encoder controls
* @reset: reset state (e.g. at init or resume time)
* @destroy: cleanup and free associated data
*
Expand All @@ -428,7 +428,7 @@ struct drm_encoder_funcs {
#define DRM_CONNECTOR_MAX_ENCODER 3

/**
* drm_encoder - central DRM encoder structure
* struct drm_encoder - central DRM encoder structure
* @dev: parent DRM device
* @head: list management
* @base: base KMS object
Expand Down Expand Up @@ -472,7 +472,7 @@ struct drm_encoder {
#define MAX_ELD_BYTES 128

/**
* drm_connector - central DRM connector control structure
* struct drm_connector - central DRM connector control structure
* @dev: parent DRM device
* @kdev: kernel device for sysfs attributes
* @attr: sysfs attributes
Expand Down Expand Up @@ -566,7 +566,7 @@ struct drm_connector {
};

/**
* drm_plane_funcs - driver plane control functions
* struct drm_plane_funcs - driver plane control functions
* @update_plane: update the plane configuration
* @disable_plane: shut down the plane
* @destroy: clean up plane resources
Expand Down Expand Up @@ -594,7 +594,7 @@ enum drm_plane_type {
};

/**
* drm_plane - central DRM plane control structure
* struct drm_plane - central DRM plane control structure
* @dev: DRM device this plane belongs to
* @head: for list management
* @base: base mode object
Expand Down Expand Up @@ -632,7 +632,7 @@ struct drm_plane {
};

/**
* drm_bridge_funcs - drm_bridge control functions
* struct drm_bridge_funcs - drm_bridge control functions
* @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
* @disable: Called right before encoder prepare, disables the bridge
* @post_disable: Called right after encoder prepare, for lockstepped disable
Expand All @@ -656,7 +656,7 @@ struct drm_bridge_funcs {
};

/**
* drm_bridge - central DRM bridge control structure
* struct drm_bridge - central DRM bridge control structure
* @dev: DRM device this bridge belongs to
* @head: list management
* @base: base mode object
Expand All @@ -674,7 +674,7 @@ struct drm_bridge {
};

/**
* drm_mode_set - new values for a CRTC config change
* struct drm_mode_set - new values for a CRTC config change
* @head: list management
* @fb: framebuffer to use for new config
* @crtc: CRTC whose configuration we're about to change
Expand Down

0 comments on commit 3bf0401

Please sign in to comment.