forked from analogdevicesinc/no-OS
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README.rst documentation file for ltc4296 project. Signed-off-by: Antoniu Miclaus <[email protected]>
- Loading branch information
Showing
3 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../../../../projects/ltc4296/README.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -63,6 +63,7 @@ POWER MANAGEMENT | |
:maxdepth: 1 | ||
|
||
projects/adp1050 | ||
projects/ltc4296 | ||
|
||
DAC | ||
=== | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc4296/src/common>`_ | ||
|
||
The macros used in Common Data are defined in platform specific files found in: | ||
`Project Platform Configuration Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc4296/src/platform>`_ | ||
|
||
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 <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc4296/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 |