diff --git a/doc/sphinx/source/projects/ltc4296.rst b/doc/sphinx/source/projects/ltc4296.rst new file mode 100644 index 00000000000..20cd664d43e --- /dev/null +++ b/doc/sphinx/source/projects/ltc4296.rst @@ -0,0 +1 @@ +.. include:: ../../../../projects/ltc4296/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 3938fcf6526..b8d039349ed 100644 --- a/doc/sphinx/source/projects_doc.rst +++ b/doc/sphinx/source/projects_doc.rst @@ -63,6 +63,7 @@ POWER MANAGEMENT :maxdepth: 1 projects/adp1050 + projects/ltc4296 DAC === diff --git a/projects/ltc4296/README.rst b/projects/ltc4296/README.rst new file mode 100644 index 00000000000..eedfcfd00ad --- /dev/null +++ b/projects/ltc4296/README.rst @@ -0,0 +1,66 @@ +Evaluating the LTC4296 +====================== + + +Contents +-------- + +.. contents:: Table of Contents + :depth: 3 + + +Overview +-------- + +The evaluation board allows the LTC4296-1 to be exercised without the need for +external components. + +Full performance details are provided in the LTC4296 data sheet, which should +be consulted in conjunction with 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 LTC4296, unlock the chip and enables power on all +avaliable ports. + + +In order to build the basic example make sure you have the following configuration in the Makefile +`Makefile `_ + + +.. code-block:: bash + + # Select the example you want to enable by choosing y for enabling and n for disabling + BASIC_EXAMPLE = y + +No-OS Supported Platforms +------------------------- + +Maxim Platform +^^^^^^^^^^^^^^ + +**Build Command** + +.. code-block:: bash + + # to delete current build + make reset + # to build the project + make PLATFORM=maxim TARGET=max32690 + # to flash the code + make run