Skip to content

Commit cc2338c

Browse files
cjones-adicjones-adi
committed
projects: max17616: Add README documentation for project
Add README.rst documentation file for project alongside other documentation related files. Signed-off-by: Carlos Jones <[email protected]>
1 parent 07b9326 commit cc2338c

File tree

2 files changed

+168
-0
lines changed

2 files changed

+168
-0
lines changed

‎doc/sphinx/source/projects/power/max17616.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../../projects/max17616/README.rst

‎projects/max17616/README.rst‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
Evaluating the MAX17616
2+
=======================
3+
4+
.. no-os-doxygen::
5+
6+
.. contents::
7+
:depth: 3
8+
9+
Supported Evaluation Boards
10+
---------------------------
11+
12+
* `MAX17616EVKIT# <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max17616evkit.html>`_
13+
* `MAX17616AEVKIT# <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max17616aevkit.html>`_
14+
15+
Overview
16+
--------
17+
18+
The MAX17616EVKIT# evaluation circuit features the MAX17616 eFuse setup for 5V
19+
to 28V operation with a 7A auto-retry current limit. A 3.3V buck regulator
20+
provides a voltage for pull-ups and logic to run indicator LEDs on the board.
21+
22+
While the MAX17616AEVKIT# evaluation kit (EV kit) features the MAX17616A eFuse
23+
setup for 5V to 28V operation with a 2A auto-retry current limit. A 3.3V buck
24+
regulator provides a voltage for pull-ups and logic to run indicator LEDs on the
25+
board.
26+
27+
Both boards include an additional external N-channel FET for reverse conduction
28+
protection.
29+
30+
Applications
31+
------------
32+
33+
* Input Voltage and Output Overcurrent Protections
34+
* Loss of Ground Protection
35+
* Surge Protection
36+
37+
Hardware Specifications
38+
-----------------------
39+
40+
Power Supply Requirements
41+
^^^^^^^^^^^^^^^^^^^^^^^^^
42+
43+
For this specific project an external power supply with output of +4V to +75V
44+
can be used to power up the demo board.
45+
46+
**Pin Description**
47+
48+
+----------+----------------------------+
49+
| Name | Description |
50+
+----------+----------------------------+
51+
| VIN | Power Supply, +4V - +75V |
52+
+----------+----------------------------+
53+
| GND | Connect to Ground |
54+
+----------+----------------------------+
55+
| VOUT | Connect to Load |
56+
+----------+----------------------------+
57+
| IMON | Do Not Connect |
58+
+----------+----------------------------+
59+
| SETI | Do Not Connect |
60+
+----------+----------------------------+
61+
| SCL | I2C Serial Clock |
62+
+----------+----------------------------+
63+
| SDA | I2C Serial Data |
64+
+----------+----------------------------+
65+
66+
**Hardware Bringup**
67+
68+
For reference, consult the Quick Start Procedure section in the user guide for the corresponding demo board:
69+
`MAX17616EVKIT user guide <https://www.analog.com/media/en/technical-documentation/user-guides/max17616evkit.pdf>`_
70+
`MAX17616AEVKIT user guide <https://www.analog.com/media/en/technical-documentation/user-guides/max17616aevkit.pdf>`_
71+
72+
No-OS Build Setup
73+
-----------------
74+
75+
Please see: https://wiki.analog.com/resources/no-os/build
76+
77+
No-OS Supported Examples
78+
------------------------
79+
80+
The initialization data used in the examples is taken out from:
81+
`Project Common Data Path <GitHub link TBD>`_
82+
83+
The macros used in Common Data are defined in platform specific files found in:
84+
`Project Platform Configuration Path <GitHub link TBD>`_
85+
86+
Basic example
87+
^^^^^^^^^^^^^
88+
89+
This is a simple example that initializes the MAX17616, and performs telemetry
90+
readings of the voltage, current and temperature. Status bytes/words are also
91+
monitored in the example.
92+
93+
In order to build the basic example make sure you have the following
94+
configuration in the Makefile
95+
`Basic Example Makefile <GitHub link TBD>`_
96+
97+
.. code-block:: bash
98+
99+
# Select the example you want to enable by choosing y for enabling and n for disabling
100+
BASIC_EXAMPLE = y
101+
IIO_EXAMPLE = n
102+
103+
IIO example
104+
^^^^^^^^^^^
105+
106+
This project is actually a IIOD demo for MAX32655FTHR evaluation board.
107+
The project launches a IIOD server on the board so that the user may connect
108+
to it via an IIO client.
109+
110+
If you are not familiar with ADI IIO Application, please take a look at:
111+
`IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`_
112+
113+
If you are not familiar with ADI IIO-Oscilloscope Client, please take a look at:
114+
`IIO Oscilloscope <https://wiki.analog.com/resources/tools-software/linux-software/iio_oscilloscope>`_
115+
116+
The No-OS IIO Application together with the No-OS IIO MAX17616 driver take care of
117+
all the back-end logic needed to setup the IIO server.
118+
119+
This example initializes the IIO device and calls the IIO app as shown in:
120+
`IIO Example <GitHub Link TBD>`_
121+
122+
In order to build the IIO project make sure you have the following
123+
configuration in the
124+
`IIO Example Makefile <GitHub Link TBD>`_
125+
126+
.. code-block:: bash
127+
128+
# Select the example you want to enable by choosing y for enabling and n for disabling
129+
BASIC_EXAMPLE = n
130+
IIO__EXAMPLE = y
131+
132+
No-OS Supported Platforms
133+
-------------------------
134+
135+
Maxim Platform
136+
^^^^^^^^^^^^^^
137+
138+
**Used hardware**
139+
140+
* `MAX32655FTHR <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32655fthr.htm>`_
141+
142+
**Connections**:
143+
144+
+-----------------------------+------------+------------------------------------+----------+-----------------------------+
145+
| MAX17616EVKIT# Pin Number | Mnemonic | Function | Mnemonic | MAX32655FTHR Pin Number |
146+
+-----------------------------+------------+------------------------------------+----------+-----------------------------+
147+
| 1 | VEMI | External Power Supply, 4V - 75V | | Do Not Connect |
148+
+-----------------------------+------------+------------------------------------+----------+-----------------------------+
149+
| 2 | GND | Connect to Ground | | GND |
150+
+-----------------------------+------------+------------------------------------+----------+-----------------------------+
151+
| 3 | VOUT | May connect to Scopy/Load | | Do Not Connect |
152+
+-----------------------------+------------+------------------------------------+----------+-----------------------------+
153+
| 10 | SCL | I2C Serial Clock | I2C2_SCL | P0_30 |
154+
+-----------------------------+------------+------------------------------------+----------+-----------------------------+
155+
| 11 | SDA | I2C Serial Data | I2C2_SDA | P0_31 |
156+
+-----------------------------+------------+------------------------------------+----------+-----------------------------+
157+
158+
**Build Command**
159+
160+
.. code-block:: bash
161+
162+
# to delete current build
163+
make TARGET=max32655 reset && make TARGET=max32655 clean
164+
# to build the project
165+
make TARGET=max32655
166+
# to flash the code
167+
make TARGET=max32655 run

0 commit comments

Comments
 (0)