aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/drm.tmpl (follow)
AgeCommit message (Collapse)AuthorFilesLines
2013-02-24Merge branch 'drm/hdmi-for-3.9' of git://anongit.freedesktop.org/tegra/linux into drm-nextDave Airlie1-0/+4
Thierry writes: "Remove a duplicate implementation of the CEA VIC lookup and move the CEA and other mode tables to drm_edid.c to make it more difficult to create duplicates of the tables. Add some helpers to pack CEA-861/HDMI AVI, audio and SPD infoframes into binary buffers that can easily be written into hardware registers. A new helper function makes it easy construct an AVI infoframe from a DRM display mode. Convert the Tegra and Radeon drivers to use the new HDMI helpers." * 'drm/hdmi-for-3.9' of git://anongit.freedesktop.org/tegra/linux: drm/radeon: Use generic HDMI infoframe helpers drm/tegra: Use generic HDMI infoframe helpers drm: Add EDID helper documentation drm: Add HDMI infoframe helpers video: Add generic HDMI infoframe helpers drm: Add some missing forward declarations drm: Move mode tables to drm_edid.c drm: Remove duplicate drm_mode_cea_vic()
2013-02-22drm: Add consistency check for page-flippingThierry Reding1-0/+6
Driver implementations of the drm_crtc's .page_flip() function are required to update the crtc->fb field on success to reflect that the new framebuffer is now in use. This is important to keep reference counting on the framebuffers balanced. While at it, document this requirement to keep others from falling into the same trap. Suggested-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Thierry Reding <thierry.reding@avionic-design.de> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
2013-02-22drm: Add EDID helper documentationThierry Reding1-0/+4
Add a reference section about the EDID helper functions to the DRM documentation. Signed-off-by: Thierry Reding <thierry.reding@avionic-design.de> Reviewed-by: Alex Deucher <alexander.deucher@amd.com>
2013-02-14drm/fb-helper: improve kerneldocDaniel Vetter1-0/+1
Now that the fbdev helper interface for drivers is trimmed down, update the kerneldoc for all the remaining exported functions. I've tried to beat the DocBook a bit by reordering the function references a bit into a more sensible ordering. But that didn't work out at all. Hence just extend the in-code DOC: section a bit. Also remove the LOCKING: sections - especially for the setup functions they're totally bogus. But that's not a documentation problem, but simply an artifact of the current rather hazardous locking around drm init and even more so around fbdev setup ... v2: Some further improvements: - Also add documentation for drm_fb_helper_single_add_all_connectors, Dave Airlie didn't want me to kill this one from the fb helper interface. - Update docs for drm_fb_helper_fill_var/fix - they should be used from the driver's ->fb_probe callback to setup the fbdev info structure. - Clarify what the ->fb_probe callback should all do - it needs to setup both the fbdev info and allocate the drm framebuffer used as backing storage. - Add basic documentaation for the drm_fb_helper_funcs driver callback vfunc. v3: Implement clarifications Laurent Pinchart suggested in his review. v4: Fix another mispelling Laurent spotted. Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
2013-02-08drm: add prime helpersAaron Plattner1-0/+4
Instead of reimplementing all of the dma_buf functionality in every driver, create helpers drm_prime_import and drm_prime_export that implement them in terms of new, lower-level hook functions: gem_prime_pin: callback when a buffer is created, used to pin buffers into GTT gem_prime_get_sg_table: convert a drm_gem_object to an sg_table for export gem_prime_import_sg_table: convert an sg_table into a drm_gem_object gem_prime_vmap, gem_prime_vunmap: map and unmap an object These hooks are optional; drivers can opt in by using drm_gem_prime_import and drm_gem_prime_export as the .gem_prime_import and .gem_prime_export fields of struct drm_driver. v2: - Drop .begin_cpu_access. None of the drivers this code replaces implemented it. Having it here was a leftover from when I was trying to include i915 in this rework. - Use mutex_lock instead of mutex_lock_interruptible, as these three drivers did. This patch series shouldn't change that behavior. - Rename helpers to gem_prime_get_sg_table and gem_prime_import_sg_table. Rename struct sg_table* variables to 'sgt' for clarity. - Update drm.tmpl for these new hooks. v3: - Pass the vaddr down to the driver. This lets drivers that just call vunmap on the pointer avoid having to store the pointer in their GEM private structures. - Move documentation into a /** DOC */ comment in drm_prime.c and include it in drm.tmpl with a !P line. I tried to use !F lines to include documentation of the individual functions from drmP.h, but the docproc / kernel-doc scripts barf on that file, so hopefully this is good enough for now. - apply refcount fix from commit be8a42ae60addd8b6092535c11b42d099d6470ec ("drm/prime: drop reference on imported dma-buf come from gem") Signed-off-by: Aaron Plattner <aplattner@nvidia.com> Cc: Daniel Vetter <daniel.vetter@ffwll.ch> Cc: David Airlie <airlied@linux.ie> Signed-off-by: Dave Airlie <airlied@redhat.com>
2013-01-20drm/doc: updates for new framebuffer lifetime rulesDaniel Vetter1-14/+45
Now that framebuffer are reference-counted for all use-sites, update the documentation accordingly to stress the new rules for initialization and teardown. Also add a short paragraph about the implications for drivers of the new locking rules. Reviewed-by: Rob Clark <rob@ti.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
2013-01-20drm/doc: integrate drm_crtc.c kerneldocDaniel Vetter1-0/+4
And do a quick pass to adjust them to the last few (years?) of changes ... This time actually compile-tested ;-) Reviewed-by: Rob Clark <rob@ti.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
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>
Copyright © 1996 – 2023 Jason A. Donenfeld. All Rights Reverse Engineered.