diff options
author | Michael Witten <mfwitten@gmail.com> | 2011-08-29 14:05:52 -0400 |
---|---|---|
committer | Michael Witten <mfwitten@gmail.com> | 2011-08-29 16:00:33 -0400 |
commit | a5294e01f2777649834d218583e7a32b2dacb699 (patch) | |
tree | 267a6250b2bc562930d2cc1079a035bb1a600f54 /Documentation/DocBook | |
parent | 5a462d58c84a2f5ed161daced2c7df34357c6d3d (diff) |
DocBook/drm: `(device|driver) specific' -> `(device|driver)-specific'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/drm.tmpl | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index a39e76bae03d..65e14f96f943 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl | |||
@@ -238,7 +238,7 @@ | |||
238 | </variablelist> | 238 | </variablelist> |
239 | <para> | 239 | <para> |
240 | In this specific case, the driver requires AGP and supports | 240 | In this specific case, the driver requires AGP and supports |
241 | IRQs. DMA, as discussed later, is handled by device specific ioctls | 241 | IRQs. DMA, as discussed later, is handled by device-specific ioctls |
242 | in this case. It also supports the kernel mode setting APIs, though | 242 | in this case. It also supports the kernel mode setting APIs, though |
243 | unlike in the actual i915 driver source, this example unconditionally | 243 | unlike in the actual i915 driver source, this example unconditionally |
244 | exports KMS capability. | 244 | exports KMS capability. |
@@ -277,7 +277,7 @@ | |||
277 | to perform output discovery & configuration at load time. | 277 | to perform output discovery & configuration at load time. |
278 | Likewise, if user-level drivers unaware of memory management are | 278 | Likewise, if user-level drivers unaware of memory management are |
279 | in use, memory management and command buffer setup may need to | 279 | in use, memory management and command buffer setup may need to |
280 | be omitted. These requirements are driver specific, and care | 280 | be omitted. These requirements are driver-specific, and care |
281 | needs to be taken to keep both old and new applications and | 281 | needs to be taken to keep both old and new applications and |
282 | libraries working. The i915 driver supports the "modeset" | 282 | libraries working. The i915 driver supports the "modeset" |
283 | module parameter to control whether advanced features are | 283 | module parameter to control whether advanced features are |
@@ -288,7 +288,7 @@ | |||
288 | <title>Driver private & performance counters</title> | 288 | <title>Driver private & performance counters</title> |
289 | <para> | 289 | <para> |
290 | The driver private hangs off the main drm_device structure and | 290 | The driver private hangs off the main drm_device structure and |
291 | can be used for tracking various device specific bits of | 291 | can be used for tracking various device-specific bits of |
292 | information, like register offsets, command buffer status, | 292 | information, like register offsets, command buffer status, |
293 | register state for suspend/resume, etc. At load time, a | 293 | register state for suspend/resume, etc. At load time, a |
294 | driver may simply allocate one and set drm_device.dev_priv | 294 | driver may simply allocate one and set drm_device.dev_priv |
@@ -313,7 +313,7 @@ | |||
313 | <sect2> | 313 | <sect2> |
314 | <title>Configuring the device</title> | 314 | <title>Configuring the device</title> |
315 | <para> | 315 | <para> |
316 | Obviously, device configuration is device specific. | 316 | Obviously, device configuration is device-specific. |
317 | However, there are several common operations: finding a | 317 | However, there are several common operations: finding a |
318 | device's PCI resources, mapping them, and potentially setting | 318 | device's PCI resources, mapping them, and potentially setting |
319 | up an IRQ handler. | 319 | up an IRQ handler. |
@@ -340,8 +340,8 @@ | |||
340 | <para> | 340 | <para> |
341 | Once you have a register map, you may use the DRM_READn() and | 341 | Once you have a register map, you may use the DRM_READn() and |
342 | DRM_WRITEn() macros to access the registers on your device, or | 342 | DRM_WRITEn() macros to access the registers on your device, or |
343 | use driver specific versions to offset into your MMIO space | 343 | use driver-specific versions to offset into your MMIO space |
344 | relative to a driver specific base pointer (see I915_READ for | 344 | relative to a driver-specific base pointer (see I915_READ for |
345 | an example). | 345 | an example). |
346 | </para> | 346 | </para> |
347 | <para> | 347 | <para> |
@@ -399,7 +399,7 @@ | |||
399 | and devices with dedicated video RAM (VRAM), i.e. most discrete | 399 | and devices with dedicated video RAM (VRAM), i.e. most discrete |
400 | graphics devices. If your device has dedicated RAM, supporting | 400 | graphics devices. If your device has dedicated RAM, supporting |
401 | TTM is desirable. TTM also integrates tightly with your | 401 | TTM is desirable. TTM also integrates tightly with your |
402 | driver specific buffer execution function. See the radeon | 402 | driver-specific buffer execution function. See the radeon |
403 | driver for examples. | 403 | driver for examples. |
404 | </para> | 404 | </para> |
405 | <para> | 405 | <para> |
@@ -427,7 +427,7 @@ | |||
427 | created by the memory manager at runtime. Your global TTM should | 427 | created by the memory manager at runtime. Your global TTM should |
428 | have a type of TTM_GLOBAL_TTM_MEM. The size field for the global | 428 | have a type of TTM_GLOBAL_TTM_MEM. The size field for the global |
429 | object should be sizeof(struct ttm_mem_global), and the init and | 429 | object should be sizeof(struct ttm_mem_global), and the init and |
430 | release hooks should point at your driver specific init and | 430 | release hooks should point at your driver-specific init and |
431 | release routines, which probably eventually call | 431 | release routines, which probably eventually call |
432 | ttm_mem_global_init and ttm_mem_global_release, respectively. | 432 | ttm_mem_global_init and ttm_mem_global_release, respectively. |
433 | </para> | 433 | </para> |
@@ -438,7 +438,7 @@ | |||
438 | provide a pool for buffer object allocation by clients and the | 438 | provide a pool for buffer object allocation by clients and the |
439 | kernel itself. The type of this object should be TTM_GLOBAL_TTM_BO, | 439 | kernel itself. The type of this object should be TTM_GLOBAL_TTM_BO, |
440 | and its size should be sizeof(struct ttm_bo_global). Again, | 440 | and its size should be sizeof(struct ttm_bo_global). Again, |
441 | driver specific init and release functions may be provided, | 441 | driver-specific init and release functions may be provided, |
442 | likely eventually calling ttm_bo_global_init() and | 442 | likely eventually calling ttm_bo_global_init() and |
443 | ttm_bo_global_release(), respectively. Also, like the previous | 443 | ttm_bo_global_release(), respectively. Also, like the previous |
444 | object, ttm_global_item_ref() is used to create an initial reference | 444 | object, ttm_global_item_ref() is used to create an initial reference |
@@ -462,7 +462,7 @@ | |||
462 | be initialized separately into its own DRM MM object. | 462 | be initialized separately into its own DRM MM object. |
463 | </para> | 463 | </para> |
464 | <para> | 464 | <para> |
465 | Initialization is driver specific. In the case of Intel | 465 | Initialization is driver-specific. In the case of Intel |
466 | integrated graphics chips like 965GM, GEM initialization can | 466 | integrated graphics chips like 965GM, GEM initialization can |
467 | be done by calling the internal GEM init function, | 467 | be done by calling the internal GEM init function, |
468 | i915_gem_do_init(). Since the 965GM is a UMA device | 468 | i915_gem_do_init(). Since the 965GM is a UMA device |
@@ -561,8 +561,8 @@ void intel_crt_init(struct drm_device *dev) | |||
561 | </programlisting> | 561 | </programlisting> |
562 | <para> | 562 | <para> |
563 | In the example above (again, taken from the i915 driver), a | 563 | In the example above (again, taken from the i915 driver), a |
564 | CRT connector and encoder combination is created. A device | 564 | CRT connector and encoder combination is created. A device-specific |
565 | specific i2c bus is also created for fetching EDID data and | 565 | i2c bus is also created for fetching EDID data and |
566 | performing monitor detection. Once the process is complete, | 566 | performing monitor detection. Once the process is complete, |
567 | the new connector is registered with sysfs to make its | 567 | the new connector is registered with sysfs to make its |
568 | properties available to applications. | 568 | properties available to applications. |
@@ -704,8 +704,8 @@ void intel_crt_init(struct drm_device *dev) | |||
704 | <para> | 704 | <para> |
705 | GEM-enabled drivers must provide gem_init_object() and | 705 | GEM-enabled drivers must provide gem_init_object() and |
706 | gem_free_object() callbacks to support the core memory | 706 | gem_free_object() callbacks to support the core memory |
707 | allocation routines. They should also provide several driver | 707 | allocation routines. They should also provide several driver-specific |
708 | specific ioctls to support command execution, pinning, buffer | 708 | ioctls to support command execution, pinning, buffer |
709 | read & write, mapping, and domain ownership transfers. | 709 | read & write, mapping, and domain ownership transfers. |
710 | </para> | 710 | </para> |
711 | <para> | 711 | <para> |
@@ -797,7 +797,7 @@ void intel_crt_init(struct drm_device *dev) | |||
797 | <para> | 797 | <para> |
798 | Clients need to provide a framebuffer object which provides a source | 798 | Clients need to provide a framebuffer object which provides a source |
799 | of pixels for a CRTC to deliver to the encoder(s) and ultimately the | 799 | of pixels for a CRTC to deliver to the encoder(s) and ultimately the |
800 | connector(s). A framebuffer is fundamentally a driver specific memory | 800 | connector(s). A framebuffer is fundamentally a driver-specific memory |
801 | object, made into an opaque handle by the DRM's addfb() function. | 801 | object, made into an opaque handle by the DRM's addfb() function. |
802 | Once a framebuffer has been created this way, it may be passed to the | 802 | Once a framebuffer has been created this way, it may be passed to the |
803 | KMS mode setting routines for use in a completed configuration. | 803 | KMS mode setting routines for use in a completed configuration. |
@@ -807,7 +807,7 @@ void intel_crt_init(struct drm_device *dev) | |||
807 | <sect1> | 807 | <sect1> |
808 | <title>Command submission & fencing</title> | 808 | <title>Command submission & fencing</title> |
809 | <para> | 809 | <para> |
810 | This should cover a few device specific command submission | 810 | This should cover a few device-specific command submission |
811 | implementations. | 811 | implementations. |
812 | </para> | 812 | </para> |
813 | </sect1> | 813 | </sect1> |
@@ -840,7 +840,7 @@ void intel_crt_init(struct drm_device *dev) | |||
840 | <para> | 840 | <para> |
841 | The DRM core exports several interfaces to applications, | 841 | The DRM core exports several interfaces to applications, |
842 | generally intended to be used through corresponding libdrm | 842 | generally intended to be used through corresponding libdrm |
843 | wrapper functions. In addition, drivers export device specific | 843 | wrapper functions. In addition, drivers export device-specific |
844 | interfaces for use by userspace drivers & device aware | 844 | interfaces for use by userspace drivers & device aware |
845 | applications through ioctls and sysfs files. | 845 | applications through ioctls and sysfs files. |
846 | </para> | 846 | </para> |