diff options
author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-04-15 17:39:27 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-07-15 08:20:24 -0400 |
commit | 2bbbf827d339032dbeda62f0a5f20d2fde07b0f5 (patch) | |
tree | 1a5bf188498e10c4f842e6108fd120f385ac1d06 | |
parent | dc7a12bdfccd94c31f79e294f16f7549bd411b49 (diff) |
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>
-rw-r--r-- | Documentation/memory-devices/ti-emif.rst (renamed from Documentation/memory-devices/ti-emif.txt) | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/Documentation/memory-devices/ti-emif.txt b/Documentation/memory-devices/ti-emif.rst index f4ad9a7d0f4b..c9242294e63c 100644 --- a/Documentation/memory-devices/ti-emif.txt +++ b/Documentation/memory-devices/ti-emif.rst | |||
@@ -1,20 +1,24 @@ | |||
1 | TI EMIF SDRAM Controller Driver: | 1 | :orphan: |
2 | |||
3 | =============================== | ||
4 | TI EMIF SDRAM Controller Driver | ||
5 | =============================== | ||
2 | 6 | ||
3 | Author | 7 | Author |
4 | ======== | 8 | ====== |
5 | Aneesh V <aneesh@ti.com> | 9 | Aneesh V <aneesh@ti.com> |
6 | 10 | ||
7 | Location | 11 | Location |
8 | ============ | 12 | ======== |
9 | driver/memory/emif.c | 13 | driver/memory/emif.c |
10 | 14 | ||
11 | Supported SoCs: | 15 | Supported SoCs: |
12 | =================== | 16 | =============== |
13 | TI OMAP44xx | 17 | TI OMAP44xx |
14 | TI OMAP54xx | 18 | TI OMAP54xx |
15 | 19 | ||
16 | Menuconfig option: | 20 | Menuconfig option: |
17 | ========================== | 21 | ================== |
18 | Device Drivers | 22 | Device Drivers |
19 | Memory devices | 23 | Memory devices |
20 | Texas Instruments EMIF driver | 24 | Texas Instruments EMIF driver |
@@ -29,10 +33,11 @@ functions of the driver includes re-configuring AC timing | |||
29 | parameters and other settings during frequency, voltage and | 33 | parameters and other settings during frequency, voltage and |
30 | temperature changes | 34 | temperature changes |
31 | 35 | ||
32 | Platform Data (see include/linux/platform_data/emif_plat.h): | 36 | Platform Data (see include/linux/platform_data/emif_plat.h) |
33 | ===================================================================== | 37 | =========================================================== |
34 | DDR device details and other board dependent and SoC dependent | 38 | DDR device details and other board dependent and SoC dependent |
35 | information can be passed through platform data (struct emif_platform_data) | 39 | information can be passed through platform data (struct emif_platform_data) |
40 | |||
36 | - DDR device details: 'struct ddr_device_info' | 41 | - DDR device details: 'struct ddr_device_info' |
37 | - Device AC timings: 'struct lpddr2_timings' and 'struct lpddr2_min_tck' | 42 | - Device AC timings: 'struct lpddr2_timings' and 'struct lpddr2_min_tck' |
38 | - Custom configurations: customizable policy options through | 43 | - Custom configurations: customizable policy options through |
@@ -40,17 +45,19 @@ information can be passed through platform data (struct emif_platform_data) | |||
40 | - IP revision | 45 | - IP revision |
41 | - PHY type | 46 | - PHY type |
42 | 47 | ||
43 | Interface to the external world: | 48 | Interface to the external world |
44 | ================================ | 49 | =============================== |
45 | EMIF driver registers notifiers for voltage and frequency changes | 50 | EMIF driver registers notifiers for voltage and frequency changes |
46 | affecting EMIF and takes appropriate actions when these are invoked. | 51 | affecting EMIF and takes appropriate actions when these are invoked. |
52 | |||
47 | - freq_pre_notify_handling() | 53 | - freq_pre_notify_handling() |
48 | - freq_post_notify_handling() | 54 | - freq_post_notify_handling() |
49 | - volt_notify_handling() | 55 | - volt_notify_handling() |
50 | 56 | ||
51 | Debugfs | 57 | Debugfs |
52 | ======== | 58 | ======= |
53 | The driver creates two debugfs entries per device. | 59 | The driver creates two debugfs entries per device. |
60 | |||
54 | - regcache_dump : dump of register values calculated and saved for all | 61 | - regcache_dump : dump of register values calculated and saved for all |
55 | frequencies used so far. | 62 | frequencies used so far. |
56 | - mr4 : last polled value of MR4 register in the LPDDR2 device. MR4 | 63 | - mr4 : last polled value of MR4 register in the LPDDR2 device. MR4 |