docs: memory-devices: convert ti-emif.txt to ReST

Prepare this file to be moved to a kernel book by converting
it to ReST format and renaming it to ti-emif.rst.

While this is not part of any book, mark it as :orphan:, in order
to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2019-04-15 18:39:27 -03:00
parent dc7a12bdfc
commit 2bbbf827d3

View File

@ -1,20 +1,24 @@
TI EMIF SDRAM Controller Driver: :orphan:
===============================
TI EMIF SDRAM Controller Driver
===============================
Author Author
======== ======
Aneesh V <aneesh@ti.com> Aneesh V <aneesh@ti.com>
Location Location
============ ========
driver/memory/emif.c driver/memory/emif.c
Supported SoCs: Supported SoCs:
=================== ===============
TI OMAP44xx TI OMAP44xx
TI OMAP54xx TI OMAP54xx
Menuconfig option: Menuconfig option:
========================== ==================
Device Drivers Device Drivers
Memory devices Memory devices
Texas Instruments EMIF driver Texas Instruments EMIF driver
@ -29,10 +33,11 @@ functions of the driver includes re-configuring AC timing
parameters and other settings during frequency, voltage and parameters and other settings during frequency, voltage and
temperature changes temperature changes
Platform Data (see include/linux/platform_data/emif_plat.h): Platform Data (see include/linux/platform_data/emif_plat.h)
===================================================================== ===========================================================
DDR device details and other board dependent and SoC dependent DDR device details and other board dependent and SoC dependent
information can be passed through platform data (struct emif_platform_data) information can be passed through platform data (struct emif_platform_data)
- DDR device details: 'struct ddr_device_info' - DDR device details: 'struct ddr_device_info'
- Device AC timings: 'struct lpddr2_timings' and 'struct lpddr2_min_tck' - Device AC timings: 'struct lpddr2_timings' and 'struct lpddr2_min_tck'
- Custom configurations: customizable policy options through - Custom configurations: customizable policy options through
@ -40,17 +45,19 @@ information can be passed through platform data (struct emif_platform_data)
- IP revision - IP revision
- PHY type - PHY type
Interface to the external world: Interface to the external world
================================ ===============================
EMIF driver registers notifiers for voltage and frequency changes EMIF driver registers notifiers for voltage and frequency changes
affecting EMIF and takes appropriate actions when these are invoked. affecting EMIF and takes appropriate actions when these are invoked.
- freq_pre_notify_handling() - freq_pre_notify_handling()
- freq_post_notify_handling() - freq_post_notify_handling()
- volt_notify_handling() - volt_notify_handling()
Debugfs Debugfs
======== =======
The driver creates two debugfs entries per device. The driver creates two debugfs entries per device.
- regcache_dump : dump of register values calculated and saved for all - regcache_dump : dump of register values calculated and saved for all
frequencies used so far. frequencies used so far.
- mr4 : last polled value of MR4 register in the LPDDR2 device. MR4 - mr4 : last polled value of MR4 register in the LPDDR2 device. MR4