| Message ID | 1414573923-27326-1-git-send-email-daniel.vetter@ffwll.ch (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Wed, Oct 29, 2014 at 5:12 AM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote: > 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. > > Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Small spelling nit below, not sure if you want to fix it in this patch. Reviewed-by: Sean Paul <seanpaul@chromium.org> > --- > Documentation/DocBook/drm.tmpl | 4 ++++ > include/drm/drm_crtc.h | 26 +++++++++++++------------- > 2 files changed, 17 insertions(+), 13 deletions(-) > > diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl > index be35bc328b77..89829ae58e97 100644 > --- a/Documentation/DocBook/drm.tmpl > +++ b/Documentation/DocBook/drm.tmpl > @@ -1827,6 +1827,10 @@ void intel_crt_init(struct drm_device *dev) > !Edrivers/gpu/drm/drm_crtc.c > </sect2> > <sect2> > + <title>KMS Data Structures</title> > +!Iinclude/drm/drm_crtc.h > + </sect2> > + <sect2> > <title>KMS Locking</title> > !Pdrivers/gpu/drm/drm_modeset_lock.c kms locking > !Iinclude/drm/drm_modeset_lock.h > diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h > index 44c57d2a64ec..21a15850a4d5 100644 > --- a/include/drm/drm_crtc.h > +++ b/include/drm/drm_crtc.h > @@ -142,7 +142,7 @@ 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. Couldn't hurt to add an extra 'o' here while you're at it. > * > * Userspace can notify the driver via this callback > @@ -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) > @@ -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 > @@ -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 > @@ -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 > @@ -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 > * > @@ -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 > @@ -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 > @@ -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 > @@ -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 > @@ -632,7 +632,7 @@ struct drm_plane { > }; > > /** > - * drm_bridge_funcs - drm_bridge control functions > + * struct drm_bridge_funcs - drm_bridge control functions > * @attach: Called during drm_bridge_attach > * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge > * @disable: Called right before encoder prepare, disables the bridge > @@ -658,7 +658,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 > @@ -679,7 +679,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 > -- > 2.1.1 > > _______________________________________________ > dri-devel mailing list > dri-devel@lists.freedesktop.org > http://lists.freedesktop.org/mailman/listinfo/dri-devel
On Fri, Oct 31, 2014 at 07:25:08AM -0400, Sean Paul wrote: > On Wed, Oct 29, 2014 at 5:12 AM, Daniel Vetter <daniel.vetter@ffwll.ch> wrote: > > 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. > > > > Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> > > > Small spelling nit below, not sure if you want to fix it in this patch. Fixed locally, I'll resend the entire pile with the atomic patches again. > > Reviewed-by: Sean Paul <seanpaul@chromium.org> Thanks for your review. -Daniel > > > > --- > > Documentation/DocBook/drm.tmpl | 4 ++++ > > include/drm/drm_crtc.h | 26 +++++++++++++------------- > > 2 files changed, 17 insertions(+), 13 deletions(-) > > > > diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl > > index be35bc328b77..89829ae58e97 100644 > > --- a/Documentation/DocBook/drm.tmpl > > +++ b/Documentation/DocBook/drm.tmpl > > @@ -1827,6 +1827,10 @@ void intel_crt_init(struct drm_device *dev) > > !Edrivers/gpu/drm/drm_crtc.c > > </sect2> > > <sect2> > > + <title>KMS Data Structures</title> > > +!Iinclude/drm/drm_crtc.h > > + </sect2> > > + <sect2> > > <title>KMS Locking</title> > > !Pdrivers/gpu/drm/drm_modeset_lock.c kms locking > > !Iinclude/drm/drm_modeset_lock.h > > diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h > > index 44c57d2a64ec..21a15850a4d5 100644 > > --- a/include/drm/drm_crtc.h > > +++ b/include/drm/drm_crtc.h > > @@ -142,7 +142,7 @@ 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. > > Couldn't hurt to add an extra 'o' here while you're at it. > > > * > > * Userspace can notify the driver via this callback > > @@ -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) > > @@ -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 > > @@ -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 > > @@ -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 > > @@ -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 > > * > > @@ -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 > > @@ -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 > > @@ -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 > > @@ -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 > > @@ -632,7 +632,7 @@ struct drm_plane { > > }; > > > > /** > > - * drm_bridge_funcs - drm_bridge control functions > > + * struct drm_bridge_funcs - drm_bridge control functions > > * @attach: Called during drm_bridge_attach > > * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge > > * @disable: Called right before encoder prepare, disables the bridge > > @@ -658,7 +658,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 > > @@ -679,7 +679,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 > > -- > > 2.1.1 > > > > _______________________________________________ > > dri-devel mailing list > > dri-devel@lists.freedesktop.org > > http://lists.freedesktop.org/mailman/listinfo/dri-devel
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index be35bc328b77..89829ae58e97 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl @@ -1827,6 +1827,10 @@ void intel_crt_init(struct drm_device *dev) !Edrivers/gpu/drm/drm_crtc.c </sect2> <sect2> + <title>KMS Data Structures</title> +!Iinclude/drm/drm_crtc.h + </sect2> + <sect2> <title>KMS Locking</title> !Pdrivers/gpu/drm/drm_modeset_lock.c kms locking !Iinclude/drm/drm_modeset_lock.h diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h index 44c57d2a64ec..21a15850a4d5 100644 --- a/include/drm/drm_crtc.h +++ b/include/drm/drm_crtc.h @@ -142,7 +142,7 @@ 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. * * Userspace can notify the driver via this callback @@ -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) @@ -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 @@ -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 @@ -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 @@ -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 * @@ -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 @@ -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 @@ -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 @@ -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 @@ -632,7 +632,7 @@ struct drm_plane { }; /** - * drm_bridge_funcs - drm_bridge control functions + * struct drm_bridge_funcs - drm_bridge control functions * @attach: Called during drm_bridge_attach * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge * @disable: Called right before encoder prepare, disables the bridge @@ -658,7 +658,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 @@ -679,7 +679,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
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. Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> --- Documentation/DocBook/drm.tmpl | 4 ++++ include/drm/drm_crtc.h | 26 +++++++++++++------------- 2 files changed, 17 insertions(+), 13 deletions(-)