aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/drm.tmpl (follow)
AgeCommit message (Collapse)AuthorFilesLines
2012-11-28drm/doc: add new dp helpers into drm DocBookDaniel Vetter1-0/+6
I didn't bother with documenting the really trivial new "extract something from dpcd" helpers, but the i2c over aux ch is now documented a bit. v2: Clarify the comment for i2c_dp_aux_add_bus a bit. v3: Fix more spelling fail spotted by Laurent Pinchart. Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Dave Airlie <airlied@redhat.com>
2012-11-28drm/doc: integrate fb helper reference into docsDaniel Vetter1-0/+5
Again only minimal changes to make kerneldoc no longer shout. Plus a little introduction in the form of a inline DOC: section to quickly explain what this is all about. v2: Fixup spelling fail. Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Dave Airlie <airlied@redhat.com>
2012-11-28drm/doc: integrate crtc helper api into docbookDaniel Vetter1-0/+4
- Add the missing doc for drm_helper_move_panel_connectors_to_head. - Fixup any outdated stuff in existing sections. I've only looked at those kerneldoc headers that actually resulted in a complaint from the kerneldoc parser tool. v2: - Actually include the docbook snippet in the right patch. - Fix spelling fail. v3: It's now called drm_crtc_helper_set_mode, spotted by Laurent Pinchart. Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Dave Airlie <airlied@redhat.com>
2012-11-28drm/doc: Helpers are not a Midlayer!Daniel Vetter1-2/+2
I'm devoting all my wrath to that fight, so don't misname it ;-) v2: Make it clear that this section talks about kms helpers. Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Dave Airlie <airlied@redhat.com>
2012-11-20drm: add drm_send_vblank_event() helper (v5)Rob Clark1-15/+5
A helper that drivers can use to send vblank event after a pageflip. If the driver doesn't support proper vblank irq based time/seqn then just pass -1 for the pipe # to get do_gettimestamp() behavior (since there are a lot of drivers that don't use drm_vblank_count_and_time()) Also an internal send_vblank_event() helper for the various other code paths within drm_irq that also need to send vblank events. v1: original v2: add back 'vblwait->reply.sequence = seq' which should not have been deleted v3: add WARN_ON() in case lock is not held and comments v4: use WARN_ON_SMP() instead to fix issue with !SMP && !DEBUG_SPINLOCK as pointed out by Marcin Slusarz v5: update docbook Signed-off-by: Rob Clark <rob@ti.com> Signed-off-by: Dave Airlie <airlied@redhat.com>
2012-08-23Documentation: DocBook DRM framework documentationLaurent Pinchart1-609/+2226
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Rob Clark <rob.clark@linaro.org>
2011-08-29DocBook/drm: Clean up a todo-noteMichael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: `device aware' -> `device-aware'Michael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: `(device|driver) specific' -> `(device|driver)-specific'Michael Witten1-17/+17
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Clean up the paragraph on framebuffer objectsMichael Witten1-8/+6
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use `; otherwise,'Michael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Better flow with `, and then'Michael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Refer to the domain-setting function as a device-specific ioctlMichael Witten1-3/+3
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Improve flow of GPU/CPU coherence sentenceMichael Witten1-2/+3
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use an <itemizelist> for fundamental GEM operationsMichael Witten1-3/+7
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Insert a commaMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use a <variablelist> for vblank ioctlsMichael Witten1-14/+25
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use an itemizedlist for what an encoder needs to provideMichael Witten1-11/+19
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Insert `the' for readability, and change `set' to `setting'Michael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Remove extraneous commasMichael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use a colonMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Clarify `final initialization' via better formattingMichael Witten1-4/+13
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Remove redundancyMichael Witten1-2/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Insert `it' for smooth readingMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: The word `so-called'; I do not think it connotes what you think it connotesMichael Witten1-1/+1
From Webster's Revised Unabridged Dictionary (1913) [web1913]: So-called \So"-called`\, a. So named; called by such a name (but perhaps called thus with doubtful propriety). From WordNet (r) 2.0 [wn]: so-called adj : doubtful or suspect; "these so-called experts are no help" [syn: {alleged(a)}, {supposed}] My strong conviction is that widespread use of 'so gennant' or 'sogennant' in German has led to the creeping misuse of 'so-called' in English (especially through technical writings). In English, it would be better to use: what is called or a better translation of 'so gennant': so named Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use a singular subject for grammatical cleanlinessMichael Witten1-4/+4
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: basic -> coreMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Streamline wording of GEM initializationMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Insert `()' after function nameMichael Witten1-4/+4
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Remove parentheses and unnecessary repetitionMichael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Insert missing commaMichael Witten1-5/+5
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: , -> :Michael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: can -> couldMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Offset modifiers with commasMichael Witten1-4/+4
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use the passive voiceMichael Witten1-3/+3
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: `at driver load time' -> `when the driver is loaded'Michael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: `setup' is the noun; `to set up' is the verbMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Insert missing `an'Michael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Insert missing `that'Michael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Clearer wording with `for consumption by'Michael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Better wordingMichael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Replace the paragraph's first sentence with its last sentenceMichael Witten1-7/+5
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Rearrange wording to make more senseMichael Witten1-3/+3
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Clean up `pre-memory management aware'Michael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Move `should be set' to the beginning of the sentenceMichael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: , -> .Michael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: a -> anMichael Witten1-1/+1
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Use a semicolonMichael Witten1-4/+4
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29DocBook/drm: Clean up code commentMichael Witten1-2/+2
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-25DocBook/drm: can -> mayMichael Witten1-10/+10
Signed-off-by: Michael Witten <mfwitten@gmail.com>