Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

apple-gmux: Sphinxify docs

Convert asciidoc-formatted docs to rst in accordance with Jonathan's and
Jani's effort to use sphinx for kernel-doc rendering in 4.8.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Lukas Wunner <lukas@wunner.de>
Acked-by: Darren Hart <dvhart@linux.intel.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/4c1b29986fa77772156b1af0c965d3799e43a47b.1467628307.git.lukas@wunner.de

authored by

Lukas Wunner and committed by
Daniel Vetter
305964b7 3c31760e

+29 -26
+29 -26
drivers/platform/x86/apple-gmux.c
··· 31 31 /** 32 32 * DOC: Overview 33 33 * 34 - * :1: http://www.latticesemi.com/en/Products/FPGAandCPLD/LatticeXP2.aspx 35 - * :2: http://www.renesas.com/products/mpumcu/h8s/h8s2100/h8s2113/index.jsp 36 - * 37 34 * gmux is a microcontroller built into the MacBook Pro to support dual GPUs: 38 - * A {1}[Lattice XP2] on pre-retinas, a {2}[Renesas R4F2113] on retinas. 35 + * A `Lattice XP2`_ on pre-retinas, a `Renesas R4F2113`_ on retinas. 39 36 * 40 37 * (The MacPro6,1 2013 also has a gmux, however it is unclear why since it has 41 38 * dual GPUs but no built-in display.) 42 39 * 43 40 * gmux is connected to the LPC bus of the southbridge. Its I/O ports are 44 41 * accessed differently depending on the microcontroller: Driver functions 45 - * to access a pre-retina gmux are infixed `_pio_`, those for a retina gmux 46 - * are infixed `_index_`. 42 + * to access a pre-retina gmux are infixed ``_pio_``, those for a retina gmux 43 + * are infixed ``_index_``. 44 + * 45 + * .. _Lattice XP2: 46 + * http://www.latticesemi.com/en/Products/FPGAandCPLD/LatticeXP2.aspx 47 + * .. _Renesas R4F2113: 48 + * http://www.renesas.com/products/mpumcu/h8s/h8s2100/h8s2113/index.jsp 47 49 */ 48 50 49 51 struct apple_gmux_data { ··· 274 272 /** 275 273 * DOC: Backlight control 276 274 * 277 - * :3: http://www.ti.com/lit/ds/symlink/lp8543.pdf 278 - * :4: http://www.ti.com/lit/ds/symlink/lp8545.pdf 279 - * 280 275 * On single GPU MacBooks, the PWM signal for the backlight is generated by 281 276 * the GPU. On dual GPU MacBook Pros by contrast, either GPU may be suspended 282 277 * to conserve energy. Hence the PWM signal needs to be generated by a separate 283 278 * backlight driver which is controlled by gmux. The earliest generation 284 - * MBP5 2008/09 uses a {3}[TI LP8543] backlight driver. All newer models 285 - * use a {4}[TI LP8545]. 279 + * MBP5 2008/09 uses a `TI LP8543`_ backlight driver. All newer models 280 + * use a `TI LP8545`_. 281 + * 282 + * .. _TI LP8543: http://www.ti.com/lit/ds/symlink/lp8543.pdf 283 + * .. _TI LP8545: http://www.ti.com/lit/ds/symlink/lp8545.pdf 286 284 */ 287 285 288 286 static int gmux_get_brightness(struct backlight_device *bd) ··· 314 312 /** 315 313 * DOC: Graphics mux 316 314 * 317 - * :5: http://pimg-fpiw.uspto.gov/fdd/07/870/086/0.pdf 318 - * :6: http://www.nxp.com/documents/data_sheet/CBTL06141.pdf 319 - * :7: http://www.ti.com/lit/ds/symlink/hd3ss212.pdf 320 - * :8: https://www.pericom.com/assets/Datasheets/PI3VDP12412.pdf 321 - * :9: http://www.ti.com/lit/ds/symlink/sn74lv4066a.pdf 322 - * :10: http://pdf.datasheetarchive.com/indexerfiles/Datasheets-SW16/DSASW00308511.pdf 323 - * :11: http://www.ti.com/lit/ds/symlink/ts3ds10224.pdf 324 - * 325 315 * On pre-retinas, the LVDS outputs of both GPUs feed into gmux which muxes 326 316 * either of them to the panel. One of the tricks gmux has up its sleeve is 327 317 * to lengthen the blanking interval of its output during a switch to 328 318 * synchronize it with the GPU switched to. This allows for a flicker-free 329 - * switch that is imperceptible by the user ({5}[US 8,687,007 B2]). 319 + * switch that is imperceptible by the user (`US 8,687,007 B2`_). 330 320 * 331 321 * On retinas, muxing is no longer done by gmux itself, but by a separate 332 322 * chip which is controlled by gmux. The chip is triple sourced, it is 333 - * either an {6}[NXP CBTL06142], {7}[TI HD3SS212] or {8}[Pericom PI3VDP12412]. 323 + * either an `NXP CBTL06142`_, `TI HD3SS212`_ or `Pericom PI3VDP12412`_. 334 324 * The panel is driven with eDP instead of LVDS since the pixel clock 335 325 * required for retina resolution exceeds LVDS' limits. 336 326 * 337 327 * Pre-retinas are able to switch the panel's DDC pins separately. 338 - * This is handled by a {9}[TI SN74LV4066A] which is controlled by gmux. 328 + * This is handled by a `TI SN74LV4066A`_ which is controlled by gmux. 339 329 * The inactive GPU can thus probe the panel's EDID without switching over 340 330 * the entire panel. Retinas lack this functionality as the chips used for 341 331 * eDP muxing are incapable of switching the AUX channel separately (see ··· 338 344 * 339 345 * The external DP port is only fully switchable on the first two unibody 340 346 * MacBook Pro generations, MBP5 2008/09 and MBP6 2010. This is done by an 341 - * {6}[NXP CBTL06141] which is controlled by gmux. It's the predecessor of the 347 + * `NXP CBTL06141`_ which is controlled by gmux. It's the predecessor of the 342 348 * eDP mux on retinas, the difference being support for 2.7 versus 5.4 Gbit/s. 343 349 * 344 350 * The following MacBook Pro generations replaced the external DP port with a 345 351 * combined DP/Thunderbolt port and lost the ability to switch it between GPUs, 346 352 * connecting it either to the discrete GPU or the Thunderbolt controller. 347 353 * Oddly enough, while the full port is no longer switchable, AUX and HPD 348 - * are still switchable by way of an {10}[NXP CBTL03062] (on pre-retinas 349 - * MBP8 2011 and MBP9 2012) or two {11}[TI TS3DS10224] (on retinas) under the 354 + * are still switchable by way of an `NXP CBTL03062`_ (on pre-retinas 355 + * MBP8 2011 and MBP9 2012) or two `TI TS3DS10224`_ (on retinas) under the 350 356 * control of gmux. Since the integrated GPU is missing the main link, 351 357 * external displays appear to it as phantoms which fail to link-train. 352 358 * ··· 359 365 * of this feature. 360 366 * 361 367 * gmux' initial switch state on bootup is user configurable via the EFI 362 - * variable `gpu-power-prefs-fa4ce28d-b62f-4c99-9cc3-6815686e30f9` (5th byte, 368 + * variable ``gpu-power-prefs-fa4ce28d-b62f-4c99-9cc3-6815686e30f9`` (5th byte, 363 369 * 1 = IGD, 0 = DIS). Based on this setting, the EFI firmware tells gmux to 364 370 * switch the panel and the external DP connector and allocates a framebuffer 365 371 * for the selected GPU. 372 + * 373 + * .. _US 8,687,007 B2: http://pimg-fpiw.uspto.gov/fdd/07/870/086/0.pdf 374 + * .. _NXP CBTL06141: http://www.nxp.com/documents/data_sheet/CBTL06141.pdf 375 + * .. _NXP CBTL06142: http://www.nxp.com/documents/data_sheet/CBTL06141.pdf 376 + * .. _TI HD3SS212: http://www.ti.com/lit/ds/symlink/hd3ss212.pdf 377 + * .. _Pericom PI3VDP12412: https://www.pericom.com/assets/Datasheets/PI3VDP12412.pdf 378 + * .. _TI SN74LV4066A: http://www.ti.com/lit/ds/symlink/sn74lv4066a.pdf 379 + * .. _NXP CBTL03062: http://pdf.datasheetarchive.com/indexerfiles/Datasheets-SW16/DSASW00308511.pdf 380 + * .. _TI TS3DS10224: http://www.ti.com/lit/ds/symlink/ts3ds10224.pdf 366 381 */ 367 382 368 383 static void gmux_read_switch_state(struct apple_gmux_data *gmux_data)