[PATCH 52/57] docs: memory-devices: convert ti-emif.txt to ReST format

Mauro Carvalho Chehab
2019-04-16T03:02:29Z

Prepare this file to be moved to a kernel book by converting
it to ReST format.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/bus-devices/ti-gpmc.txt | 1 +
Documentation/memory-devices/ti-emif.txt | 25 ++++++++++++++----------
2 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/Documentation/bus-devices/ti-gpmc.txt b/Documentation/bus-devices/ti-gpmc.txt
index cc9ce57e0a26..c434fcfc5e4c 100644
--- a/Documentation/bus-devices/ti-gpmc.txt
+++ b/Documentation/bus-devices/ti-gpmc.txt
@@ -3,6 +3,7 @@ GPMC (General Purpose Memory Controller):

GPMC is an unified memory controller dedicated to interfacing external
memory devices like
+
* Asynchronous SRAM like memories and application specific integrated
circuit devices.
* Asynchronous, synchronous, and page mode burst NOR flash devices
diff --git a/Documentation/memory-devices/ti-emif.txt b/Documentation/memory-devices/ti-emif.txt
index f4ad9a7d0f4b..371f581bd276 100644
--- a/Documentation/memory-devices/ti-emif.txt
+++ b/Documentation/memory-devices/ti-emif.txt
@@ -1,20 +1,22 @@
-TI EMIF SDRAM Controller Driver:
+===============================
+TI EMIF SDRAM Controller Driver
+===============================

Author
-========
+======
Aneesh V <aneesh@ti.com>

Location
-============
+========
driver/memory/emif.c

Supported SoCs:
-===================
+===============
TI OMAP44xx
TI OMAP54xx

Menuconfig option:
-==========================
+==================
Device Drivers
Memory devices
Texas Instruments EMIF driver
@@ -29,10 +31,11 @@ functions of the driver includes re-configuring AC timing
parameters and other settings during frequency, voltage and
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
information can be passed through platform data (struct emif_platform_data)
+
- DDR device details: 'struct ddr_device_info'
- Device AC timings: 'struct lpddr2_timings' and 'struct lpddr2_min_tck'
- Custom configurations: customizable policy options through
@@ -40,17 +43,19 @@ information can be passed through platform data (struct emif_platform_data)
- IP revision
- PHY type

-Interface to the external world:
-================================
+Interface to the external world
+===============================
EMIF driver registers notifiers for voltage and frequency changes
affecting EMIF and takes appropriate actions when these are invoked.
+
- freq_pre_notify_handling()
- freq_post_notify_handling()
- volt_notify_handling()

Debugfs
-========
+=======
The driver creates two debugfs entries per device.
+
- regcache_dump : dump of register values calculated and saved for all
frequencies used so far.
- mr4 : last polled value of MR4 register in the LPDDR2 device. MR4
--
2.20.1