diff --git a/doc/sphinx/source/projects/ltc7841.rst b/doc/sphinx/source/projects/ltc7841.rst new file mode 100644 index 00000000000..f16ce42f7ba --- /dev/null +++ b/doc/sphinx/source/projects/ltc7841.rst @@ -0,0 +1 @@ +.. include:: ../../../../projects/ltc7841/README.rst \ No newline at end of file diff --git a/doc/sphinx/source/projects_doc.rst b/doc/sphinx/source/projects_doc.rst index c70368033d9..c5e9ba4127a 100644 --- a/doc/sphinx/source/projects_doc.rst +++ b/doc/sphinx/source/projects_doc.rst @@ -74,6 +74,7 @@ POWER MANAGEMENT projects/dc2703a projects/ltc4162l projects/ltc4296 + projects/ltc7841 projects/ltm4686 projects/lt7170 projects/lt7182s diff --git a/projects/ltc7841/README.rst b/projects/ltc7841/README.rst new file mode 100644 index 00000000000..107b1aab36e --- /dev/null +++ b/projects/ltc7841/README.rst @@ -0,0 +1,124 @@ +Evaluating the LTC7841 +====================== + +.. contents:: + :depth: 3 + +Supported Evaluation Boards +--------------------------- + +* `DC2798A `_ + +Overview +-------- + +The evaluation board includes 2 LTC7841 to be powered up with writing to the MFR_VOUT_COMMAND a non-zero value. +To turn-on the evaluation board, write 0x80 to the OPERATION register and ensure that the MFR_VOUT_COMMAND is actually +non-zero value. + +Full performance details are provided in the LTC7841 data sheet, which should +be consulted in conjunction with user guide. + +Hardware Specifications +----------------------- + +Power Supply Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^ + +For this specific project an external power supply with a variable output of 10-16 Volts +must be used to power up the demo board. + +**Hardware Bringup** + +For reference, follow the Quick Start Procedure section of the corresponding +demo board. +`user guide `_. + +No-OS Build Setup +----------------- + +Please see: https://wiki.analog.com/resources/no-os/build + +No-OS Supported Examples +------------------------ + +The initialization data used in the examples is taken out from: +`Project Common Data Path `_ + +The macros used in Common Data are defined in platform specific files found in: +`Project Platform Configuration Path `_ + +Basic example +^^^^^^^^^^^^^ + +This is a simple example that initializes the LTC7841, and performs telemetry +readings of the voltage, current and temperature of each output channel. Status +bytes/words are also monitored in the example. + +In order to build the basic example make sure you are using this command: + +.. code-block:: bash + + make EXAMPLE=basic + +IIO example +^^^^^^^^^^^ + +This project is actually a IIOD demo for DC2798-A evaluation board. +The project launches a IIOD server on the board so that the user may connect +to it via an IIO client. + +If you are not familiar with ADI IIO Application, please take a look at: +`IIO No-OS `_ + +If you are not familiar with ADI IIO-Oscilloscope Client, please take a look at: +`IIO Oscilloscope `_ + +The No-OS IIO Application together with the No-OS IIO LTC2798 driver take care of +all the back-end logic needed to setup the IIO server. + +This example initializes the IIO device and calls the IIO app as shown in: +`IIO Example `_ + +In order to build the IIO project make sure you you are using this command: + +.. code-block:: bash + + make EXAMPLE=iio_example + +No-OS Supported Platforms +------------------------- + +Maxim Platform +^^^^^^^^^^^^^^ + +**Used hardware** + +* `DC2798A `_ +* `MAX3290EVKit `_ + +**Connections**: + ++---------------------+---------------------+-----------------------------+ +| LTC7841 test point | Function | MAX32690 EVKIT Pin Number | ++=====================+=====================+=============================+ +| GND (J31) | Ground | GND | ++---------------------+---------------------+-----------------------------+ +| SDA | Serial Data Line | P2_7 | ++---------------------+---------------------+-----------------------------+ +| SCL | Serial Clock Line | P2_8 | ++---------------------+---------------------+-----------------------------+ + + +**Build Command** + +.. code-block:: bash + + # to delete current build + make reset + # to build the project for running basic example + make EXAMPLE=basic PLATFORM=maxim TARGET=max32690 + # to build the project for running iio example + make EXAMPLE=iio_example PLATFORM=maxim TARGET=max32690 + # to flash the code + make run