From 69f181177dfc2a123c067070ae0481e669ac1051 Mon Sep 17 00:00:00 2001 From: ivangilmercano Date: Fri, 29 Nov 2024 12:20:25 +0800 Subject: [PATCH] Add README documentation for ADP105x - ADP1051 Signed-off-by: ivangilmercano --- drivers/power/adp1050/README.rst | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/drivers/power/adp1050/README.rst b/drivers/power/adp1050/README.rst index 2d09163e12a..66f0b62e4e7 100644 --- a/drivers/power/adp1050/README.rst +++ b/drivers/power/adp1050/README.rst @@ -1,19 +1,20 @@ -ADP1050 no-OS driver +ADP105x no-OS driver ==================== Supported Devices ----------------- `ADP1050 `_ +`ADP1051 `_ Overview -------- -The ADP1050 is an advanced digital controller with a PMBus™ interface targeting +The ADP1050 and ADP1051 is an advanced digital controller with a PMBus™ interface targeting high density, high efficiency dc-to-dc power conversion. This controller implements voltage mode control with high speed, input voltage feedforward operation for enhanced transient and noise performance. -The ADP1050 has four programmable pulse-width modulation (PWM) outputs capable +ADP1050 and ADP1051 has four programmable pulse-width modulation (PWM) outputs capable of controlling most high efficiency power supply topologies, with the added control of synchronous rectification (SR). @@ -21,6 +22,7 @@ Applications ------------ ADP1050 +ADP1051 ------- * High density, isolated dc-to-dc power supplies @@ -28,7 +30,7 @@ ADP1050 * High availability parallel power systems * Server, storage, industrial, networking, and communications infrastructure -ADP1050 Device Configuration +ADP105x Device Configuration ---------------------------- Driver Initialization @@ -57,7 +59,7 @@ Depending on the resistor divider information a scale is to be set for the VOUT using the **adp1050_vout_scale** API. The VOUT_COMMAND sets the output voltage referrence which commands the PWMs -(actual outputs of the ADP1050), if the voltage sensed by the VS pins is greater +(actual outputs of the ADP105x), if the voltage sensed by the VS pins is greater than VOUT_COMMAND, the PWMs will be set off, regarding the state set by the user. Also the VOUT_MAX value can be changed with the same API, and this applies a limit to the previous mentioned VOUT_COMMAND. The API used for setting these @@ -181,18 +183,19 @@ ADP1050 Driver Initialization Example .flgi_param = NULL, .syni_param = NULL, .on_off_config = ADP1050_ON_OFF_DEFAULT_CFG, + .device_id = ID_ADP1051, }; ret = adp1050_init(&adp1050_desc, &adp1050_ip); if (ret) goto error; -ADP1050 no-OS IIO support +ADP105x no-OS IIO support ------------------------- -The ADP1050 IIO driver comes on top of the ADP1050 driver and offers support +The ADP105x IIO driver comes on top of the ADP105x driver and offers support for interfacing IIO clients through libiio. -ADP1050 IIO Device Configuration +ADP105x IIO Device Configuration -------------------------------- Input Channel Attributes @@ -207,7 +210,7 @@ and each of them has a total of 2 channel attributes: Output Channel Attributes ------------------------- -OUTA/OUTB/SR1/SR2 channels are thee output channels of the ADP1050 IIO device +OUTA/OUTB/OUTC/SR1/SR2 channels are thee output channels of the ADP1050 IIO device and each of them has a total of 7 channel attributes: * ``enable - state of the channel`` @@ -245,8 +248,9 @@ Debug Attributes * ``status_temperature - TEMPERATURE status byte value of the device`` * ``status_cml - CML status byte value of the device`` * ``status_word - Status word value of the device`` +* ``status_iout - IOUT status byte value of the device`` -ADP1050 IIO Driver Initialization Example +ADP105x IIO Driver Initialization Example ----------------------------------------- .. code-block:: bash