Eric Lee / smarc-uboot

Download as
Browse Code ยป

Commit 769c94865a4bb4b86e763ccd2a95c1bb3f0fe837

Authored by Przemyslaw Marczak
Committed by Simon Glass
1 parent e09b2a02d3
Exists in v2017.01-smarct4x and in 35 other branches 8qm-imx_v2020.04_5.4.70_2.3.0, emb_lf_v2022.04, emb_lf_v2023.04, pitx_8mp_lf_v2020.04, smarc-8m-android-10.0.0_2.6.0, smarc-8m-android-11.0.0_2.0.0, smarc-8mp-android-11.0.0_2.0.0, smarc-imx6_v2018.03_4.14.98_2.0.0_ga, smarc-imx7_v2017.03_4.9.11_1.0.0_ga, smarc-imx7_v2018.03_4.14.98_2.0.0_ga, smarc-imx_v2017.03_4.9.11_1.0.0_ga, smarc-imx_v2017.03_4.9.88_2.0.0_ga, smarc-imx_v2017.03_o8.1.0_1.3.0_8m, smarc-imx_v2018.03_4.14.78_1.0.0_ga, smarc-n7.1.2_2.0.0-ga, smarc-rel_imx_4.1.15_2.0.0_ga, smarc_8m-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8m-imx_v2019.04_4.19.35_1.1.0, smarc_8m_00d0-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8mm-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8mm-imx_v2019.04_4.19.35_1.1.0, smarc_8mm-imx_v2020.04_5.4.24_2.1.0, smarc_8mp_lf_v2020.04, smarc_8mq-imx_v2020.04_5.4.24_2.1.0, smarc_8mq_lf_v2020.04, ti-u-boot-2015.07, v2015.07-smarct33, v2015.07-smarct33-emmc, v2015.07-smarct4x, v2016.05-dlt, v2016.05-smarct3x, v2016.05-smarct3x-emmc, v2016.05-smarct4x, v2017.01-smarct3x, v2017.01-smarct3x-emmc

doc: driver-model: pmic-framework.txt - cleanup 

This commit cleanups the PMIC framework documentation.

Signed-off-by: Przemyslaw Marczak <p.marczak@samsung.com>
Acked-by: Simon Glass <sjg@chromium.org>
Tested on sandbox:
Tested-by: Simon Glass <sjg@chromium.org>

Showing 1 changed file with 9 additions and 11 deletions Side-by-side Diff

doc/driver-model/pmic-framework.txt
Diff comments   View file @ 769c948
... ... @@ -79,7 +79,7 @@
79 79  
80 80 3. Pmic uclass
81 81 ==============
82   -The basic informations:
  82 +The basic information:
83 83 * Uclass: 'UCLASS_PMIC'
84 84 * Header: 'include/power/pmic.h'
85 85 * Core: 'drivers/power/pmic/pmic-uclass.c'
86 86  
... ... @@ -88,14 +88,13 @@
88 88 config: 'CONFIG_CMD_PMIC'
89 89 * Example: 'drivers/power/pmic/max77686.c'
90 90  
91   -This is still under the construction. So for the API description, please refer
92   -to the header file.
  91 +For detailed API description, please refer to the header file.
93 92  
94 93 As an example of the pmic driver, please refer to the MAX77686 driver.
95 94  
96   -Please pay attention for the driver's '.bind' method. Exactly the function call:
97   -'pmic_bind_childs()', which is used to bind the regulators by using the array of
98   -regulator's node, compatible prefixes.
  95 +Please pay attention for the driver's bind() method. Exactly the function call:
  96 +'pmic_bind_children()', which is used to bind the regulators by using the array
  97 +of regulator's node, compatible prefixes.
99 98  
100 99 The 'pmic; command also supports the new API. So the pmic command can be enabled
101 100 by adding CONFIG_CMD_PMIC.
102 101  
... ... @@ -108,11 +107,11 @@
108 107 This command can use only UCLASS_PMIC devices, since this uclass is designed
109 108 for pmic I/O operations only.
110 109  
111   -For more informations, please refer to the file: 'common/cmd_pmic.c'.
  110 +For more information, please refer to the core file.
112 111  
113 112 4. Regulator uclass
114 113 ===================
115   -The basic informations:
  114 +The basic information:
116 115 * Uclass: 'UCLASS_REGULATOR'
117 116 * Header: 'include/power/regulator.h'
118 117 * Core: 'drivers/power/regulator/regulator-uclass.c'
... ... @@ -125,8 +124,7 @@
125 124 * Example: 'drivers/power/regulator/fixed.c'
126 125 config" 'CONFIG_DM_REGULATOR_FIXED'
127 126  
128   -This is still under the construction. So for the API description, please refer
129   -to the header file.
  127 +For detailed API description, please refer to the header file.
130 128  
131 129 For the example regulator driver, please refer to the MAX77686 regulator driver,
132 130 but this driver can't operate without pmic's example driver, which provides an
... ... @@ -139,5 +137,5 @@
139 137 - choose the current device (like the mmc command)
140 138 - do all regulator-specific operations
141 139  
142   -For more informations, please refer to the file: 'common/cmd_regulator.c'
  140 +For more information, please refer to the command file.